Auction examples
Webhook examples
Toppie API
- GET[BETA] Get Toppie Campaigns
- POST[BETA] Create Toppie Campaign
- GET[BETA] Get Agency Account Report.
- GET[BETA] Get Campaigns Reporting.
- GET[BETA] Account Activity Reports.
- GETGet Agency Daily Kpis By Product Dump Urls
- GET[BETA] List Account Products
- GET[BETA] Get Toppie Campaign Details
- DEL[BETA] Delete Toppie Campaign
- PATCH[BETA] Update Toppie Campaign
- GET[BETA] Get Toppie Campaign Bids
- GET[BETA] Get Campaign Report.
- GET[BETA] Get Campaign Products Report.
Campaign API
- GETGet Restriction Types
- GETGet Json Templates
- POSTCreate Json Template
- GETGet Campaigns
- POSTCreate Campaign
- POST[BETA] Get estimated clicks of a future campaign for a given vendordeprecated
- GETGet Sponsored Productsdeprecated
- GETGet Products In Campaign
- POST[BETA] Create exclusive listing campaign.
- POST[BETA] Create exclusive banner campaign.
- GETGet Campaign Restriction
- POSTCreate Campaign Restriction
- PATCHUpdate Campaign Restriction
- GETGet Restriction Type
- GETGet Json Template
- PATCHUpdate Json Template
- GETGet Campaign By Id
- DELDelete Campaign By Id
- PATCHUpdate Campaign By Id
- GETGet Campaign Bids
- POSTCreate Campaign Bids
- DELDelete All Bids From A Campaign
- DELDelete Campaign Bid By Id
- PATCHUpdate Campaign Bid By Id
- GETGet Campaign Products
- PUTUpsert Campaign Products
- GET[BETA] Get exclusive listing campaign by ID.
- PATCH[BETA] Update exclusive listing campaign by ID.
- GET[BETA] Get exclusive banner campaign by ID.
- PATCH[BETA] Update exclusive banner campaign by ID.
Catalog API
Billing API
- GETGet Marketplace Credit Limitdeprecated
- POSTSet Marketplace Credit Limitdeprecated
- GETGet Vendor Chargesdeprecated
- GETGet Billing Contacts
- PUTUpsert Vendor Billing Contact
- GETGet Campaign Billing Contact
- PUTUpsert Campaign Billing Contact
- GETGet Vendor Wallets
- POSTCreate Wallet
- GETGet Vendor Credit Limitdeprecated
- POSTSet Vendor Credit Limitdeprecated
- GETGet Vendor Credit Historydeprecated
- GETGet Vendor Account Activitydeprecated
- GETGet Vendor Balance
- POSTAdd Vendor Balance
- POSTBurn Vendor Balance
- POSTAdjust Wallet Balance
- GETGet Billing Contact
- PUTUpsert Billing Contact
- DELDelete Vendor Billing Contact
Reporting API
- GETGet Marketplace Report
- GETGet Marketplace Daily Report
- GETGet Marketplace Vendors Kpis
- GETGet Marketplace Campaigns Kpis
- GETGet Marketplace Interactions Report
- GETGet Scored Attribution Dump Urls
- GETGet Interactions Dump Urls
- GETGet Vendor Report
- GETGet Vendor Daily Report
- GETGet Campaign Report
- GETGet Campaign Daily Report
- GETGet Product Daily Report
- GETGet Campaign Report By Product
- GETGet Product Report
Invitation API
Assets API
Segments Service
Offsite Ads API
- POSTCreate a new advertiser
- GETGet vendor offsite campaigns
- POSTCreate Campaign
- GETList Audiences
- POST[BETA] Create offsite user list audience job.
- PUTUpsert Advertiser Domain
- GETGet Job Status
- GETGet advertiser onboarding state for a specific DSP
- GETGet campaign information
- PATCHUpdate Campaign
- GETGet Campaign Products Report
- GETGet Campaign Aggregated Report
- GETGet Campaign Daily Report
Forecasting Service
API Reference
Get advertiser onboarding state for a specific DSP
Copy
Ask AI
curl --request GET \
--url https://api.topsort.com/public/v1/offsite-ads/advertisers/{vendor-id} \
--header 'Authorization: Bearer <token>'Copy
Ask AI
{
"vendorId": "<string>",
"dspOnboardingStatus": {
"dsp": "google_ads",
"status": "not_started",
"lastUpdated": "2023-11-07T05:31:56Z"
}
}Offsite Ads API
Get advertiser onboarding state for a specific DSP
Get advertiser onboarding state for a specific DSP.
GET
/
public
/
v1
/
offsite-ads
/
advertisers
/
{vendor-id}
Get advertiser onboarding state for a specific DSP
Copy
Ask AI
curl --request GET \
--url https://api.topsort.com/public/v1/offsite-ads/advertisers/{vendor-id} \
--header 'Authorization: Bearer <token>'Copy
Ask AI
{
"vendorId": "<string>",
"dspOnboardingStatus": {
"dsp": "google_ads",
"status": "not_started",
"lastUpdated": "2023-11-07T05:31:56Z"
}
}Authorizations
A valid API key generated in Topsort's UI.
Path Parameters
Vendor ID associated with the advertiser.
Query Parameters
The DSP to get the advertiser info for.
Available options:
google_ads, meta Response
Successful Response
The vendor ID that is going to be onboarded.
The onboarding status for each DSP.
Show child attributes
Show child attributes
The Demand-Side Platform (DSP) associated with the campaign
Available options:
google_ads, meta The onboarding status for each DSP.
Available options:
not_started, in_progress, completed, failed When the status was last updated.
Was this page helpful?
⌘I