{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/celonis-apis/platform-api/overview/","matchPath":"","result":{"data":{"markdownRemark":{"html":"<h1 style=\"position:relative;\"><a href=\"#platform-adoption-api\" aria-label=\"platform adoption api permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"platform-adoption-api\"></div>Platform Adoption API</h1>\n<p>The Platform Adoption API allows querying on the platform adoption event for a Celonis Platform team to provide an overview of how many users are accessing your studio packages and applications. This increased visibility into package usage helps you indetify packages that may benefit from their own views or find packages that are no longer being actively used. The Platform API can track Studio adoption based on: Views, Spaces, Packages and Time periods.</p>\n<h2 style=\"position:relative;\"><a href=\"#use-cases\" aria-label=\"use cases permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"use-cases\"></div>Use Cases</h2>\n<p>The Platform Adoption API can be used to:</p>\n<ul>\n<li>\nProvide a full audit of event activity for a Celonis Platform team during a specific date range.\n</li>\n<li>\nExport user access data for Studio and Apps in order to better understand usage and adoption of packages and views.\n</li>\n</ul>\n<h2 style=\"position:relative;\"><a href=\"#authentication\" aria-label=\"authentication permalink\" class=\"anchor before\"><svg aria-hidden=\"true\" focusable=\"false\" height=\"16\" version=\"1.1\" viewBox=\"0 0 16 16\" width=\"16\"><path fill-rule=\"evenodd\" d=\"M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z\"></path></svg></a><div class=\"hidden-anchor\" id=\"authentication\"></div>Authentication</h2>\n<p>This API supports multiple methods of authentication: </p>\n<ul>\n<li>\n(preferred method) Via OAuth 2.0 token with a scope platform-adoption.tracking-events:read, passed in an HTTP header like this: \n<code class=\"language-text\">Authorization: Bearer TOKEN</code>\n. \n</li>\n<li>\nVia Application keys passed in an HTTP header like this: \n<code class=\"language-text\">Authorization: AppKey APPLICATION_KEY</code>\n.\n</li>\n<li>\nVia API keys, passed in an HTTP header like this: \n<code class=\"language-text\">Authorization: Bearer API_KEY</code>\n.\n</li>\n</ul>\n<p>See <a href=\"https://docs.celonis.com/en/using-oauth-2-0.html\">this help page</a> for more information about OAuth 2.0.</p>","headings":[{"value":"Platform Adoption API","depth":1},{"value":"Use Cases","depth":2},{"value":"Authentication","depth":2}]},"contentItem":{"data":{"lastModified":"2025-08-25T17:01:55.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"0a20db84-ed33-5cd7-ada9-6441e2a3f4ad__redocly content/celonis-apis/platform-api/overview/","seo":{"title":"Platform Adoption API","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"celonis-apis/platform-api/overview.md","pageBaseUrl":"/celonis-apis/platform-api/overview","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Platform Adoption API","id":"platform-adoption-api"},{"depth":2,"value":"Use Cases","id":"use-cases"},{"depth":2,"value":"Authentication","id":"authentication"}]},"data":{"title":""},"catalogInfo":null,"link":"/celonis-apis/platform-api/overview/","sidebarName":"celonis","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3240152602","3743992808","561138138"]}