Get Campaigns

GET

public

campaign-service

campaigns

curl --request GET \
  --url https://api.topsort.com/public/v1/campaign-service/campaigns

{
  "campaigns": [
    {
      "adFormat": "listing",
      "bidCount": 123,
      "budget": {
        "amount": 1000,
        "amountCarryover": 123,
        "amountRemaining": 123,
        "amountUsed": 123,
        "type": "daily"
      },
      "campaignBehaviorData": "<string>",
      "campaignBehaviorDataByDay": "<string>",
      "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "campaignType": "manual",
      "chargeType": "CPM",
      "createdAt": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "exclusivityPrice": 123,
      "externalCampaignId": "<string>",
      "externalVendorId": "<string>",
      "isActive": true,
      "isSmart": true,
      "isVendorCampaign": false,
      "marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Bola-Bola Ad campaign",
      "promotionType": {
        "adFormat": "banner",
        "bannerAssets": [
          {
            "assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
            "contentType": "image/png",
            "dimensions": {
              "height": 1080,
              "width": 1920
            },
            "size": 123,
            "url": "<string>"
          }
        ],
        "deviceType": "desktop",
        "slotId": "<string>"
      },
      "startDate": "2023-11-07T05:31:56Z",
      "status": "approved",
      "statusUpdatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "targetRoas": 123,
      "vendorId": "<string>",
      "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "hasMore": true,
  "next": {
    "limit": 123,
    "offset": 123
  }
}

Query Parameters

vendor_id

string

The ID of the vendor. Omit to get campaigns for all vendors.

Minimum length: 1

status

enum<string>

Filter by the approval status of banner campaigns.

Available options:

approved,

pending,

rejected

offset

integer

default:0

The pagination offset.

Required range: x >= 0

limit

integer

default:100

The pagination limit.

Required range: 0 <= x <= 100

is_active

boolean

Filter by active/inactive campaigns.

sort_by_date

enum<string>

Optional sort by date of campaign creation.

Available options:

asc,

desc

Response

200

application/json

Successful Response

The campaigns response.

campaigns

object[]

required

An array of campaigns.

The campaign model.

campaigns.adFormat

enum<string>

required

The ad format of the campaign. Can be listing or banner.

Available options:

listing,

banner,

exclusive_listing,

travel_listing,

flight_listing

campaigns.bidCount

integer

required

The amount of active bids associated with this campaign.

campaigns.campaignId

string

required

The ID of the campaign.

campaigns.campaignType

enum<string>

required

The bidding method for the campaign.

Available options:

manual,

autobidding,

exclusive

campaigns.chargeType

enum<string>

required

How campaigns are going to be charged, by click, by per mille impressions, or by action.

Available options:

CPM,

CPC,

CPA

campaigns.createdAt

string

required

When was this campaign created.

campaigns.endDate

string

required

The end date of the campaign.

campaigns.externalVendorId

string

requireddeprecated

The ID of the vendor. Deprecated. Use vendor_id instead.

Minimum length: 1

campaigns.isActive

boolean

required

Whether this campaign is active.

campaigns.isSmart

boolean

required

Whether this campaign is "smart".

campaigns.marketplaceId

string

required

The ID of the marketplace.

campaigns.name

string

required

The name of the campaign.

Minimum length: 1

Example:

"Bola-Bola Ad campaign"

campaigns.startDate

string

required

The starting date of the campaign.

campaigns.status

enum<string>

required

Represents the review status of a banner campaign.

Available options:

approved,

pending,

rejected

campaigns.vendorId

string

required

The ID of the vendor.

Minimum length: 1

campaigns.walletId

string

required

The uuid of the wallet to be used with this campaign.

campaigns.budget

object

The budget assigned to the campaign.

campaigns.campaignBehaviorData

string

deprecated

Deprecated. This field is always null. For behavioral data use reporting service.

campaigns.campaignBehaviorDataByDay

string

deprecated

Deprecated. This field is always null. For behavioral data use reporting service.

campaigns.exclusivityPrice

integer

Daily price for an exclusive campaign, can only be set if a campaign is exclusive

campaigns.externalCampaignId

string

The external ID of the campaign in the marketplace.

campaigns.isVendorCampaign

boolean

default:false

Whether this is a promoted shop campaign.

campaigns.promotionType

object

deprecated

Deprecated. Use adFormat field instead and format properties inside bids. The promotion type and attributes. Ad format must set to 'banner' for exclusive campaigns.

campaigns.statusUpdatedBy

string

The ID of the user who reviewed the campaign. If it's null and the status is not "pending" then it means this campaign has autoapproval status.

campaigns.targetRoas

number

The target return on ad spend (ROAS) for this campaign. This is only applicable for autobidding listing campaigns.

hasMore

boolean

required

Whether this is the last page of results or not.

object

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

Adjust Wallet Balance Create Campaign

curl --request GET \
  --url https://api.topsort.com/public/v1/campaign-service/campaigns

{
  "campaigns": [
    {
      "adFormat": "listing",
      "bidCount": 123,
      "budget": {
        "amount": 1000,
        "amountCarryover": 123,
        "amountRemaining": 123,
        "amountUsed": 123,
        "type": "daily"
      },
      "campaignBehaviorData": "<string>",
      "campaignBehaviorDataByDay": "<string>",
      "campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "campaignType": "manual",
      "chargeType": "CPM",
      "createdAt": "2023-11-07T05:31:56Z",
      "endDate": "2023-11-07T05:31:56Z",
      "exclusivityPrice": 123,
      "externalCampaignId": "<string>",
      "externalVendorId": "<string>",
      "isActive": true,
      "isSmart": true,
      "isVendorCampaign": false,
      "marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "Bola-Bola Ad campaign",
      "promotionType": {
        "adFormat": "banner",
        "bannerAssets": [
          {
            "assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
            "contentType": "image/png",
            "dimensions": {
              "height": 1080,
              "width": 1920
            },
            "size": 123,
            "url": "<string>"
          }
        ],
        "deviceType": "desktop",
        "slotId": "<string>"
      },
      "startDate": "2023-11-07T05:31:56Z",
      "status": "approved",
      "statusUpdatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "targetRoas": 123,
      "vendorId": "<string>",
      "walletId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "hasMore": true,
  "next": {
    "limit": 123,
    "offset": 123
  }
}

General

Auction examples

Asset examples

Webhook examples

Auctions

Events

Toptimize

Assets API

Billing API

Campaign API

Catalog API

Invitation API

Modal API

Reporting API

Segments Service

Toppie API

User API

Webhooks API

Query Parameters

Response