Get Campaign Bids

Endpoint to retrieve all campaign’s bids.

GET /public/v1/campaign-service/campaigns/{campaign-id}/bids

Get Campaign Bids

cURL

curl --request GET \
  --url https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign-id}/bids \
  --header 'Authorization: Bearer <token>'

200

{
  "hasMore": true,
  "bids": [
    {
      "bidId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "target": {
        "id": "<string>",
        "type": "product"
      },
      "isActive": true,
      "triggers": [
        {
          "type": "<string>",
          "value": {
            "words": [
              "<string>"
            ],
            "matchType": "exact"
          }
        }
      ],
      "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "state": "active",
      "amount": "<unknown>",
      "trigger": {
        "type": "<string>",
        "value": {
          "words": [
            "<string>"
          ],
          "matchType": "exact"
        }
      },
      "location": "Santiago",
      "bidsBehaviorData": "<string>",
      "formatProperties": {
        "bannerAssets": [
          {
            "dimensions": {
              "width": 123,
              "height": 123
            },
            "url": "<string>",
            "contentType": "image/png",
            "size": 123,
            "assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
            "content": {},
            "jsonTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "slotId": "<string>",
        "adFormat": "<string>",
        "deviceType": "desktop"
      }
    }
  ],
  "next": {
    "offset": 123,
    "limit": 123
  }
}

Authorizations

Authorization · string · header · required

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.

Path Parameters

campaign-id · string<uuid> · required

The ID of the campaign.

Query Parameters

offset · integer · default: 0

The pagination offset.

Required range: x >= 0

limit · integer · default: 100

The pagination limit.

Required range: 0 <= x <= 100

Response

200

application/json

Successful Response

The public response body of the bids endpoints.

hasMore · boolean · required

Whether this is the last page of results or not.

bids · Bid · object[] · required

An array of bids.

Maximum array length: 500

Show child attributes

next · Next · object

The parameters that should be used to fetch the next page.

Show child attributes