POST
/
v2
/
auctions
/
sponsored-brand
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": "<string>",
      "triggers": {
        "category": {
          "id": "c_yogurt"
        },
        "products": {
          "ids": [
            "p_SA0238"
          ],
          "qualityScores": [
            0.75
          ]
        }
      },
      "opaqueUserId": "71303ce0-de89-496d-8270-6434589615e8"
    }
  ]
}'
{
  "results": [
    {
      "winners": [
        {
          "rank": 2,
          "productId": "p_Mfk15",
          "resolvedBidId": "WyJiX01mazE1IiwiMTJhNTU4MjgtOGVhZC00Mjk5LTgzMjctY2ViYjAwMmEwZmE4IiwibGlzdGluZ3MiLCJkZWZhdWx0IiwiIl0=",
          "title": "<string>",
          "vendorId": "v_8fj2D",
          "assets": [
            {
              "url": "<string>",
              "role": "<string>",
              "contentType": "<string>",
              "contentLength": 123,
              "width": 123,
              "height": 123
            }
          ]
        }
      ],
      "error": false
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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

Describes the intent of running a sponsored brand auction.

Exactly one of the following fields must be set:

  • products
  • category

Response

201
application/json
The 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