Skip to main content
POST
/
v2
/
auctions
/
sponsored-brand
Create sponsored brand auctions
curl --request POST \
  --url https://api.topsort.com/v2/auctions/sponsored-brand \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "auctions": [
    {
      "winners": 2,
      "placementId": "some-placement",
      "triggers": {
        "products": {
          "ids": [
            "vanilla_yogurt"
          ]
        }
      }
    }
  ]
}
'
{
  "results": [
    {
      "resultType": "brand",
      "winners": [
        {
          "rank": 1,
          "type": "product",
          "id": "brand-123",
          "resolvedBidId": "WyJiX01mazE1IiwiMTJhNTU4MjgtOGVhZC00Mjk5LTgzMjctY2ViYjAwMmEwZmE4IiwibGlzdGluZ3MiLCJkZWZhdWx0IiwiIl0=",
          "content": {
            "headline": "Topsort Rocks",
            "brandName": "Topsort Brand"
          }
        }
      ],
      "error": false
    }
  ]
}

Authorizations

​
Authorization
string
header
required

A valid API key generated in Topsort's UI.

Body

application/json

The information describing what will be auctioned. Topsort will run an auction for each batched auction request, for which products bids will compete against each other.

​
auctions
object[]
required
Required array length: 1 - 5 elements
Example:
[
  {
    "winners": 2,
    "placementId": "some-placement",
    "triggers": { "products": { "ids": ["vanilla_yogurt"] } }
  }
]

Response

The sponsored brand auction results. The list of winners will contain at most winners entries per auction. It may contain fewer or no entries at all if there aren't enough products with usable bids, that is, a bid amount greater than the reserve price and belonging to a campaign with enough remaining budget. Bids become unusable if campaign budget is exhausted, the bid is disqualified to preserve spend pacing, etc.

​
results
object[]
required
Required array length: 1 - 5 elements
Example:
[
  {
    "resultType": "brand",
    "winners": [],
    "error": false
  }
]