Audience

Gets the count of users in each state for the specified audience.

Changed on
get/audience/{audienceId}/user-metrics

Request

  • Base URL
    https://api.rapidata.ai
  • URL
    https://api.rapidata.ai/audience/{audienceId}/user-metrics
  • Auth
    OpenID Connect (https://auth.rapidata.ai/.well-known/openid-configuration, scopes: openid, profile, email, offline_access, api)

Path parameters

audienceIdstring required

The unique identifier of the audience.

Response

OK

usersPerStateobject required
capacity'None' | 'Low' | 'Sufficient' nullable required

How much labelling capacity an audience has, as a bucket rather than a headcount. Enough to tell someone their job will crawl or never finish, and no more — a filtered audience's membership is a predicate over its base, so an exact live count would mean maintaining a counter per filter for a number nobody reads.

Changes

  • c72c9f1c8ef5Revision changes
    • info

      removed the undefined enum value from the //// response property for the response status

  • 9da534659e5fRevision changes
    • info

      the security scope api was added to the endpoint's security scheme OpenIdConnect

    • info

      added the required property to the response with the status