Saltar para o conteúdo principal
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="
}

Autorizações

Authorization
string
header
obrigatório

A valid API key generated in Topsort's UI.

Parâmetros de consulta

vendor_id
string
obrigatório

The ID of the vendor to list the audiences for.

Exemplo:

"vendor_123"

dsp
enum<string>
obrigatório

The DSP to filter campaigns by.

Opções disponíveis:
google_ads,
meta
Exemplos:

"google_ads"

"meta"

next_page
string | null

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

Resposta

Successful Response

hasMore
boolean
obrigatório

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>
obrigatório

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

Opções disponíveis:
google_ads,
meta
audiences
PublicOffsiteAudience · object[]
obrigatório

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

"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="