Delivery health per destination: success rate, latency percentiles, error classes, time series
curl --request GET \
--url https://app.hookie.ai/admin/api/projects/{pid}/deliveries/metricsconst options = {method: 'GET'};
fetch('https://app.hookie.ai/admin/api/projects/{pid}/deliveries/metrics', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/admin/api/projects/{pid}/deliveries/metrics"
response = requests.get(url)
print(response.text){
"window": "24h",
"since": "2023-11-07T05:31:56Z",
"until": "2023-11-07T05:31:56Z",
"destination_id": "<string>",
"bucket": "hour",
"bucket_ms": 123,
"totals": {
"deliveries": {
"total": 123,
"delivered": 123,
"failed": 123,
"pending": 123
},
"success_rate": 123,
"attempts": 123,
"attempts_ok": 123,
"attempt_success_rate": 123,
"latency_ms": {
"p50": 123,
"p95": 123,
"p99": 123
},
"errors": {
"3xx": 123,
"4xx": 123,
"5xx": 123,
"timeout": 123,
"connection": 123,
"other": 123
}
},
"destinations": [
{
"destination_id": "<string>",
"destination_name": "<string>",
"enabled": true,
"deliveries": {
"total": 123,
"delivered": 123,
"failed": 123,
"pending": 123
},
"success_rate": 123,
"attempts": 123,
"attempts_ok": 123,
"attempt_success_rate": 123,
"latency_ms": {
"p50": 123,
"p95": 123,
"p99": 123
},
"errors": {
"3xx": 123,
"4xx": 123,
"5xx": 123,
"timeout": 123,
"connection": 123,
"other": 123
}
}
],
"series": [
{
"t": "2023-11-07T05:31:56Z",
"ok": 123,
"failed": 123
}
]
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>"
}Deliveries
Delivery health per destination: success rate, latency percentiles, error classes, time series
Every attempt in the window, the failed ones and the successful ones, per destination in the project and in total. Answers which destination is failing, whether it refuses requests (4xx) or fails to serve them (5xx, timeouts), and how slow it is. The series is hourly for 24h and 7d, daily for 30d, with every bucket present.
GET
/
admin
/
api
/
projects
/
{pid}
/
deliveries
/
metrics
Delivery health per destination: success rate, latency percentiles, error classes, time series
curl --request GET \
--url https://app.hookie.ai/admin/api/projects/{pid}/deliveries/metricsconst options = {method: 'GET'};
fetch('https://app.hookie.ai/admin/api/projects/{pid}/deliveries/metrics', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/admin/api/projects/{pid}/deliveries/metrics"
response = requests.get(url)
print(response.text){
"window": "24h",
"since": "2023-11-07T05:31:56Z",
"until": "2023-11-07T05:31:56Z",
"destination_id": "<string>",
"bucket": "hour",
"bucket_ms": 123,
"totals": {
"deliveries": {
"total": 123,
"delivered": 123,
"failed": 123,
"pending": 123
},
"success_rate": 123,
"attempts": 123,
"attempts_ok": 123,
"attempt_success_rate": 123,
"latency_ms": {
"p50": 123,
"p95": 123,
"p99": 123
},
"errors": {
"3xx": 123,
"4xx": 123,
"5xx": 123,
"timeout": 123,
"connection": 123,
"other": 123
}
},
"destinations": [
{
"destination_id": "<string>",
"destination_name": "<string>",
"enabled": true,
"deliveries": {
"total": 123,
"delivered": 123,
"failed": 123,
"pending": 123
},
"success_rate": 123,
"attempts": 123,
"attempts_ok": 123,
"attempt_success_rate": 123,
"latency_ms": {
"p50": 123,
"p95": 123,
"p99": 123
},
"errors": {
"3xx": 123,
"4xx": 123,
"5xx": 123,
"timeout": 123,
"connection": 123,
"other": 123
}
}
],
"series": [
{
"t": "2023-11-07T05:31:56Z",
"ok": 123,
"failed": 123
}
]
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>",
"reason": "<string>",
"code": "agent_scope_insufficient",
"required_scope": "hookie:read",
"granted_scopes": [
"<string>"
],
"manage_url": "<string>",
"scheme": "<string>"
}Path Parameters
Project id (UUID) belonging to the caller workspace.
Query Parameters
Available options:
24h, 7d, 30d Only this destination.
Response
Delivery health for the window.
Available options:
24h, 7d, 30d Available options:
hour, day Show child attributes
Show child attributes
The project's destinations, busy or not, then any deleted one with history in the window.
Show child attributes
Show child attributes
Show child attributes
Show child attributes