Media API

Get Slots

Get slots for a given marketplace.

get/public/v1/media-service/slots

Request

  • Base URL: https://api.topsort.com
  • URL: https://api.topsort.com/public/v1/media-service/slots
  • Auth: HTTP bearer

Query parameters

position'landing' | 'category_search' | 'category' | 'search' required

The position of the slot.

page_idstring uuid nullable

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

searchstring

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

next_pagestring nullable

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

limitinteger

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

Request body

Response

Successful Response

hasMoreboolean 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.

nextPagestring nullable

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

Example response

{
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo=",
  "slots": [
    {
      "page": {
        "name": "Homepage",
        "url": "https://app.example.com/main"
      },
      "dimensions": {
        "desktop": {
          "height": 20,
          "width": 20
        },
        "mobile": {
          "height": 10,
          "width": 10
        }
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.