{
  "openapi": "3.0.1",
  "info": {
    "version": "v1.0",
    "contact": {
      "email": "support@celonis.com",
      "name": "Celonis Support",
      "url": "https://celonis.com"
    },
    "description": "This is the documentation for the Platform Adoption API, that allows querying on platform adoption event in a Celonis Platform team. The API supports multiple methods of authentication:<br/> - (preferred method) Via OAuth 2.0 token with scope <tt>platform-adoption.tracking-events:read</tt>, passed in an HTTP header like this: <tt>Authorization: Bearer TOKEN</tt><br/> - Via Application keys, passed in an HTTP header like this: <tt>Authorization: AppKey APPLICATION_KEY</tt><br/> - Via API keys, passed in an HTTP header like this: <tt>Authorization: Bearer API_KEY</tt><br/><br/>Please see [this help page](https://docs.celonis.com/en/using-oauth-2-0.html) for more information about OAuth 2.0.<br/><br/>  **NOTE:** Version 1.0 of this API will coninue to be supported, but will be deprecated in the future.<br/> It is recommended that users utilize [Version 2.0](openapi-external-v2.yaml) for all new implementations.",
    "title": "Celonis Platform Adoption API"
  },
  "servers": [
    {
      "description": "Default Server URL",
      "url": "/"
    }
  ],
  "security": [
    {
      "Authorization": []
    }
  ],
  "tags": [
    {
      "description": "For querying Platform Adoption in a team",
      "name": "Platform Adoption API"
    }
  ],
  "paths": {
    "/platform-adoption/api/external/adoption-tracking-events/STUDIO_ASSET": {
      "get": {
        "operationId": "findAllStudioAssetAdoptionTrackingEvents",
        "parameters": [
          {
            "description": "Type of adoption tracking event",
            "example": "APPS",
            "in": "query",
            "name": "appName",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/StudioAppName"
            }
          },
          {
            "description": "Page number to be retrieved, starts with 0",
            "example": 0,
            "in": "query",
            "name": "pageNumber",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 0,
              "minimum": 0
            }
          },
          {
            "description": "Limit of results per page",
            "example": 200,
            "in": "query",
            "name": "pageSize",
            "required": false,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 200,
              "maximum": 200,
              "minimum": 1
            }
          },
          {
            "description": "Date Time ISO 8601 yyyy-MM-dd",
            "example": "2022-01-01",
            "in": "query",
            "name": "from",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date"
            }
          },
          {
            "description": "Date Time ISO 8601 yyyy-MM-dd",
            "example": "2022-01-31",
            "in": "query",
            "name": "to",
            "required": false,
            "schema": {
              "type": "string",
              "format": "date"
            }
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SwaggerStudioAssetAdoptionTrackingEventExternal"
                }
              }
            },
            "description": "A JSON object representing the paginated results."
          },
          "204": {
            "description": "No Content"
          },
          "400": {
            "content": {},
            "description": "Bad Request. Please check the response contents for an explanation of the cause."
          },
          "401": {
            "description": "Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions)."
          },
          "403": {
            "description": "Forbidden"
          },
          "500": {
            "content": {},
            "description": "An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)"
          }
        },
        "security": [
          {
            "Authorization": []
          }
        ],
        "tags": [
          "Platform Adoption API"
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "StudioAppName": {
        "type": "string",
        "enum": [
          "APPS",
          "STUDIO"
        ]
      },
      "StudioAssetAdoptionTrackingEventExternalTransport": {
        "type": "object",
        "properties": {
          "appName": {
            "$ref": "#/components/schemas/StudioAppName"
          },
          "asset": {
            "$ref": "#/components/schemas/StudioNodeSummaryExternalTransport"
          },
          "assetPackage": {
            "$ref": "#/components/schemas/StudioNodeSummaryExternalTransport"
          },
          "folders": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StudioNodeSummaryExternalTransport"
            }
          },
          "space": {
            "$ref": "#/components/schemas/StudioNodeSummaryExternalTransport"
          },
          "timestamp": {
            "type": "string",
            "format": "date-time"
          },
          "user": {
            "$ref": "#/components/schemas/UserSummaryExternalTransport"
          }
        }
      },
      "StudioNodeSummaryExternalTransport": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        }
      },
      "SwaggerStudioAssetAdoptionTrackingEventExternal": {
        "type": "object",
        "properties": {
          "content": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/StudioAssetAdoptionTrackingEventExternalTransport"
            }
          },
          "pageNumber": {
            "type": "integer",
            "format": "int32"
          },
          "pageSize": {
            "type": "integer",
            "format": "int32"
          },
          "totalCount": {
            "type": "integer",
            "format": "int64"
          }
        }
      },
      "UserSummaryExternalTransport": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string"
          },
          "id": {
            "type": "string"
          }
        }
      }
    },
    "securitySchemes": {
      "Authorization": {
        "description": "Please, prefix the Token with \"AppKey \" or \"Bearer \" (word and space) to indicate the Authorization type",
        "in": "header",
        "name": "Authorization",
        "type": "apiKey"
      }
    }
  }
}