Metrics
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.Param | Type | Required | Description |
Authorization | string | yes | Bearer token containing API key |
Param | Type | Required | Description |
TODO | string | yes | Bearer token containing API key |
{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}
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.Param | Type | Required | Description |
Authorization | string | yes | Bearer token containing API key |
Param | Type | Required | Description |
TODO | string | yes | Bearer token containing API key |
{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}
Get metrics for all collections.
Param | Type | Required | Description |
Authorization | string | yes | Bearer token containing API key |
{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}
Get metrics for one collection.
Param | Type | Required | Description |
Authorization | string | yes | Bearer token containing API key |
Param | Type | Required | Description |
TODO | string | yes | Bearer token containing API key |
{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}
Get collection metrics by collection id.
Param | Type | Required | Description |
Authorization | string | yes | Bearer token containing API key |
Param | Type | Required | Description |
TODO | string | yes | Bearer token containing API key |
{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}
Get all error metrics for all collections.
Param | Type | Required | Description |
Authorization | string | yes | Bearer token containing API key |
{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}
Get error metrics by collection id.
Param | Type | Required | Description |
Authorization | string | yes | Bearer token containing API key |
Param | Type | Required | Description |
TODO | string | yes | Bearer token containing API key |
{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}
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
Param | Type | Required | Description |
Authorization | string | yes | Bearer token containing API key |
{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}
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
Param | Type | Required | Description |
Authorization | string | yes | Bearer token containing API key |
Param | Type | Required | Description |
TODO | string | yes | Bearer token containing API key |
[
{
"interval": "2020-11-20T15:18:00-05:00",
"value": 0
},
...
]
Get storage metrics by storage id.
Param | Type | Required | Description |
Authorization | string | yes | Bearer token containing API key |
Param | Type | Required | Description |
TODO | string | yes | Bearer token containing API key |
{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}
Get collection notifications by collection id.
Param | Type | Required | Description |
Authorization | string | yes | Bearer token containing API key |
Param | Type | Required | Description |
TODO | string | yes | Bearer token containing API key |
{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}
Last modified 1yr ago