List analytics alerts
Lists the project's alerts, each with how it stood at its latest hourly check.
Guide: Alerts
AuthorizationBearer <token>
A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.
In: header
Path parameters
projectId*string
The project's id, proj_.... A secret key works only in the project it belongs to.
Query parameters
cursor?string
Where the page starts: the pageInfo.endCursor of the previous page. Omit it for the first page.
limit?integer
How many items to return, from 1 to 100. Defaults to 50.
Range
1 <= value <= 100Examples
curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/analytics/alerts" \ -H "Authorization: Bearer vh_sk_..."{ "data": [ { "id": "alert_k3v9m2x7c1q8w4e6r0t5y2u8", "projectId": "proj_tz4a98xxat96iws9zmbrgj3a", "name": "Workout sync failing", "kind": "failure_share", "eventName": "workout_sync_failed", "successEventName": "workout_sync_completed", "windowHours": 24, "threshold": 0.2, "minPeople": null, "isEnabled": true, "state": "ok", "value": 0.03, "baseline": null, "baselineWeeks": null, "checkedThrough": "2026-03-14T09:00:00.000Z", "firingSince": null, "createdAt": "2026-03-05T12:00:00.000Z" } ], "pageInfo": { "endCursor": null, "hasNextPage": false }}{ "error": { "type": "invalid_request", "code": "invalid_cursor", "message": "This cursor does not continue the list. Start again without a cursor.", "param": "cursor" }}{ "error": { "type": "unauthenticated", "code": "invalid_api_key", "message": "This secret key is not valid." }}{ "error": { "type": "permission_denied", "code": "permission_denied", "message": "Insufficient permissions." }}{ "error": { "type": "not_found", "code": "project_not_found", "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.", "param": "projectId" }}{ "error": { "type": "internal", "code": "internal_error", "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing." }}Response body
application/json
application/json
application/json
application/json
application/json
application/json
Errors
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request | invalid_cursor | For a cursor from another list. |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Analytics alerts
Something wrong or missing on this page? Tell us by email or on Discord.