Zum Hauptinhalt springen
GET
/
public
/
v1
/
offsite-ads
/
audiences
List Audiences
curl --request GET \
  --url https://api.topsort.com/public/v1/offsite-ads/audiences \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "dsp": "google_ads",
  "audiences": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "estimatedSize": 123,
      "estimatedSizeRange": {
        "lowerBound": 123,
        "upperBound": 123
      }
    }
  ],
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="
}

Autorisierungen

Authorization
string
header
erforderlich

A valid API key generated in Topsort's UI.

Abfrageparameter

vendor_id
string
erforderlich

The ID of the vendor to list the audiences for.

Beispiel:

"vendor_123"

dsp
enum<string>
erforderlich

The DSP to filter campaigns by.

Verfügbare Optionen:
google_ads,
meta
Beispiele:

"google_ads"

"meta"

next_page
string | null

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

Antwort

Successful Response

hasMore
boolean
erforderlich

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>
erforderlich

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

Verfügbare Optionen:
google_ads,
meta
audiences
PublicOffsiteAudience · object[]
erforderlich

The audiences for the vendor

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
Beispiel:

"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="