Metrics

Search…
Metrics
GET /v1/metrics/replay
Description
This endpoint accepts the following query params:
total=true
bytes=true
period=24h
Uses Golang duration format (ie. 15m, 24h)
interval
Uses Golang duration format (ie. 15m, 24h)
If bytes is passed in, the timeseries values represent the number of bytes that were sent.
If total is passed in, the service will return a total count of events (or bytes) for the given time period (same as what you get from storage). interval will be ignored.
You can use total, bytes, interval, period in any combination.
Header Parameters
Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key
Query Parameters
Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key
Example Response
{
   "0dce7d85-8d61-41db-86bd-af005df755f4":{
      "latency_ms":0,
      "status":"error",
      "message":"Failed to connect",
      "last_checked_at":1624548189
   }
}
GET /v1/metrics/replay/{id}
Description
This endpoint accepts the following query params:
total=true
bytes=true
period=24h
Uses Golang duration format (ie. 15m, 24h)
interval
Uses Golang duration format (ie. 15m, 24h)
If bytes is passed in, the timeseries values represent the number of bytes that were sent.
If total is passed in, the service will return a total count of events (or bytes) for the given time period (same as what you get from storage). interval will be ignored.
You can use total, bytes, interval, period in any combination.
Header Parameters
Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key
Path Parameters
Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key
Example Response
{
   "0dce7d85-8d61-41db-86bd-af005df755f4":{
      "latency_ms":0,
      "status":"error",
      "message":"Failed to connect",
      "last_checked_at":1624548189
   }
}
GET /v1/metrics/collection
Description
Get metrics for all collections.
Header Parameters
Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key
Example Response
{
   "0dce7d85-8d61-41db-86bd-af005df755f4":{
      "latency_ms":0,
      "status":"error",
      "message":"Failed to connect",
      "last_checked_at":1624548189
   }
}
GET /v1/metrics/collection/{id}
Description
Get metrics for one collection.
Header Parameters
Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key
Path Parameters
Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key
Example Response
{
   "0dce7d85-8d61-41db-86bd-af005df755f4":{
      "latency_ms":0,
      "status":"error",
      "message":"Failed to connect",
      "last_checked_at":1624548189
   }
}
GET /v1/metrics/collection/{id}
Description
Get collection metrics by collection id.
Header Parameters
Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key
Path Parameters
Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key
Example Response
{
   "0dce7d85-8d61-41db-86bd-af005df755f4":{
      "latency_ms":0,
      "status":"error",
      "message":"Failed to connect",
      "last_checked_at":1624548189
   }
}
GET /v1/metrics/error
Description
Get all error metrics for all collections.
Header Parameters
Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key
Example Response
{
   "0dce7d85-8d61-41db-86bd-af005df755f4":{
      "latency_ms":0,
      "status":"error",
      "message":"Failed to connect",
      "last_checked_at":1624548189
   }
}
GET /v1/metrics/error/{id}
Description
Get error metrics by collection id.
Header Parameters
Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key
Path Parameters
Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key
Example Response
{
   "0dce7d85-8d61-41db-86bd-af005df755f4":{
      "latency_ms":0,
      "status":"error",
      "message":"Failed to connect",
      "last_checked_at":1624548189
   }
}
GET /v1/metrics/storage
Description
Retrieves storage metrics for the team associated with the auth_token
For total events stored, call without the bytes param, or with bytes=false
For total bytes stored, call with query param bytes=true
Header Parameters
Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key
Example Response
{
   "0dce7d85-8d61-41db-86bd-af005df755f4":{
      "latency_ms":0,
      "status":"error",
      "message":"Failed to connect",
      "last_checked_at":1624548189
   }
}
GET /v1/metrics/storage/{id}
Description
Retrieves storage metrics for a single collection
For total events stored, call without the bytes param, or with bytes=false
For total bytes stored, call with query param bytes=true
Header Parameters
Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key
Path Parameters
Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key
Example Response
[
  {
     "interval": "2020-11-20T15:18:00-05:00",
     "value": 0
   },
   ...
]
GET /v1/metrics/storage/{id}
Description
Get storage metrics by storage id.
Header Parameters
Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key
Path Parameters
Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key
Example Response
{
   "0dce7d85-8d61-41db-86bd-af005df755f4":{
      "latency_ms":0,
      "status":"error",
      "message":"Failed to connect",
      "last_checked_at":1624548189
   }
}
GET /v1/metrics/auditlog/collection/{id}
Description
Get collection notifications by collection id.
Header Parameters
Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key
Path Parameters
Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key
Example Response
{
   "0dce7d85-8d61-41db-86bd-af005df755f4":{
      "latency_ms":0,
      "status":"error",
      "message":"Failed to connect",
      "last_checked_at":1624548189
   }
}
Replays
Team
Last modified 1yr ago
Copy link
On this page
GET /v1/metrics/replay
GET /v1/metrics/replay/{id}
GET /v1/metrics/collection
GET /v1/metrics/collection/{id}
GET /v1/metrics/error
GET /v1/metrics/error/{id}
GET /v1/metrics/storage
GET /v1/metrics/storage/{id}
GET /v1/metrics/auditlog/collection/{id}