Skip to content

Count a stage by state

GET
/audience/management/v1/stages/{stage}/summary
curl --request GET \
--url https://api.ebitex.io/audience/management/v1/stages/example/summary \
--header 'Authorization: Bearer <token>'

Returns the true number of open passes in each state of the stage, and how many are open and closed in all. These are counts, never a sample, so a dashboard built on them is right at any size.

Key: an Audience management key with audience.management.read (write also needs read; erase needs both).

stage
required
string

{ "states": [ { "id", "name", "kind", "isTerminal", "count" } ], "openCount", "closedCount" }.

missing_api_key or invalid_api_key: no key was sent, or it is unknown, revoked or expired, or it was not created from the Audience settings page.

payment_required: the organization’s subscription needs attention.

scope_denied: the key lacks this route’s scope. ip_denied: the caller’s address is outside the key’s allowed ranges. app_not_available: Audience is not enabled for the organization.

stage_not_found.

not_found: no such route.

rate_limited: the key spent its requests-per-minute budget; Retry-After says how long to wait. too_many_failed_authentications: too many bad keys from this address.