Auction examples
- Running auctions
- Sponsored listings
- Sponsored banners
- Sponsored brands
Asset examples
Webhook examples
Toptimize
Assets API
Billing API
- GETGet Billing Contacts
- GETGet Billing Contact
- PUTUpsert Billing Contact
- GETGet Campaign Billing Contact
- PUTUpsert Campaign Billing Contact
- GETGet Marketplace Credit Limit
- POSTSet Marketplace Credit Limit
- PUTUpsert Vendor Billing Contact
- GETGet Vendor Charges
- GETGet Vendor Account Activity
- GETGet Vendor Balance
- POSTAdd Vendor Balance
- POSTBurn Vendor Balance
- GETGet Vendor Credit History
- GETGet Vendor Credit Limit
- POSTSet Vendor Credit Limit
- DELDelete Vendor Billing Contact
- GETGet Vendor Wallets
- POSTCreate Wallet
- POSTAdjust Wallet Balance
Campaign API
- GETGet Campaigns
- POSTCreate Campaign
- GETGet Campaign By Id
- DELDelete Campaign By Id
- PATCHUpdate Campaign By Id
- GETGet Campaign Bids
- POSTCreate Campaign Bids
- DELDelete Campaign Bid By Id
- PATCHUpdate Campaign Bid By Id
- POST[BETA] Get estimated clicks of a future campaign for a given vendor
- GETGet Products In Campaign
- GETGet Sponsored Products
Catalog API
Invitation API
Modal API
Reporting API
- GETGet Campaign Report
- GETGet Campaign Daily Report
- GETGet Campaign Report By Product
- GETGet Product Report
- GETGet Product Daily Report
- GETGet Marketplace Interactions Report
- GETGet Marketplace Report
- GETGet Marketplace Campaigns Kpis
- GETGet Marketplace Daily Report
- GETGet Marketplace Vendors Kpis
- GETGet Vendor Report
- GETGet Vendor Daily Report
Segments Service
Toppie API
- GET[BETA] Get Agency Account Balance
- GET[BETA] Get Agency Account Top-ups
- GET[BETA] Get Toppie Campaigns
- POST[BETA] Create Toppie Campaign
- GET[BETA] Get Toppie Campaign Details
- PATCH[BETA] Update Toppie Campaign
- GET[BETA] Get Toppie Campaign Bids
- GETList Account Products
- GETGet Agency Account Report
- GETGet Agency Account Activity
- GETGet Agency Account Campaigns
- GETGet Account Campaigns By Ids
- GETGet Agency Campaign Report
- GETGet Campaign Report Per Product
Get Campaigns
Endpoint to retrieve campaigns. Campaigns can be filtered by Vendor ID and status.
It is expected to use for getting all campaigns of a marketplace & all campaigns of a vendor in dashboards. Filtering by status is expected to use at review page getting campaigns approved, pending tabs.
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
The ID of the vendor. Omit to get campaigns for all vendors.
1
Filter by the approval status of banner campaigns.
approved
, pending
, rejected
The pagination offset.
x >= 0
The pagination limit.
0 <= x <= 100
Filter by active/inactive campaigns.
Optional sort by date of campaign creation.
asc
, desc
Response
The campaigns response.
An array of campaigns.
The campaign model.
The ad format of the campaign. Can be listing or banner.
listing
, banner
, exclusive_listing
, travel_listing
, flight_listing
The amount of active bids associated with this campaign.
The ID of the campaign.
The bidding method for the campaign.
manual
, autobidding
, exclusive
How campaigns are going to be charged, by click, by per mille impressions, or by action.
CPM
, CPC
, CPA
When was this campaign created.
The end date of the campaign.
The ID of the vendor. Deprecated. Use vendor_id instead.
1
Whether this campaign is active.
Whether this campaign is "smart".
The ID of the marketplace.
The name of the campaign.
1
"Bola-Bola Ad campaign"
The starting date of the campaign.
Represents the review status of a banner campaign.
approved
, pending
, rejected
The ID of the vendor.
1
The uuid of the wallet to be used with this campaign.
The budget assigned to the campaign.
The amount of money in the budget in minor units of currency according to ISO 4217.
0 < x < 20000000000
1000
The amount carried over from the last period.
The remaining amount of the budget.
The used amount of the budget.
The periodicity of the budget.
daily
, weekly
, monthly
, total
Deprecated. This field is always null. For behavioral data use reporting service.
Deprecated. This field is always null. For behavioral data use reporting service.
Daily price for an exclusive campaign, can only be set if a campaign is exclusive
The external ID of the campaign in the marketplace.
Whether this is a promoted shop campaign.
Deprecated. Use adFormat field instead and format properties inside bids. The promotion type and attributes. Ad format must set to 'banner' for exclusive campaigns.
banner
The assets for the banner campaign, if adFormat
is banner
.
Represents the banner resource file, it's location, mimetype, dimensions and size.
Asset id, if created using the asset API.
33
"asset_01j713j64yfsvtj4bs3ccpy5ca"
The mime type of the asset. If asset_id is provided, this field will be ignored.
1
"image/png"
The file size of the asset, in bytes. If asset_id is provided, this field will be ignored.
The url where the asset is located. If asset_id is provided, this field will be ignored.
1 - 2083
The external slot id provided by the marketplace.
1
The targeted device for this campaign, if adFormat
is banner
.
mobile
, desktop
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.
The target return on ad spend (ROAS) for this campaign. This is only applicable for autobidding listing campaigns.
Whether this is the last page of results or not.
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
}
}