Skip to main content

Starter Kit home page

Integration Guide
Changelog
Knowledge Base

General

Introduction
Authentication
Errors
Logs

Auction examples

Running auctions
Sponsored brands

Asset examples

Create

Webhook examples

Using webhooks
Webhook event & payloads

Auctions

POST
Create auctions
POST
Create sponsored brand auctions
POST
Create travel auctions

Events

POST
Report events
POST
[Beta] Report Link Users

Toptimize

POST
[Beta] Rank objects
POST
[Beta] Add Quality Score
POST
[Beta] Retrieve objects

Assets API

POST
Create Asset
GET
Get Asset
DEL
Delete Asset
PATCH
Update Asset
GET
Get Assets
POST
[BETA] Create Collection
GET
[BETA] Get Collection
DEL
[BETA] Delete Collection
PATCH
[BETA] Update Collection
GET
[BETA] Get Collections

Billing API

GET
Get Billing Contacts
GET
Get Billing Contact
PUT
Upsert Billing Contact
GET
Get Campaign Billing Contact
PUT
Upsert Campaign Billing Contact
GET
Get Marketplace Credit Limit
deprecated
POST
Set Marketplace Credit Limit
deprecated
PUT
Upsert Vendor Billing Contact
GET
Get Vendor Charges
deprecated
GET
Get Vendor Account Activity
deprecated
GET
Get Vendor Balance
POST
Add Vendor Balance
POST
Burn Vendor Balance
GET
Get Vendor Credit History
deprecated
GET
Get Vendor Credit Limit
deprecated
POST
Set Vendor Credit Limit
deprecated
DEL
Delete Vendor Billing Contact
GET
Get Vendor Wallets
POST
Create Wallet
POST
Adjust Wallet Balance

Campaign API

GET
Get Campaigns
POST
Create Campaign
POST
[BETA] Create exclusive banner campaign.
GET
[BETA] Get exclusive banner campaign by ID.
PATCH
[BETA] Update exclusive banner campaign by ID.
POST
[BETA] Create exclusive listing campaign.
GET
[BETA] Get exclusive listing campaign by ID.
PATCH
[BETA] Update exclusive listing campaign by ID.
GET
Get Campaign By Id
DEL
Delete Campaign By Id
PATCH
Update Campaign By Id
GET
Get Campaign Bids
POST
Create Campaign Bids
DEL
Delete All Bids From A Campaign
DEL
Delete Campaign Bid By Id
PATCH
Update Campaign Bid By Id
GET
Get Campaign Products
PUT
Upsert Campaign Products
GET
Get Campaign Restriction
POST
Create Campaign Restriction
PATCH
Update Campaign Restriction
POST
[BETA] Get estimated clicks of a future campaign for a given vendor
deprecated
GET
Get Json Templates
POST
Create Json Template
GET
Get Json Template
PATCH
Update Json Template
GET
Get Products In Campaign
GET
Get Restriction Types
GET
Get Restriction Type
GET
Get Sponsored Products
deprecated

Catalog API

GET
Get Categories
PUT
Upsert Categories
DEL
Delete Categories
GET
Get Categories Count
GET
Get Category
GET
Get Products
PUT
Upsert Products
DEL
Delete Products
PATCH
Update Products
GET
Get Products Count
GET
Get Product
GET
Get Vendors
PUT
Upsert Vendors
DEL
Delete Vendors
GET
Get Vendor

Invitation API

POST
[BETA] Invite Vendors

Media API

GET
Get Slots
POST
Create Slot
DEL
Delete Slot
PATCH
Toggle Slot
DEL
Delete Banner Fallback

Offsite Ads API

PUT
Upsert Advertiser Domain
POST
Create a new advertiser
GET
Get advertiser onboarding state for a specific DSP
GET
List Audiences
POST
[BETA] Create offsite audience job.
GET
Get vendor offsite campaigns
POST
Create Campaign
GET
Get campaign information
PATCH
Update Campaign
GET
Get Job Status
GET
Get Campaign Aggregated Report
GET
Get Campaign Daily Report
GET
Get Campaign Products Report

Reporting API

GET
Get Campaign Report
GET
Get Campaign Daily Report
GET
Get Campaign Report By Product
GET
Get Product Report
GET
Get Product Daily Report
GET
Get Interactions Dump Urls
GET
Get Scored Attribution Dump Urls
GET
Get Marketplace Interactions Report
GET
Get Marketplace Report
GET
Get Marketplace Campaigns Kpis
GET
Get Marketplace Daily Report
GET
Get Marketplace Vendors Kpis
GET
Get Vendor Report
GET
Get Vendor Daily Report

Segments Service

GET
[BETA] Retrieve a list of segments.
PUT
[BETA] Upsert segments with the provided information.
DEL
[BETA] Delete a segment.
GET
[BETA] Get upload users signed url for a segment.
POST
[BETA] Upload users to a segment.

Toppie API

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 Campaign Report.
GET
[BETA] Get Campaign Products Report.
GET
Get Agency Daily Kpis By Product Dump Urls

Forecasting Service

POST
[BETA] Campaign-level Forecasts
POST
[BETA] Inventory-level Forecasts
GET
[BETA] Marketplace-level Forecasts

User API

GET
Get User By Email
PUT
Update User
POST
Create User

Webhooks API

GET
Get Webhooks
POST
Create Webhook
GET
Get Webhook
DEL
Delete Webhook
PATCH
Update Webhook

API Reference

HOOK
Endpoint to notify events generated in topsort

General

Logs

Topsort API developer logs

In staging, all API responses are available in logs and in production as API usage ramps up only errors are shown.

Schema validator notification screenshot

Schema validator error screenshot

Was this page helpful?

Errors Running auctions

⌘I

Powered by Mintlify

Assistant

Responses are generated using AI and may contain mistakes.