GET /v3/audience/{audienceId}/{geoForCounts} → Query.audience

Overview

Property Value
REST endpoint GET /v3/audience/{audienceId}/{geoForCounts}
GraphQL query Query.audience(id: ID!)
Return type Audience

Response field mapping

REST response field GraphQL field GraphQL type Nullable Notes
AdvertiserId advertiser.id ID! Not nullable Nested Advertiser reference on Audience.
AudienceId id ID! Not nullable N/A
AudienceName name String! Not nullable N/A
Description description String Nullable N/A
IncludedDataGroupIds targetingDataGroups.edges[included=true].node.id [ID!]! Not nullable Use targetingDataGroups { edges { included node { id } } }; select edges where included is true.
ExcludedDataGroupIds targetingDataGroups.edges[included=false].node.id [ID!]! Not nullable Same connection; select edges where included is false.
LastUpdatedAtUTC lastUpdatedAt DateTime! Not nullable N/A
IsAutoGenerated isAutoGenerated Boolean! Not nullable N/A
GeoForCounts geoForCounts String Nullable REST {geoForCounts} path segment supplies geo for count resolution. GraphQL has no equivalent argument on audience(id); geoForCounts is a read-only field and activeUniques counts are not geo-parameterized in GraphQL.
UniqueUserCount activeUniques.idsCount Long Nullable Counts are not filtered by the REST path geo in GraphQL.
WebCount activeUniques.idsWebCount Long Nullable N/A
InAppCount activeUniques.idsInAppCount Long Nullable N/A
CtvCount activeUniques.idsConnectedTvCount Long Nullable N/A
PersonsCount activeUniques.personsCount Long Nullable N/A
HouseholdCount activeUniques.householdCount Long Nullable N/A
ActiveIDsCountExpanded activeIDsCountExpanded Boolean Nullable N/A
SuccessfullyRetrievedCounts successfullyRetrievedCounts Boolean Nullable N/A

Code examples

REST example

GET /v3/audience/{audienceId}/{geoForCounts} HTTP/1.1
TTD-Auth: AUTH_TOKEN_PLACEHOLDER

GraphQL example

POST /graphql HTTP/1.1
Content-Type: application/json
TTD-Auth: AUTH_TOKEN_PLACEHOLDER
query AudienceWithGeoCounts {
  audience(id: "<audience-id>") {
    id
    geoForCounts
    activeUniques {
      idsCount
      idsWebCount
      idsInAppCount
      idsConnectedTvCount
      personsCount
      householdCount
    }
    activeIDsCountExpanded
    successfullyRetrievedCounts
  }
}