List Audiences

List offsite audiences.

GET /public/v1/offsite-ads/audiences

Try it

List Audiences

cURL

curl --request GET \
  --url https://api.topsort.com/public/v1/offsite-ads/audiences \
  --header 'Authorization: Bearer <token>'

200

{
  "hasMore": true,
  "dsp": "google_ads",
  "audiences": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "estimatedSize": 123,
      "estimatedSizeRange": {
        "lowerBound": 123,
        "upperBound": 123
      }
    }
  ],
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="
}

Authorizations

Authorization · string · header · required

A valid API key generated in Topsort's UI.

Query Parameters

vendor_id · string · required

The ID of the vendor to list the audiences for.

dsp · enum<string> · required

The DSP to filter campaigns by.

Available options: google_ads, meta

next_page · string | null

Pagination cursor as provided in an earlier response. If provided will fetch the next page of results.

Response

200

application/json

Successful Response

hasMore · boolean · required

Flag that indicates whether more results are available. true indicates there is a next page of results. false indicates this response contains the last page of results.

dsp · enum<string> · required

The Demand-Side Platform (DSP) associated with the campaign

Available options: google_ads, meta

audiences · PublicOffsiteAudience · object[] · required

The audiences for the vendor

Show child attributes

audiences. id · string · required

The id of the audience. Use this id to use audiences in campaign creation

audiences. name · string · required

The name of the audience.

audiences. description · string | null

The description of the audience.

audiences. estimatedSize · integer | null

The estimated size of the audience.

audiences. estimatedSizeRange · IntRange · object

The estimated size range of the audience.

Show child attributes

audiences.estimatedSizeRange. lowerBound · integer | null · required

The lower bound of the size range.

audiences.estimatedSizeRange. upperBound · integer | null · required

The upper bound of the size range.

nextPage · string | null

Pagination cursor. Provide this value as a next_page query parameter in a new request to retrieve the next page of results.

Minimum string length: 1

Example:

"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="