View all methods
customMetrics.list
Deprecated — This API method has been deprecated. Use Custom Tables instead.
Retrieve a collection of time series records by reference and key pair.
Facts
| Method | GET https://yourinstance.getdx.net/api/customMetrics.list |
Arguments
Each response is limited to returning 100 records—the from timestamp argument can be used to implement pagination.
Required arguments
| Name | Type | Description |
|---|---|---|
token |
Token |
Auth token passed as an HTTP header. |
reference |
Text |
The domain reference. |
key |
Text |
The domain key. |
Optional arguments
| Name | Type | Description |
|---|---|---|
order |
Text |
Either asc or desc–defaults to asc. |
from |
ISO8601 |
Filter records using the specified timestamp and order. |
Usage info
Custom metrics API methods can be used to add arbitrary time series metrics to your DX database. The records are stored in the custom_metrics table that is queryable in alongside the rest of your DX data.
Example request
This is a typical request:
curl "https://yourinstance.getdx.net/api/customMetrics.list?reference=orgname%2Fservice&key=example" \
-H 'Accept: application/json' \
-H 'Authorization: Bearer xxxx-xxxxxxxxx-xxxx'