Auction examples
- Running auctions
- Sponsored listings
- Sponsored banners
- Sponsored brands
Asset examples
Webhook examples
Toptimize
Offsite Ads API
- POST[BETA] Create a new advertiser
- GET[BETA] Get advertiser details
- GET[BETA] List all audiences
- POST[BETA] Create a new audience
- POST[BETA] Upload users to an audience
- GET[BETA] List all campaigns
- POST[BETA] Create a new campaign
- GET[BETA] Get campaign details
- PATCH[BETA] Update campaign settings
- GET[BETA] Get campaign geotargeting settings
- GET[BETA] Get Job Status
- GET[BETA] Get campaign performance summary
- GET[BETA] Get daily campaign performance report
- GET[BETA] Get product-level campaign performance report
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
- GETGet Campaign Restriction
- POSTCreate Campaign Restriction
- PATCHUpdate Campaign Restriction
- POST[BETA] Get estimated clicks of a future campaign for a given vendor
- GETGet Products In Campaign
- GETGet Restriction Types
- GETGet Restriction Type
- 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 Scored Attribution Dump Urls
- 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
- DEL[BETA] Delete Toppie Campaign
- PATCH[BETA] Update Toppie Campaign
- GET[BETA] Get Toppie Campaign Bids
- GET[BETA] List Account Products
- GET[BETA] Get Agency Account Report.
- GET[BETA] Account Activity Reports.
- GET[BETA] Get Campaigns Reporting.
- GET[BETA] Get Campaigns by IDs report.
- GET[BETA] Get Campaign Report.
- GET[BETA] Get Campaign Products Report.
Get Campaign Bids
Endpoint to retrieve all campaign’s bids.
curl --request GET \
--url https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign-id}/bids{
"bids": [
{
"amount": 1,
"bidId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bidsBehaviorData": "<string>",
"campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"formatProperties": {
"adFormat": "banner",
"bannerAssets": [
{
"assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
"contentType": "image/png",
"dimensions": {
"height": 1080,
"width": 1920
},
"size": 123,
"url": "<string>"
}
],
"deviceType": "desktop",
"slotId": "<string>"
},
"isActive": true,
"location": "Santiago",
"state": "active",
"target": {
"id": "p_8983",
"type": "product"
},
"trigger": {
"type": "keyword",
"value": {
"matchType": "exact",
"words": [
"<string>"
]
}
},
"triggers": [
{
"type": "keyword",
"value": {
"matchType": "exact",
"words": [
"<string>"
]
}
}
]
}
],
"hasMore": true,
"next": {
"limit": 123,
"offset": 123
}
}Path Parameters
The ID of the campaign.
Query Parameters
The pagination offset.
x >= 0The pagination limit.
0 <= x <= 100Response
The public response body of the bids endpoints.
An array of bids.
Represents an auction bid for a specific entity and a specific maximum amount.
The ID of the bid
The ID of the campaign.
Whether the bid is active.
The activity state of the bid.
active, deactivated_manually, inactive_entity, deleted_entity, legacy_inactive A list of objects that trigger the appearance of this bid on an auction.
When should this bid participate in an auction.
Maximum amount of money willing to offer for a sponsored slot in minor units of currency according to ISO 4217.
x > 0Deprecated. This field is always null. For behavioral data use reporting service.
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 - 2083The external slot id provided by the marketplace.
1The targeted device for this campaign, if adFormat is banner.
mobile, desktop By using this option you will be able to target this campaign to a specific group.You must define the same location as a parameter on the auction request. Products on a specific campaign will have specific conversion rates, considering the context of location, so it will not interfere with the conversion rates for the same product in other campaigns.
1"Santiago"
Whether this is the last page of results or not.
curl --request GET \
--url https://api.topsort.com/public/v1/campaign-service/campaigns/{campaign-id}/bids{
"bids": [
{
"amount": 1,
"bidId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"bidsBehaviorData": "<string>",
"campaignId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"formatProperties": {
"adFormat": "banner",
"bannerAssets": [
{
"assetId": "asset_01j713j64yfsvtj4bs3ccpy5ca",
"contentType": "image/png",
"dimensions": {
"height": 1080,
"width": 1920
},
"size": 123,
"url": "<string>"
}
],
"deviceType": "desktop",
"slotId": "<string>"
},
"isActive": true,
"location": "Santiago",
"state": "active",
"target": {
"id": "p_8983",
"type": "product"
},
"trigger": {
"type": "keyword",
"value": {
"matchType": "exact",
"words": [
"<string>"
]
}
},
"triggers": [
{
"type": "keyword",
"value": {
"matchType": "exact",
"words": [
"<string>"
]
}
}
]
}
],
"hasMore": true,
"next": {
"limit": 123,
"offset": 123
}
}