{"items":[{"type":"link","label":"Celonis Platform Adoption API","link":"/celonis-apis/platform-api/openapi/openapi-external-v1","routeSlug":"/celonis-apis/platform-api/openapi/openapi-external-v1","content":{"contentType":"overview","meta":{"name":"Celonis Platform Adoption API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi-external-v1.json","url":"/_bundle/celonis-apis/platform-api/openapi/openapi-external-v1.json?download"},{"kind":"download","label":"openapi-external-v1.yaml","url":"/_bundle/celonis-apis/platform-api/openapi/openapi-external-v1.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"https://celonis.com","url":"https://celonis.com"},{"kind":"email","title":"Celonis Support","email":"support@celonis.com","label":"support@celonis.com","withCopyButton":true,"copyContent":"support@celonis.com"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"java","title":"Java","lang":"Java"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"python","title":"Python","lang":"Python"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/celonis-apis/platform-api/openapi/openapi-external-v1","description":"Test Server","isMockServer":true}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Celonis Platform Adoption API (v1.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"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:"},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - (preferred method) Via OAuth 2.0 token with scope "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tt","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"platform-adoption.tracking-events:read"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", passed in an HTTP header like this: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tt","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization: Bearer TOKEN"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Via Application keys, passed in an HTTP header like this: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tt","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization: AppKey APPLICATION_KEY"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Via API keys, passed in an HTTP header like this: "},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"tt","attrs":{}},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authorization: Bearer API_KEY"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://docs.celonis.com/en/using-oauth-2-0.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this help page"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information about OAuth 2.0."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Version 1.0 of this API will coninue to be supported, but will be deprecated in the future."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" It is recommended that users utilize "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/celonis-apis/platform-api/openapi/openapi-external-v2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Version 2.0"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for all new implementations."},"children":[]}]}]}]}],"sectionId":"/celonis-apis/platform-api/openapi/openapi-external-v1"}],"sectionId":"/celonis-apis/platform-api/openapi/openapi-external-v1"}]}]}},{"type":"group","label":"Platform Adoption API","link":"/celonis-apis/platform-api/openapi/openapi-external-v1/platform-adoption-api","routeSlug":"/celonis-apis/platform-api/openapi/openapi-external-v1/platform-adoption-api","items":[{"label":"findAllStudioAssetAdoptionTrackingEvents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/celonis-apis/platform-api/openapi/openapi-external-v1/platform-adoption-api/findallstudioassetadoptiontrackingevents","routeSlug":"/celonis-apis/platform-api/openapi/openapi-external-v1/platform-adoption-api/findallstudioassetadoptiontrackingevents","metadata":{"seo":{"title":"findAllStudioAssetAdoptionTrackingEvents"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"findAllStudioAssetAdoptionTrackingEvents","name":"findAllStudioAssetAdoptionTrackingEvents","isWebhook":false,"pointer":"/paths/~1platform-adoption~1api~1external~1adoption-tracking-events~1STUDIO_ASSET/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"findAllStudioAssetAdoptionTrackingEvents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"Authorization","scopes":[],"type":"apiKey","in":"header","paramName":"Authorization","description":"Please, prefix the Token with \"AppKey \" or \"Bearer \" (word and space) to indicate the Authorization type"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"appName","in":"query","schemaId":"schema_116","description":"Type of adoption tracking event","example":"APPS"},{"name":"pageNumber","in":"query","schemaId":"schema_117","description":"Page number to be retrieved, starts with 0","example":0},{"name":"pageSize","in":"query","schemaId":"schema_118","description":"Limit of results per page","example":200},{"name":"from","in":"query","schemaId":"schema_119","description":"Date Time ISO 8601 yyyy-MM-dd","example":"2022-01-01"},{"name":"to","in":"query","schemaId":"schema_119","description":"Date Time ISO 8601 yyyy-MM-dd","example":"2022-01-31"}],"pointer":"/paths/~1platform-adoption~1api~1external~1adoption-tracking-events~1STUDIO_ASSET/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/platform-adoption/api/external/adoption-tracking-events/STUDIO_ASSET","servers":[{"url":"/_mock/celonis-apis/platform-api/openapi/openapi-external-v1","description":"Test Server","isMockServer":true}],"parameters":{"path":[],"query":[{"name":"appName","in":"query","required":false,"example":"APPS","schemaId":"components/schemas/StudioAppName"},{"name":"pageNumber","in":"query","required":false,"example":0,"schemaId":"schema_117"},{"name":"pageSize","in":"query","required":false,"example":200,"schemaId":"schema_118"},{"name":"from","in":"query","required":false,"example":"2022-01-01","schemaId":"schema_119"},{"name":"to","in":"query","required":false,"example":"2022-01-31","schemaId":"schema_119"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"Authorization","type":"apiKey","name":"Authorization","in":"header"}],"scopes":[]}],"responseCodes":["200","204","400","401","403","500"],"pointer":"/platform-adoption/api/external/adoption-tracking-events/STUDIO_ASSET","href":"platform-adoption-api/findallstudioassetadoptiontrackingevents","openApiOperationId":"findAllStudioAssetAdoptionTrackingEvents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/celonis-apis/platform-api/openapi/openapi-external-v1","description":"Test Server","isMockServer":true}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A JSON object representing the paginated results.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SwaggerStudioAssetAdoptionTrackingEventExternal"}},"schemaId":"components/schemas/SwaggerStudioAssetAdoptionTrackingEventExternal"},{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request. Please check the response contents for an explanation of the cause."},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.celonis.cloud/help/display/CIBC/Application+Keys"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"application keys"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.celonis.cloud/help/display/CIBC/Permissions"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"permissions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"code":"403","description":"Forbidden"},{"code":"500","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An internal error happened. Please forward the associated error ID along with any helpful information to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.celonis.cloud/help/display/CIBC/Support"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"our support"},"children":[]}]}]}]}]}],"pointer":"/paths/~1platform-adoption~1api~1external~1adoption-tracking-events~1STUDIO_ASSET/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/SwaggerStudioAssetAdoptionTrackingEventExternal","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/SwaggerStudioAssetAdoptionTrackingEventExternal"}}},{"code":"204"},{"code":"400"},{"code":"401"},{"code":"403"},{"code":"500"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/platform-adoption-api/findallstudioassetadoptiontrackingevents"}],"panels":[]}]},"httpPath":"/platform-adoption/api/external/adoption-tracking-events/STUDIO_ASSET"}],"content":{"contentType":"group","meta":{"name":"Platform Adoption API"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Platform Adoption API","showPageActions":true},{"nodeType":"markdoc","content":"For querying Platform Adoption in a team"}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/platform-adoption/api/external/adoption-tracking-events/STUDIO_ASSET","summary":"findAllStudioAssetAdoptionTrackingEvents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/platform-adoption-api/findallstudioassetadoptiontrackingevents","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/StudioAppName":{"id":"components/schemas/StudioAppName","kind":"json-schema","title":"StudioAppName","data":{"type":"string","enum":["APPS","STUDIO"]}},"components/schemas/StudioAssetAdoptionTrackingEventExternalTransport":{"id":"components/schemas/StudioAssetAdoptionTrackingEventExternalTransport","kind":"json-schema","title":"StudioAssetAdoptionTrackingEventExternalTransport","data":{"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"}}}},"components/schemas/StudioNodeSummaryExternalTransport":{"id":"components/schemas/StudioNodeSummaryExternalTransport","kind":"json-schema","title":"StudioNodeSummaryExternalTransport","data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}}},"components/schemas/SwaggerStudioAssetAdoptionTrackingEventExternal":{"id":"components/schemas/SwaggerStudioAssetAdoptionTrackingEventExternal","kind":"json-schema","title":"SwaggerStudioAssetAdoptionTrackingEventExternal","data":{"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"}}}},"components/schemas/UserSummaryExternalTransport":{"id":"components/schemas/UserSummaryExternalTransport","kind":"json-schema","title":"UserSummaryExternalTransport","data":{"type":"object","properties":{"email":{"type":"string"},"id":{"type":"string"}}}},"schema_116":{"kind":"json-schema","data":{"$ref":"#/components/schemas/StudioAppName"},"id":"schema_116"},"schema_117":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":0,"minimum":0},"id":"schema_117"},"schema_118":{"kind":"json-schema","data":{"type":"integer","format":"int32","default":200,"maximum":200,"minimum":1},"id":"schema_118"},"schema_119":{"kind":"json-schema","data":{"type":"string","format":"date"},"id":"schema_119"}},"exampleStore":{},"securitySchemeStore":{"Authorization":{"id":"Authorization","type":"apiKey","description":"Please, prefix the Token with \"AppKey \" or \"Bearer \" (word and space) to indicate the Authorization type","in":"header","paramName":"Authorization"}},"servers":[{"url":"/_mock/celonis-apis/platform-api/openapi/openapi-external-v1","isMockServer":true,"description":"Test Server"}]},"options":{"jsonSamplesExpandLevel":"all","schemasExpansionLevel":2,"codeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Java"},{"lang":"PHP"},{"lang":"Python"}]},"feedback":{"type":"comment","settings":{"label":"Share your feedback for this page.","submitText":"Your comment has been sent to our team!"}},"hideSidebar":true,"mockServer":{"url":"/_mock/celonis-apis/platform-api/openapi/openapi-external-v1","position":"replace","description":"Test Server","off":false,"strictExamples":false,"errorIfForcedExampleNotFound":false},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/celonis-apis/platform-api/openapi/openapi-external-v1.json?download"},{"url":"/_bundle/celonis-apis/platform-api/openapi/openapi-external-v1.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Celonis Platform Adoption API","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."}},"baseSlug":"/celonis-apis/platform-api/openapi/openapi-external-v1","routesMapping":{}}