Analytics breakdown by project, endpoint, workflow and dataset
curl --request GET \
--url https://app.hookie.ai/admin/api/dashboard/analytics \
--cookie hookie_session=const options = {method: 'GET', headers: {cookie: 'hookie_session='}};
fetch('https://app.hookie.ai/admin/api/dashboard/analytics', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/admin/api/dashboard/analytics"
headers = {"cookie": "hookie_session="}
response = requests.get(url, headers=headers)
print(response.text){
"window": "24h",
"since": "2023-11-07T05:31:56Z",
"truncated": true,
"projects": [
{
"endpoints": 123,
"datasets": 123,
"workflows": 123,
"events": 123,
"rejected": 123,
"deliveries": 123,
"delivered": 123,
"failed": 123,
"workflow_runs": 123,
"workflow_failed": 123,
"stored_bytes": 123,
"id": "<string>",
"name": "<string>",
"type": "<string>",
"avg_response_ms": 123,
"last_activity": "2023-11-07T05:31:56Z"
}
],
"endpoints": [
{
"id": "<string>",
"project_id": "<string>",
"name": "<string>",
"version": "<string>",
"enabled": true,
"dataset": "<string>",
"events": 123,
"rejected": 123,
"last_event": "2023-11-07T05:31:56Z"
}
],
"workflows": [
{
"id": "<string>",
"project_id": "<string>",
"name": "<string>",
"active": true,
"entry_dataset": "<string>",
"runs": 123,
"completed": 123,
"failed": 123,
"avg_seconds": 123
}
],
"datasets": [
{
"project_id": "<string>",
"dataset": "<string>",
"records": 123,
"events": 123,
"bytes": 123,
"last_record": "2023-11-07T05:31:56Z"
}
]
}{
"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>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"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>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"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>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"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>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"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>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}Dashboard
Analytics breakdown by project, endpoint, workflow and dataset
One response for the console’s Analytics page: every project’s traffic, delivery, workflow and storage figures for the window. Readable by any role. Endpoint slugs are never returned. Delivery figures exist per project only. A dataset’s bytes are the stored record payload (SUM of LENGTH(payload)), not the database’s own overhead. Endpoints, workflows and datasets are capped at 500 rows each; truncated says when one was.
GET
/
admin
/
api
/
dashboard
/
analytics
Analytics breakdown by project, endpoint, workflow and dataset
curl --request GET \
--url https://app.hookie.ai/admin/api/dashboard/analytics \
--cookie hookie_session=const options = {method: 'GET', headers: {cookie: 'hookie_session='}};
fetch('https://app.hookie.ai/admin/api/dashboard/analytics', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.hookie.ai/admin/api/dashboard/analytics"
headers = {"cookie": "hookie_session="}
response = requests.get(url, headers=headers)
print(response.text){
"window": "24h",
"since": "2023-11-07T05:31:56Z",
"truncated": true,
"projects": [
{
"endpoints": 123,
"datasets": 123,
"workflows": 123,
"events": 123,
"rejected": 123,
"deliveries": 123,
"delivered": 123,
"failed": 123,
"workflow_runs": 123,
"workflow_failed": 123,
"stored_bytes": 123,
"id": "<string>",
"name": "<string>",
"type": "<string>",
"avg_response_ms": 123,
"last_activity": "2023-11-07T05:31:56Z"
}
],
"endpoints": [
{
"id": "<string>",
"project_id": "<string>",
"name": "<string>",
"version": "<string>",
"enabled": true,
"dataset": "<string>",
"events": 123,
"rejected": 123,
"last_event": "2023-11-07T05:31:56Z"
}
],
"workflows": [
{
"id": "<string>",
"project_id": "<string>",
"name": "<string>",
"active": true,
"entry_dataset": "<string>",
"runs": 123,
"completed": 123,
"failed": 123,
"avg_seconds": 123
}
],
"datasets": [
{
"project_id": "<string>",
"dataset": "<string>",
"records": 123,
"events": 123,
"bytes": 123,
"last_record": "2023-11-07T05:31:56Z"
}
]
}{
"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>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"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>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"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>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"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>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}{
"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>",
"max_members": 123,
"members": 123,
"customer_id": "<string>",
"customer_name": "<string>",
"account_id": "<string>",
"terms_version": "<string>",
"claim_required": true
}Authorizations
sessionbearerAuthapiKey
The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.
Query Parameters
Time window. Defaults to 7d.
Available options:
24h, 7d, 30d Response
The window's breakdown.
Available options:
24h, 7d, 30d Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes