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

Retrieve custom metrics data points

get

Lists all custom metrics data points for an entity

Authorizations

Path parameters

customMetricKeystringrequired

Key for the custom metric filter

tagOrIdstringrequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Query parameters

startDatestring · date-timeoptional

Start date for the filter (inclusive). Default: 6 months

endDatestring · date-timeoptional

End date for the filter (inclusive)

pageSizeinteger · int32 · default: 250required

Number of results to return per page, between 1 and 1000. Default 250.

pageinteger · int32 · default: 0required

Page number to return, 0-indexed. Default 0.

Responses

application/json

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.getcortexapp.com/api/v1/eng-intel/custom-metrics/{customMetricKey}/entity/{tagOrId}?pageSize=1&page=1' \
  --header 'Authorization: Bearer JWT'

200

400

429

200

{
  "data": [
    {
      "timestamp": "2025-03-29T00:49:53.753Z",
      "value": 1
    }
  ],
  "page": 1,
  "total": 1,
  "totalPages": 1
}

Successfully retrieved custom metrics data points

Add custom metrics data point

post

Adds a single custom metric data point for entity.

Authorizations

Path parameters

customMetricKeystringrequired

Key for the custom metric filter

tagOrIdstringrequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Body

timestampstring · date-timeoptional

Timestamp for the data point. Note: It can't be earlier than 6 months

valuenumber · doublerequired

Value for the data point

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/eng-intel/custom-metrics/{customMetricKey}/entity/{tagOrId}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "timestamp": "2025-03-29T00:49:53.753Z",
    "value": 1
  }'

200

400

429

200

No body

Successfully added data point

Add custom metrics data points in bulk

post

Adds multiple custom metric data points for entity.

Authorizations

Path parameters

customMetricKeystringrequired

Key for the custom metric filter

tagOrIdstringrequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Body

seriesobject[] · min: 1 · max: 100required

List of data points

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.getcortexapp.com/api/v1/eng-intel/custom-metrics/{customMetricKey}/entity/{tagOrId}/bulk' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "series": [
      {
        "timestamp": "2025-03-29T00:49:53.753Z",
        "value": 1
      }
    ]
  }'

200

400

429

200

No body

Successfully added data points

Delete custom metrics data points

delete

Deletes custom metric data points for entity.

Authorizations

Path parameters

customMetricKeystringrequired

Key for the custom metric filter

tagOrIdstringrequired

The tag (x-cortex-tag) or unique, auto-generated identifier for the entity.

Query parameters

startDatestring · date-timerequired

Start date for the deletion (inclusive)

endDatestring · date-timerequired

End date for the deletion (inclusive)

Responses

application/json

application/problem+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.getcortexapp.com/api/v1/eng-intel/custom-metrics/{customMetricKey}/entity/{tagOrId}?startDate=2025-03-29T00%3A49%3A53.753Z&endDate=2025-03-29T00%3A49%3A53.753Z' \
  --header 'Authorization: Bearer JWT'

204

400

429

204

No body

Successfully deleted data points