Workspace home dashboard rollup
curl --request GET \
--url https://app.hookie.ai/admin/api/dashboard/summary \
--cookie hookie_session=const options = {method: 'GET', headers: {cookie: 'hookie_session='}};
fetch('https://app.hookie.ai/admin/api/dashboard/summary', 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/summary"
headers = {"cookie": "hookie_session="}
response = requests.get(url, headers=headers)
print(response.text){
"plan": "free",
"quota": 123,
"events_this_month": 123,
"deliveries_7d": 123,
"failed_7d": 123,
"error_rate_7d": 123,
"agent_runs_7d": 123,
"projects": [
{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"type": "webhook",
"webhooks": 123,
"events_7d": 123,
"error_rate_7d": 123,
"last_activity": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}Dashboard
Workspace home dashboard rollup
Aggregated on read from records / deliveries / agent_runs / usage_rollups. Readable by any role.
GET
/
admin
/
api
/
dashboard
/
summary
Workspace home dashboard rollup
curl --request GET \
--url https://app.hookie.ai/admin/api/dashboard/summary \
--cookie hookie_session=const options = {method: 'GET', headers: {cookie: 'hookie_session='}};
fetch('https://app.hookie.ai/admin/api/dashboard/summary', 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/summary"
headers = {"cookie": "hookie_session="}
response = requests.get(url, headers=headers)
print(response.text){
"plan": "free",
"quota": 123,
"events_this_month": 123,
"deliveries_7d": 123,
"failed_7d": 123,
"error_rate_7d": 123,
"agent_runs_7d": 123,
"projects": [
{
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"type": "webhook",
"webhooks": 123,
"events_7d": 123,
"error_rate_7d": 123,
"last_activity": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z"
}
]
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}{
"error": "<string>",
"retry_after": 123,
"upgrade_url": "<string>"
}Authorizations
sessionbearerAuth
The console's sealed session cookie, set by WorkOS AuthKit. Mutating requests also require the X-Requested-With CSRF header.
Response
Workspace-wide (not project-scoped) counters plus a per-project row set.
Available options:
free, standard, team Plan events-per-month allowance.
failed_7d / deliveries_7d, or 0 when there were no deliveries.
Show child attributes
Show child attributes