Skip to main content
GET
/
public
/
v1
/
media-service
/
slots
Get Slots
curl --request GET \
  --url https://api.topsort.com/public/v1/media-service/slots \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "orderBy": [
    {
      "dimension": "page_url",
      "direction": "asc"
    }
  ]
}'
{
  "hasMore": true,
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo=",
  "slots": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "externalId": "<string>",
      "position": "landing",
      "page": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Homepage",
        "url": "https://app.example.com/main",
        "imageUrl": "<string>",
        "marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dimensions": {
        "desktop": {
          "height": 20,
          "width": 20
        },
        "mobile": {
          "height": 10,
          "width": 10
        }
      },
      "isActive": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

A valid API key generated in Topsort's UI.

Query Parameters

​
position
enum<string>
required

The position of the slot.

Available options:
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
string
default:""

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
default:25

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

Required range: 0 < x <= 50

Body

application/json

Request body containing the orderBy dimensions and directions.

​
orderBy
SlotOrderByClause · object[]
required

The fields to sort the results by.

Response

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.

​
slots
AdConfigSlot · object[]
required
​
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 length: 1
Examples:

"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="