Get an audience

GET

/audience/management/v1/audiences/{id}

const url = 'https://api.ebitex.io/audience/management/v1/audiences/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.ebitex.io/audience/management/v1/audiences/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Returns one audience. The id is what a personalized variant stores, so it never changes when the audience is renamed.

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

Authorizations

apiKey

Parameters

Path Parameters

required

string format: uuid

Responses

200

{ "id", "externalId", "name", "predicate": { … }, "revision", "scope", "storedMembership", "memberCount", "membershipCurrent", "createdAtUtc", "updatedAtUtc", "rowVersion", "behaviours": [ … ] }. scope is context (reads only the request’s own context), individual (reads only what Audience knows about a recognised person) or mixed.

401

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.

402

payment_required: the organization’s subscription needs attention.

403

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.

404

audience_not_found: no such audience in this organization.

not_found: no such route.

429

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.