Retrieve an automation's stats
Counts the automation's runs by outcome and the people who reached each step, across every version.
Step counts cover the last 90 days.
Guide: Automations
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.
automationId*string
The automation's id, auto_....
Examples
curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/automations/auto_p4n8c2v6x0z3q7w1e5r9t2y6/stats" \ -H "Authorization: Bearer vh_sk_..."{ "inProgress": 41, "completed": 312, "failed": 0, "cancelled": 0, "exited": 57, "steps": [ { "stepId": "welcome", "entered": 410, "completed": 410, "failed": 0, "waiting": 0, "ports": [ { "port": "out", "count": 410 } ] }, { "stepId": "wait", "entered": 410, "completed": 369, "failed": 0, "waiting": 41, "ports": [ { "port": "out", "count": 369 } ] }, { "stepId": "paid", "entered": 369, "completed": 369, "failed": 0, "waiting": 0, "ports": [ { "port": "yes", "count": 74 }, { "port": "no", "count": 295 } ] }, { "stepId": "nudge", "entered": 238, "completed": 238, "failed": 0, "waiting": 0, "ports": [ { "port": "out", "count": 238 } ] } ]}{ "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": "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
This operation adds no error codes of its own. It can fail with the errors every operation shares, such as unauthenticated; see Errors.
More in Automations
- List automations
GET - Create an automation
POST - Retrieve the automation catalog
GET - List audience cohorts
GET - Retrieve an automation
GET - Update an automation
PATCH - Check an automation
POST - Test an automation
POST - Activate an automation
POST - Pause an automation
POST - Archive an automation
POST - Unarchive an automation
POST - List an automation's versions
GET - List an automation's runs
GET - Start a run
POST - Retrieve a run
GET - Cancel a run
POST - Retry a run
POST
Something wrong or missing on this page? Tell us by email or on Discord.