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,
"isAutoTrigger": true,
"isSmart": true,
"marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Bola-Bola Ad campaign",
"promotionType": {
"adFormat": "banner",
"bannerAssets": [
{
"assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
"content": {},
"contentType": "image/png",
"dimensions": {
"height": 1080,
"width": 1920
},
"jsonTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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
}
}
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,
"isAutoTrigger": true,
"isSmart": true,
"marketplaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Bola-Bola Ad campaign",
"promotionType": {
"adFormat": "banner",
"bannerAssets": [
{
"assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
"content": {},
"contentType": "image/png",
"dimensions": {
"height": 1080,
"width": 1920
},
"jsonTemplateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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
}
}
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.
Filter by external campaign ID.
Optional sort by date of campaign creation. Deprecated. Use order_by instead.
asc
, desc
Comma-separated order by clauses, e.g. 'created_at:asc,name:desc'. Supported dimensions: created_at, start_date, end_date, name, campaign_id.
Successful Response
The campaigns response.