openapi: 3.1.0
info:
  version: v2.0
  title: Celonis Platform Adoption API
  description: >-
    This is the documentation for the Celonis Platform Adoption API that allows
    querying on platform adoption event in an Celonis Platform team. This 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/>
  contact:
    name: Celonis Support
    url: https://celonis.com
    email: support@celonis.com
servers:
  - url: /
    description: Default Server URL
security:
  - Authorization: []
tags:
  - name: Platform Adoption API
    description: For querying Platform Adoption events in a team.
paths:
  /platform-adoption/api/external/v2/adoption-tracking-events/STUDIO_ASSET:
    get:
      tags:
        - Platform Adoption API
      summary: Get adoption events (Token-based Pagination)
      description: >-
        Returns adoption tracking events using token-based pagination. Filters
        are optional and combined with logical AND. Use the `nextPageToken` from
        a previous response to fetch the next page. If no token is provided,
        results start from the first page. Both `from` and `to` are inclusive
        (ISO date: yyyy-MM-dd).
      operationId: getStudioAssetAdoptionEvents
      parameters:
        - name: appName
          in: query
          description: >-
            Optional filter by Studio application name. If omitted, events for
            all types are returned.
          required: false
          schema:
            type: string
            enum:
              - APPS
              - STUDIO
          example: APPS
        - name: pageToken
          in: query
          description: >-
            Continuation pageToken from the previous response. Use
            `nextPageToken` exactly as returned by the API.
          required: false
          schema:
            type: string
          example: >-
            eyI5ZTFkMzMwMy04N2Y4LTQ5NTEtOTkyNC02ZjhhY2E3MzY2MTUiOjE2Njk1Azk3NDAwMDB9
        - name: limit
          in: query
          description: Maximum number of results to return. Allowed range:1-500.
          required: false
          schema:
            type: integer
            format: int32
            default: 200
            maximum: 500
            minimum: 1
          example: 200
        - name: from
          in: query
          description: Optional start date filter, ISO8601 format `yyyy-MM-dd`.
          required: false
          schema:
            type: string
            format: date
          example: '2022-01-01'
        - name: to
          in: query
          description: Optional end date filter, ISO8601 format `yyyy-MM-dd`.
          required: false
          schema:
            type: string
            format: date
          example: '2022-01-31'
      responses:
        '200':
          description: A JSON object representing the paginated results.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SwaggerStudioAssetAdoptionTrackingEventTokenBasedPageExternal
        '204':
          description: No Content
        '400':
          description: >-
            Bad Request. Please check the response contents for an explanation
            of the cause.
          content: {}
        '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':
          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)
          content: {}
      security:
        - Authorization: []
components:
  schemas:
    StudioAssetAdoptionTrackingEventExternalTransport:
      type: object
      properties:
        appName:
          type: string
          enum:
            - APPS
            - STUDIO
        assetTab:
          $ref: '#/components/schemas/StudioNodeSummaryExternalTransport'
        asset:
          $ref: '#/components/schemas/StudioNodeSummaryExternalTransport'
        assetPackage:
          $ref: '#/components/schemas/StudioNodeSummaryExternalTransport'
        assetType:
          type: string
        space:
          $ref: '#/components/schemas/StudioNodeSummaryExternalTransport'
        folders:
          type: array
          items:
            $ref: '#/components/schemas/StudioNodeSummaryExternalTransport'
        user:
          $ref: '#/components/schemas/UserSummaryExternalTransport'
        timestamp:
          type: string
          format: date-time
    StudioNodeSummaryExternalTransport:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
    SwaggerStudioAssetAdoptionTrackingEventTokenBasedPageExternal:
      type: object
      properties:
        nextPageToken:
          type: string
        content:
          type: array
          items:
            $ref: >-
              #/components/schemas/StudioAssetAdoptionTrackingEventExternalTransport
    UserSummaryExternalTransport:
      type: object
      properties:
        id:
          type: string
        email:
          type: string
  securitySchemes:
    Authorization:
      type: apiKey
      description: >-
        Please, prefix the Token with "AppKey " or "Bearer " (word and space) to
        indicate the Authorization type
      name: Authorization
      in: header
