Endpoints
Below is a table of the API endpoints for the CPM Reporting API.
| Endpoint | Method | Description | Request Parameters | Response Format |
|---|---|---|---|---|
| https://{{ReportingApiDomain}}/api/v1/elements | GET | Retrieve a list of elements | Skip: int Number of records to skip. Take: int Number of records to take, if not specified, the default max (100 elements) will be applied. facetName: string To filter elements by facet name using exact match. |
JSON |
| https://{{ReportingApiDomain}}/api/v1/facets | GET | Retrieve a list of facet names | None | JSON |
| https://{{ReportingApiDomain}}/api/v1/facets/{facetName}/hierarchy | GET | Retrieve a tree off all facet elements hierarchy | None | JSON |
Example Elements Endpoint Request
curl -X 'GET' \
'https://{{ReportingApiDomain}}/api/v1/elements?FacetName=name&Skip=0&Take=100' \
-H 'accept: application/json' \
-H 'x-tenant-id: 00000000-0000-0000-0000-000000000000' \
-H 'x-api-key: api_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'