Retrieve an analytics alert
Reads one alert.
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.
alertId*string
The alert's id, alert_....
Examples
curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/analytics/alerts/alert_k3v9m2x7c1q8w4e6r0t5y2u8" \ -H "Authorization: Bearer vh_sk_..."{ "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"}{ "error": { "type": "invalid_request", "code": "string", "message": "string", "param": "string" }}{ "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": "analytics_alert_not_found", "message": "This project has no alert alert_k3v9m2x7c1q8w4e6r0t5y2u8.", "param": "alertId" }}{ "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 |
|---|---|---|---|
| 404 | not_found | analytics_alert_not_found | When the project has no such alert. |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Analytics alerts
- List analytics alerts
GET - Create an analytics alert
POST - Update an analytics alert
PATCH - Delete an analytics alert
DELETE
Something wrong or missing on this page? Tell us by email or on Discord.