{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/cpm/reporting/endpoints/","matchPath":"","result":{"data":{"markdownRemark":{"html":"<h1 style=\"position:relative;\"><a href=\"#endpoints\" aria-label=\"endpoints 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=\"endpoints\"></div>Endpoints</h1>\n<p>Below is a table of the API endpoints for the CPM Reporting API.</p>\n<table>\n<thead>\n<tr>\n<th>Endpoint</th>\n<th>Method</th>\n<th>Description</th>\n<th align=\"left\">Request Parameters</th>\n<th align=\"left\">Headers</th>\n<th align=\"left\">Pagination Method</th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td><a href=\"https://%7B%7BReportingApiDomain%7D%7D/api/v1/elements\">https://{{ReportingApiDomain}}/api/v1/elements</a></td>\n<td>GET</td>\n<td>Retrieve a list of elements</td>\n<td align=\"left\">None</td>\n<td align=\"left\">Key: x-tenant-id<br />Value: <br />{Connection.Tenant_ID}</td>\n<td align=\"left\">Offset Parameter: <br />‘skip’ (int<br />Number of records to skip.)<br />Limit Parameter: ‘take’ (int<br />Number of records to take, if not specified, the default max (100 elements) will be applied.)<br />Total Size field in Response: ‘totalCount’<br /><br />facetName (string<br />To filter elements by facet name using exact match)</td>\n</tr>\n<tr>\n<td><a href=\"https://%7B%7BReportingApiDomain%7D%7D/api/v1/facets\">https://{{ReportingApiDomain}}/api/v1/facets</a></td>\n<td>GET</td>\n<td>Retrieve a list of facet names</td>\n<td align=\"left\">None</td>\n<td align=\"left\">Key: x-tenant-id<br />Value: <br />{Connection.Tenant_ID}</td>\n<td align=\"left\">None - no pagination required</td>\n</tr>\n<tr>\n<td><a href=\"https://%7B%7BReportingApiDomain%7D%7D/api/v1/facets/\">https://{{ReportingApiDomain}}/api/v1/facets/</a><br />{facetName}/hierarchy</td>\n<td>GET</td>\n<td>Retrieve a tree off all facet elements hierarchy</td>\n<td align=\"left\">None</td>\n<td align=\"left\">Key: x-tenant-id<br />Value: <br />{Connection.Tenant_ID}<br /></td>\n<td align=\"left\">None - no pagination required</td>\n</tr>\n</tbody>\n</table>\n<h2 style=\"position:relative;\"><a href=\"#example-elements-endpoint-request\" aria-label=\"example elements endpoint request 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=\"example-elements-endpoint-request\"></div>Example Elements Endpoint Request</h2>\n<div class=\"code-wrapper\">\n        <div class=\"gatsby-code-button-container\"\n             data-toaster-id=\"4178891140009710600\"\n             data-toaster-duration=\"1500\"\n             onClick=\"copyCodeToClipboard(`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'`, `4178891140009710600`)\"\n        >\n          <div class=\"gatsby-code-button\" title=\"Copy the code snippet\">Copy</div>\n          <div class=\"done-indicator done-indicator-4178891140009710600\">Copied</div>\n        </div>\n        <div class=\"gatsby-highlight\" data-language=\"text\"><pre class=\"language-text\"><code class=\"language-text\">curl -X 'GET' \\\n  'https://{{ReportingApiDomain}}/api/v1/elements?FacetName=name&amp;Skip=0&amp;Take=100' \\\n  -H 'accept: application/json' \\\n  -H 'x-tenant-id: 00000000-0000-0000-0000-000000000000' \\\n  -H 'x-api-key: api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'</code></pre></div>\n      </div>","headings":[{"value":"Endpoints","depth":1},{"value":"Example Elements Endpoint Request","depth":2}]},"contentItem":{"data":{"lastModified":"2025-12-03T23:52:38.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":false,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"9706fc37-55c9-5c9f-8536-c44cebe5af08__redocly content/cpm/reporting/endpoints/","seo":{"title":"Endpoints","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null,"siteUrl":null},"pageId":"cpm/reporting/endpoints.md","pageBaseUrl":"/cpm/reporting/endpoints","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"Endpoints","id":"endpoints"},{"depth":2,"value":"Example Elements Endpoint Request","id":"example-elements-endpoint-request"}]},"data":{"title":""},"catalogInfo":null,"link":"/cpm/reporting/endpoints/","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"]}