Zum Hauptinhalt springen
GET
Get Slots

Autorisierungen

Authorization
string
header
erforderlich

A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key.

Abfrageparameter

position
enum<string>
erforderlich

The position of the slot.

Verfügbare Optionen:
landing,
category_search,
category,
search
page_id
string<uuid> | null

The ID of the page. If provided, the slots will be filtered by the page.

Search query to be matched with page url, page name or slot id.

next_page
string | null

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

limit
integer
Standard:25

Limits the number of records to be returned. The limit can not surpass 50 and its default is 25.

Erforderlicher Bereich: x <= 50

Body

application/json

Request body containing the orderBy dimensions and directions.

orderBy
SlotOrderByClause · object[]
erforderlich

The fields to sort the results by.

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.

slots
AdConfigSlot · object[]
erforderlich
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="