Endpoints
Below is a table of the API endpoints for the CPM Reporting API.
| Endpoint | Method | Description | Request Parameters | Headers | Pagination Method |
|---|---|---|---|---|---|
| https://{{ReportingApiDomain}}/api/v1/elements | GET | Retrieve a list of elements | None | Key: x-tenant-id Value: {Connection.Tenant_ID} |
Offset Parameter: ‘skip’ (int Number of records to skip.) Limit Parameter: ‘take’ (int Number of records to take, if not specified, the default max (100 elements) will be applied.) Total Size field in Response: ‘totalCount’ facetName (string To filter elements by facet name using exact match) |
| https://{{ReportingApiDomain}}/api/v1/facets | GET | Retrieve a list of facet names | None | Key: x-tenant-id Value: {Connection.Tenant_ID} |
None - no pagination required |
| https://{{ReportingApiDomain}}/api/v1/facets/ {facetName}/hierarchy |
GET | Retrieve a tree off all facet elements hierarchy | None | Key: x-tenant-id Value: {Connection.Tenant_ID} |
None - no pagination required |
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'