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

bearerAuth

AuthorizationstringRequired

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.

Path parameters

customMetricKeystringRequired

Key for the custom metric filter

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Query parameters

startDatestring · date-timeOptional

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

endDatestring · date-timeOptional

End date for the filter (inclusive)

pageSizeinteger · int32Required

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

Default: 250

pageinteger · int32Required

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

Default: 0

Responses

200

Successfully retrieved custom metrics data points

application/json

400

Invalid filters

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

get

/api/v1/eng-intel/custom-metrics/{customMetricKey}/entity/{tagOrId}

HTTPcURLJavaScriptPython

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-31T23:53:08.950Z",
      "value": 1
    }
  ],
  "page": 1,
  "total": 1,
  "totalPages": 1
}

Add custom metrics data point

post

Adds a single custom metric data point for entity.

Authorizations

bearerAuth

AuthorizationstringRequired

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.

Path parameters

customMetricKeystringRequired

Key for the custom metric filter

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Body

application/json

Data point to be added

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

200

Successfully added data point

No content

400

Invalid filters

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

post

/api/v1/eng-intel/custom-metrics/{customMetricKey}/entity/{tagOrId}

HTTPcURLJavaScriptPython

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-31T23:53:08.950Z",
  "value": 1
}

No content

Add custom metrics data points in bulk

post

Adds multiple custom metric data points for entity.

Authorizations

bearerAuth

AuthorizationstringRequired

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.

Path parameters

customMetricKeystringRequired

Key for the custom metric filter

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Body

application/json

Data points to be added

Responses

200

Successfully added data points

No content

400

Invalid filters

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

post

/api/v1/eng-intel/custom-metrics/{customMetricKey}/entity/{tagOrId}/bulk

HTTPcURLJavaScriptPython

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-31T23:53:08.950Z",
      "value": 1
    }
  ]
}

No content

Delete custom metrics data points

delete

Deletes custom metric data points for entity.

Authorizations

bearerAuth

AuthorizationstringRequired

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.

Path parameters

customMetricKeystringRequired

Key for the custom metric filter

tagOrIdstringRequired

Entity identifier - can be a tag or CID

Query parameters

startDatestring · date-timeRequired

Start date for the deletion (inclusive)

endDatestring · date-timeRequired

End date for the deletion (inclusive)

Responses

204

Successfully deleted data points

400

Invalid filters

application/json

429

The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

application/problem+json

delete

/api/v1/eng-intel/custom-metrics/{customMetricKey}/entity/{tagOrId}

HTTPcURLJavaScriptPython

DELETE /api/v1/eng-intel/custom-metrics/{customMetricKey}/entity/{tagOrId}?startDate=2026-01-31T23%3A53%3A08.950Z&endDate=2026-01-31T23%3A53%3A08.950Z HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content