Skip to main content
POST
/
v2
/
custom-metrics
Create a custom metric
curl --request POST \
  --url https://api.pelanor.io/v2/custom-metrics \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metricName": "<string>",
  "description": "<string>",
  "series": [
    {
      "values": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "value": 123
        }
      ],
      "properties": {}
    }
  ]
}
'
{
  "id": "<string>"
}
This endpoint can be used to initialize a Custom Metric, link it to a Pelanor property (built-in or Custom Dimension), and populate historical/initial values.
  • Newly created custom metrics may take up to 3 hours to appear in the platform
  • A custom metric must be instantiated with at least one data series (temporary limitation)
Use the List Attributes endpoint to get available properties and their IDs.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
metricName
string
​
description
string
​
series
object[]

Response

A successful response.

​
id
string