List live users
Who is here now: the people who opened or returned to the project's apps ($app_opened, $app_became_active), and the people who viewed one of its web pages ($pageview), within the last windowMinutes.
Someone on both counts once in each. locations places people in whole degrees of latitude and longitude, the coarseness of a region; users also counts people whose events carry no location, so it can exceed the sum of locations. Reads production events unless the credential names another environment, as for insights. On a self-hosted server, these events count only after they are turned on in the project's ingest policy. Takes no options.
Guide: Analytics overview
A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.
In: header
Path parameters
The project's id, proj_.... A secret key works only in the project it belongs to.
Examples
curl -X POST "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/analytics/reports/live-users" \ -H "Authorization: Bearer vh_sk_..."{ "windowMinutes": 15, "app": { "users": 214, "locations": [ { "latitude": 50, "longitude": 14, "users": 38 }, { "latitude": 52, "longitude": 13, "users": 21 }, { "latitude": 41, "longitude": -74, "users": 17 } ] }, "web": { "users": 41, "locations": [ { "latitude": 50, "longitude": 14, "users": 9 }, { "latitude": 51, "longitude": 0, "users": 6 } ] }}{ "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 Analytics
- Compute insights
POST - Compute charts
POST - Measure metrics
POST - List the people behind a metric
POST - Report acquisition
POST - Report acquisition cohorts
POST - Report tracking health
POST
Something wrong or missing on this page? Tell us by email or on Discord.