Get Slots

Get slots for a given marketplace.

GET /public/v1/media-service/slots

Get Slots

cURL

curl --request GET \
  --url https://api.topsort.com/public/v1/media-service/slots \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orderBy": [
    {}
  ]
}
'

import requests

url = "https://api.topsort.com/public/v1/media-service/slots"

payload = { "orderBy": [{}] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({orderBy: [{}]})
};

fetch('https://api.topsort.com/public/v1/media-service/slots', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.topsort.com/public/v1/media-service/slots",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => json_encode([
    'orderBy' => [
        [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.topsort.com/public/v1/media-service/slots"

	payload := strings.NewReader("{\n  \"orderBy\": [\n    {}\n  ]\n}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.topsort.com/public/v1/media-service/slots")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"orderBy\": [\n    {}\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.topsort.com/public/v1/media-service/slots")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"orderBy\": [\n    {}\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "hasMore": true,
  "slots": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "externalId": "<string>",
      "marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dimensions": {},
      "page": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "url": "<string>",
        "marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "imageUrl": "<string>"
      },
      "isActive": true
    }
  ],
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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 · string · Standard: ""

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.

Show child attributes

Antwort

200

application/json

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

Show child attributes

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="