{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Endpoints","description":"API documentation for Celonis APIs.","siteUrl":"https://developer.celonis.com/","keywords":"celonis developer portal, celonis apis, celonis api reference docs","lang":"en-US","llmstxt":{"hide":false,"description":"Celonis API documentation","sections":[{"title":"API Docs","description":"Available Celonis API Docs","includeFiles":["**/*.md"],"excludeFiles":[]},{"title":"API Specs","description":"All Celonis API specifications","includeFiles":["**/openapi.yaml"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"endpoints","__idx":0},"children":["Endpoints"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Below is a table of the API endpoints for the CPM Reporting API."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Endpoint"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Description"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request Parameters"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Headers"]}]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"left","data-label":""},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Pagination"]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Method"]}]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://{{ReportingApiDomain}}/api/v1/elements"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve a list of elements"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["None"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Key: x-tenant-id",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Value: ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"{Connection.Tenant_ID}"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Offset Parameter:"]}," ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"‘skip’ (int",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Number of records to skip.)",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Limit Parameter:"]}," ‘take’ (int",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Number of records to take, if not specified, the default max (100 elements) will be applied.)",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Total Size field in Response:"]}," ‘totalCount’",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["facetName:"]}," (string",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"To filter elements by facet name using exact match)"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://{{ReportingApiDomain}}/api/v1/facets"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve a list of facet names"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["None"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Key: x-tenant-id",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Value: ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"{Connection.Tenant_ID}"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["None - no pagination required"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["https://{{ReportingApiDomain}}/api/v1/facets/"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"{facetName}/hierarchy"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["GET"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Retrieve a tree off all facet elements hierarchy"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["None"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["Key: x-tenant-id",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"Value: ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"{Connection.Tenant_ID}",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"left"},"children":["None - no pagination required"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example-elements-endpoint-request","__idx":1},"children":["Example Elements Endpoint Request"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"curl -X 'GET' \\\n  'https://{{ReportingApiDomain}}/api/v1/elements?FacetName=name&Skip=0&Take=100' \\\n  -H 'accept: application/json' \\\n  -H 'x-tenant-id: 00000000-0000-0000-0000-000000000000' \\\n  -H 'x-api-key: api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'\n"},"children":[]}]},"headings":[{"value":"Endpoints","id":"endpoints","depth":1},{"value":"Example Elements Endpoint Request","id":"example-elements-endpoint-request","depth":2}],"frontmatter":{"seo":{"title":"Endpoints"}},"lastModified":"2026-03-06T16:57:22.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/cpm/reporting/endpoints","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}