Audience Explorer

Prev Next

Use Audience Explorer to retrieve a list of all audiences and their corresponding metadata.

Endpoint

/traffic/audiences

Use the following HTTP method:

  • Use the GET method to get a detailed view of all audience segment metadata.

Parameters

Parameters

Parameter Type

Description

Data Type

Required/Optional

page

query

Page Number.

Integer

Optional

limit

query

Specifies the total number of items to return. Maximum allowed value is 100.

Integer

Optional

sort

query

Specify the column to sort by.

String

Optional

accountId

query

Specifies the advertiser ID.

Long

Optional

dir

query

Specifies the sort direction. Allowed values:

  • ASC: data is sorted in ascending order.

  • DESC: data is sorted in descending order.

Enum

Optional

query

query

Specifies the search term.

Allowed variables:

  • Name

  • Segment ID

String

Optional

keywords

query

Comma-separated search strings that search against name and description.

String

Optional

segmentType

query

Specifies the segment type:

String

Optional

status

query

The current status of the audience.

Allowed values:

  • ACTIVE: the audience can be targeted.

  • INACTIVE: the audience cannot be targeted.

String

Optional

startTime

query

Return segments that are created/modified after this epoch time.

Long

Optional

endTime

query

Return segments that are created/modified before this epoch time.

Long

Optional

countryCodes

query

Country iso3 codes list, comma-separated.

String

Optional

currency

query

Local currency id whether at Seat, Advertiser or Order level.

String

Optional

timezoneId

query

Target timezone.

Integer

Optional

includeIabDataLabels

query

If true, include IAB data labels in the response.

Boolean

Optional

Note

When querying by accountId, the response includes all audiences linked to the advertiser, including those defined at the seat level.

Sample Request

GET https://dspapi.admanagerplus.yahoo.com/traffic/audiences?segmentType={segmentType}&query={id}

Sample Response

{
    "response": [
        {
            "id": 123123,
            "status": "ACTIVE",
            "name": "Test LAL Build",
            "segmentType": "LOOKALIKE",
            "createdAt": "2025-10-24",
            "createdBy": "test@yahoo.com",
            "lastModifiedAt": "2025-10-24",
            "reachDetails": {
                "reachCount": 10983873,
                "peopleCount": 3234270,
                "houseHoldCount": 3728376
            },
            "fees": [
                {
                    "fee": 0.5,
                    "suppressionFee": 0.0,
                    "mediaType": "VIDEO",
                    "channelType": "NATIVE",
                    "currencyCode": "USD"
                },
                {
                    "fee": 0.75,
                    "suppressionFee": 0.0,
                    "mediaType": "AUDIO",
                    "channelType": "DEFAULT",
                    "currencyCode": "USD"
                },
                {
                    "fee": 0.5,
                    "suppressionFee": 0.0,
                    "mediaType": "VIDEO",
                    "channelType": "DEFAULT",
                    "currencyCode": "USD"
                },
                {
                    "fee": 0.25,
                    "suppressionFee": 0.0,
                    "mediaType": "DISPLAY",
                    "channelType": "DEFAULT",
                    "currencyCode": "USD"
                },
                {
                    "fee": 0.75,
                    "suppressionFee": 0.0,
                    "mediaType": "VIDEO",
                    "channelType": "CONNECTEDTV",
                    "currencyCode": "USD"
                },
                {
                    "fee": 0.25,
                    "suppressionFee": 0.0,
                    "mediaType": "DISPLAY",
                    "channelType": "NATIVE",
                    "currencyCode": "USD"
                }
            ],
            "dataOwner": {
                "name": "Yahoo",
                "email": "test@yahoo.com",
                "domain": "https://yahooinc.com",
                "privacyPolicyUrl": "https://legal.yahoo.com/xw/en/yahoo/privacy/intl/index.html",
                "iabTechlabCompliant": false
            }
        }
    ],
    "errors": null,
    "timeStamp": "2025-11-10T23:47:33.642Z"
}