Login to CortexBook a DemoCortex Academycortex.ioCortex Status

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 · 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
get
GET /api/v1/eng-intel/custom-metrics/{customMetricKey}/entity/{tagOrId} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

{
  "data": [
    {
      "timestamp": "2025-06-28T19:22:11.337Z",
      "value": 1
    }
  ],
  "page": 1,
  "total": 1,
  "totalPages": 1
}

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

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
post
POST /api/v1/eng-intel/custom-metrics/{customMetricKey}/entity/{tagOrId} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "timestamp": "2025-06-28T19:22:11.337Z",
  "value": 1
}
No content

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

Data points to be added

Responses
200
Successfully added data points
post
POST /api/v1/eng-intel/custom-metrics/{customMetricKey}/entity/{tagOrId}/bulk HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 63

{
  "series": [
    {
      "timestamp": "2025-06-28T19:22:11.337Z",
      "value": 1
    }
  ]
}
No content

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
204
Successfully deleted data points
delete
DELETE /api/v1/eng-intel/custom-metrics/{customMetricKey}/entity/{tagOrId} HTTP/1.1
Host: api.getcortexapp.com
Authorization: Bearer JWT
Accept: */*

No content

Last updated

Was this helpful?