Custom Metrics
Use these operations to interact with custom metrics in Cortex Eng Intelligence.
Required permissions
Your API key must have the Configure Eng Intelligence custom metrics permission.
Operations
Lists all custom metrics data points for an entity
All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Key for the custom metric filter
Entity identifier - can be a tag or CID
Start date for the filter (inclusive). Default: 6 months
End date for the filter (inclusive)
Number of results to return per page, between 1 and 1000. Default 250.
250Page number to return, 0-indexed. Default 0.
0Successfully retrieved custom metrics data points
Current page number, 0-indexed
Total number of results
Total number of pages
Invalid filters
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
GET /api/v1/eng-intel/custom-metrics/{customMetricKey}/entity/{tagOrId}?pageSize=250&page=0 HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"data": [
{
"timestamp": "2026-01-01T00:00:00.000Z",
"value": 1
}
],
"page": 1,
"total": 1,
"totalPages": 1
}Adds a single custom metric data point for entity.
All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Key for the custom metric filter
Entity identifier - can be a tag or CID
Data point to be added
Timestamp for the data point in ISO 8601 format. Accepts timezone offsets (e.g., '2024-08-14T11:00:00Z' or '2024-08-14T11:00:00+00:00'). Note: It can't be earlier than 2 years
Value for the data point
Successfully added data point
No content
Invalid filters
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
POST /api/v1/eng-intel/custom-metrics/{customMetricKey}/entity/{tagOrId} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 50
{
"timestamp": "2026-01-01T00:00:00.000Z",
"value": 1
}No content
Adds multiple custom metric data points for entity.
All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Key for the custom metric filter
Entity identifier - can be a tag or CID
Data points to be added
Successfully added data points
No content
Invalid filters
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
POST /api/v1/eng-intel/custom-metrics/{customMetricKey}/entity/{tagOrId}/bulk HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 63
{
"series": [
{
"timestamp": "2026-01-01T00:00:00.000Z",
"value": 1
}
]
}No content
Deletes custom metric data points for entity.
All requests to the Cortex API need to provide an Authorization: Bearer <token> header, where <token> is an API key created in the Settings page of your workspace.
Key for the custom metric filter
Entity identifier - can be a tag or CID
Start date for the deletion (inclusive)
End date for the deletion (inclusive)
Successfully deleted data points
No content
Invalid filters
The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.
DELETE /api/v1/eng-intel/custom-metrics/{customMetricKey}/entity/{tagOrId}?startDate=2026-01-01T00%3A00%3A00.000Z&endDate=2026-01-01T00%3A00%3A00.000Z HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Last updated
Was this helpful?