Skip to content
Platform Usage APIs
/
/
/Platform Adoption API

Platform Adoption API

For querying Platform Adoption events in a team.

Operations

Get adoption events (Token-based Pagination)

Request

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).

Security
Authorization
Query
appNamestring

Optional filter by Studio application name. If omitted, events for all types are returned.

Enum:"APPS""STUDIO"
Example:appName=APPS
pageTokenstring

Continuation pageToken from the previous response. Use nextPageToken exactly as returned by the API.

Example:pageToken=eyI5ZTFkMzMwMy04N2Y4LTQ5NTEtOTkyNC02ZjhhY2E3MzY2MTUiOjE2Njk1Azk3NDAwMDB9
limitinteger, (int32), [ 1 .. 500 ]

Maximum number of results to return. Allowed range:1-500.

Default:200
Example:limit=200
fromstring, (date)

Optional start date filter, ISO8601 format yyyy-MM-dd.

Example:from=2022-01-01
tostring, (date)

Optional end date filter, ISO8601 format yyyy-MM-dd.

Example:to=2022-01-31
GET
/platform-adoption/api/external/v2/adoption-tracking-events/STUDIO_ASSET
curl -i -X GET \
  'https://developer.celonis.com/_mock/celonis-apis/platform-api/openapi/openapi-external-v2/platform-adoption/api/external/v2/adoption-tracking-events/STUDIO_ASSET?appName=APPS&pageToken=eyI5ZTFkMzMwMy04N2Y4LTQ5NTEtOTkyNC02ZjhhY2E3MzY2MTUiOjE2Njk1Azk3NDAwMDB9&limit=200&from=2022-01-01&to=2022-01-31' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A JSON object representing the paginated results.

Bodyapplication/json
nextPageTokenstring
contentArray of objects(StudioAssetAdoptionTrackingEventExternalTransport)
Response
{
  "nextPageToken": "string",
  "content": [
    {
      "appName": "APPS",
      "assetTab": {
        "id": "string",
        "name": "string"
      },
      "asset": {
        "id": "string",
        "name": "string"
      },
      "assetPackage": {
        "id": "string",
        "name": "string"
      },
      "assetType": "string",
      "space": {
        "id": "string",
        "name": "string"
      },
      "folders": [
        {
          "id": "string",
          "name": "string"
        }
      ],
      "user": {
        "id": "string",
        "email": "string"
      },
      "timestamp": "2019-08-24T14:15:22Z"
    }
  ]
}