Metrics API Reference

Get all metrics

Endpoint:

GET /v1/:page_id/metrics

Example response:

[
{
"id": "ckj1qyonq9sdk09819xdg4ehm",
"name": "Testing",
"active": true,
"order": 1,
"suffix": "ms",
"data": [
{
"timestamp": 1608474985000,
"value": 355
},
{
"timestamp": 1608475225000,
"value": 428.25
},
{
"timestamp": 1608475465000,
"value": 356
},
{
"timestamp": 1608475705000,
"value": 451.75
},
...
]
},
...
]

Get a metric

Endpoint:

GET /v1/:page_id/metrics/:metric_id

Example response:

{
"id": "ckj1qyonq9sdk09819xdg4ehm",
"name": "Testing",
"active": true,
"order": 1,
"suffix": "ms",
"data": [
{
"timestamp": 1608474985000,
"value": 355
},
{
"timestamp": 1608475225000,
"value": 428.25
},
{
"timestamp": 1608475465000,
"value": 356
},
{
"timestamp": 1608475705000,
"value": 451.75
},
...
]
}

Add a metric

Endpoint:

POST /v1/:page_id/metrics
{
"subdomain": "nasa",
"name": "Response time",
"suffix": "ms"
}

Example response:

{
"id": "ckj1qyonq9sdk09819xdg4ehm",
"name": "Response time",
"active": true,
"order": 1,
"suffix": "ms",
"lastDataAt": 1608561235000,
"data": [
{
"timestamp": 1608474985000,
"value": 355
},
{
"timestamp": 1608475225000,
"value": 428.25
},
{
"timestamp": 1608475465000,
"value": 356
},
...
]
}

Update a metric

Endpoint:

PUT /v1/:page_id/metrics/:metric_id

Example request:

{
"name": "Response time",
"suffix": "ms"
}

Example response:

{
"id": "ckj1qyonq9sdk09819xdg4ehm",
"name": "Response time",
"active": true,
"order": 1,
"suffix": "ms",
"lastDataAt": 1608561235000,
"data": [
{
"timestamp": 1608474985000,
"value": 355
},
{
"timestamp": 1608475225000,
"value": 428.25
},
{
"timestamp": 1608475465000,
"value": 356
},
...
]
}

Delete a metric

Endpoint:

DELETE /v1/:page_id/metrics/:metric_id

Add a datapoint to a metric

Endpoint:

POST /v1/:page_id/metrics/:metric_id

Request:

{
"timestamp": 1608672985000,
"value": 356
}

Response:

{
"id": "ckj395ptx9ha40995ckzv0pz2",
"value": 356,
"timestamp": 1608672985000
}

Add multiple datapoints to a metric

Endpoint:

POST /v1/:page_id/metrics/:metric_id/data

Request:

{
"data": [
{
"timestamp": 1608474985000,
"value": 355
},
{
"timestamp": 1608475225000,
"value": 428.25
},
{
"timestamp": 1608475465000,
"value": 356
},
{
"timestamp": 1608475705000,
"value": 451.75
},
{
"timestamp": 1608475945000,
"value": 395
},
{
"timestamp": 1608476185000,
"value": 375.75
},
{
"timestamp": 1608476425000,
"value": 380.25
},
...
]
}

Response

[
{
"timestamp": 1608474985000,
"value": 355
},
{
"timestamp": 1608475225000,
"value": 428.25
},
{
"timestamp": 1608475465000,
"value": 356
},
{
"timestamp": 1608475705000,
"value": 451.75
},
{
"timestamp": 1608475945000,
"value": 395
},
{
"timestamp": 1608476185000,
"value": 375.75
},
{
"timestamp": 1608476425000,
"value": 380.25
}
]

Delete datapoints to a metric

Endpoint:

DELETE /v1/:page_id/metrics/:metric_id/data

Response

{
"name": "Response time",
"site": {
"id": "ckj1qyonq9sdk09819xdg4ehm",
"subdomain": "our"
}
}