@font-face {
	font-family: Circular;
	font-style: normal;
	font-weight: bold;
	font-display: swap;
	src: url("https://docs.topsort.com/fonts/Circular/CircularStd-Bold.woff2") format("woff2");
}

@font-face {
	font-family: Circular;
	font-style: italic;
	font-weight: bold;
	font-display: swap;
	src: url("https://docs.topsort.com/fonts/Circular/CircularStd-BoldItalic.woff2") format("woff2");
}

h1, h2, h3, h4, h5, h6 {
    font-family: Circular, ui-sans-serif, sans-serif;
}

/* Logos same size as main docs site */
#navbar a[href="/"] img,
#navbar a[href="/"] img {
    max-width: 180px;
}

/* Hide the moved header nav on mobile and show on 'lg' screens */
#navbar > .max-w-8xl nav {
    display: none;
}

@media screen and (min-width: 1024px) {
    #navbar > .max-w-8xl nav {
        display: flex;
    }
}

/* Combined with the javascript, the below rules make the items the same order as on the main docs site */
#navbar > .max-w-8xl > div > div > div > div {
    justify-content: end;
}

#navbar > .max-w-8xl > div > div > div > div > .flex-1 {
    flex: none;
}

#navbar > .max-w-8xl > div > div > div > div > .ml-auto {
    margin-left: 0;
}

#navbar > .max-w-8xl > div > div > div > div > .mx-px {
    width: 25%;
    min-width: 120px;
}

#navbar > .max-w-8xl > div > div > div > div > div:first-child {
    margin-right: auto;
}

/* Hide the tabs bar */
#navbar > .max-w-8xl > div > .hidden {
    display: none;
}

/* Move up the sidebar because of hidden tabs */
#sidebar {
    top: 4rem;
}

/* Group headers in navigation sidebar look like the main docs site */
#navigation-items h5 {
    text-transform: uppercase;
    font-weight: normal;
    letter-spacing: 0.05em;
    font-size: 0.75rem;
    font-family: Inter, ui-sans-serif, sans-serif;
    color: rgb(134, 140, 152);
}

const logoContainer = document.querySelector("#navbar > .max-w-8xl > div > .relative > .flex > .h-full > div:first-child");
const navbar = document.querySelector("#navbar nav");
logoContainer.appendChild(navbar);

Starter Kit

API Reference

Integration Guide

Changelog

Knowledge Base

Endpoint to retrieve all campaign's bids.

Get Campaign Bids

Adformat

The assets for the banner campaign, if `adFormat` is `banner`.

Bannerassets

The targeted device for this campaign, if `adFormat` is `banner`.

The external slot id provided by the marketplace.

Slotid

BannerAd

Represents the banner resource file, it's location, mimetype, dimensions and size.

Contenttype

Size

BannerAsset

Represents an auction bid for a specific entity and a specific maximum amount.

Maximum amount of money willing to offer for a sponsored slot in minor units of currency according to ISO 4217.

Amount

Bidid

Deprecated. This field is always null. For behavioral data use reporting service.

Bidsbehaviordata

Campaignid

Isactive

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.

Location

The type of entity this bid will be targeting.

When should this bid participate in an auction.

Trigger

A list of objects that trigger the appearance of this bid on an auction.

Triggers

BidState

Catalog-based categories from a product.

Ideal for category product listing pages.
Not allowed for banner ads.

Type

CategoriesTrigger

Catalog-based category from a product.

Ideal for category product listing pages.

CategoryTrigger

The device where a banner ad should appear.

DeviceType

Height

Width

Dimensions

Represents a promotable entity that will be returned upon a winning auction.

Entity

EntityType

KeywordMatchType

Collection of keywords that match to a product.

Ideal for search results pages.

KeywordTrigger

Limit

How many items to skip from the beginning of the list.

Offset

NoContextTrigger

ProductTrigger

Message

Error Type

ValidationError

The ID of the product to retrieve categories from.

Fromproduct

Value

Categoryid

Words

Productid

HTTPBearer

The public response body of the bids endpoints.

PublicBidsResponse

HTTPValidationError

Introduction

Learn how to authenticate with Topsort APIs using a bearer token

Authentication

Errors encountered when using Topsort's API endpoints

Errors

Logs

Learn how to use the auctions API to create auctions for listings and banners.

Running auctons

Running auctions

How to run an auction for a set of products

Set of products

Search

Combining winners and organic results

Banners

Carousels and Swimlanes

Landing pages

Banners for sponsored brands

Learn how to use the auctions API to create listing auctions for sponsored brands.

Listings

Listings for sponsored brands

Create auctions

Create sponsored brand auctions

Report events

[BETA] Get Audiences

[BETA] Create Audience

[BETA] Get Audience

[BETA] Update Audience

[BETA] Delete Audience

Endpoint to get the credit limit for a marketplace.

Get Marketplace Credit Limit

Endpoint to set the credit limit for a marketplace.

Will truncate the input to its minimum denomination, e.g. USD 1,000.234 is USD 1,000.23 , as there is no fraction of a cent.

Set Marketplace Credit Limit

Endpoint to Get Vendor Charges.

Please note this is a beta API and therefore it is subject to change.

Get Vendor Charges

Endpoint to get the Account Activity for a vendor.

start_date and end_date timezone is optional, if no timezone is provided it will be converted to UTC timezone.

Get Vendor Account Activity

Endpoint to get the balance for a vendor.

Get Vendor Balance

Endpoint to add some balance for a vendor.

Will truncate the input to its minimum denomination, e.g. USD 1,000.234 is USD 1,000.23 , as there is no fraction of a cent.

Add Vendor Balance

Endpoint to burn some amount of balance for a vendor.

Burn Vendor Balance

Endpoint to get the credit History for a vendor.

Get Vendor Credit History

Endpoint to get the credit limit for a vendor.

Get Vendor Credit Limit

Endpoint to set the credit limit for a vendor.

Set Vendor Credit Limit

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.

Get Campaigns

Endpoint to create a campaign with its respective budget and bids.

It is expected to use at all types of campaign creations.

Create Campaign

Endpoint to retrieve specific campaign by Campaign ID.

It is expected to use at Campaign Page.

Get Campaign By Id

Delete Campaign By Id

Endpoint to update fields for a given campaign.

Update Campaign By Id

Create Campaign Bids

Delete Campaign Bid By Id

Update Campaign Bid By Id

Please note this is a beta API and therefore it is subject to change.

Get estimated clicks of a future campaign.

[BETA] Get estimated clicks of a future campaign for a given vendor

This endpoint returns paginated product ids currently in active campaigns.You can filter by vendor_id, fetching only from active campaigns and bids.

Get Products In Campaign

This endpoint is deprecated. Use /products-in-campaign instead.

Get Sponsored Products

Get Categories

Upsert Categories

Delete Categories

Gets the number of categories in the catalog.

Get Categories Count

Get Category

Get Products

Upsert Products

Delete Products

Gets the number of products in the catalog.

Get Products Count

Get Product

Get Vendors

Upsert Vendors

Delete vendors by ID.

This function won't error out when trying to delete vendors that don't exist.

Delete Vendors

Get Vendor

Invites a collection of Vendors to the Topsort platform.

The request payload should contain an array of pairs of vendor's ID, and
email.

[BETA] Invite Vendors

Provides a JWT token that allows to do operations on behalf of a vendor.

Get Vendor JWT

Endpoint to get a campaign's total behavioral summary report between given dates.

Get Campaign Report

Endpoint to get a campaign's daily behavioral summary report between given dates.

Get Campaign Daily Report

Endpoint to get a product's total behavioral summary report between given dates.

Get Product Report

Endpoint to get a product's daily behavioral summary report between given dates.

Get Product Daily Report

Endpoint to get a marketplace's total behavioral summary report between given dates.

Get Marketplace Report

Endpoint to get a marketplace's daily behavioral summary report between given dates.

General

Auction examples

Auctions

Events

Audience API

Billing API

Campaign API

Catalog API

Invitation API

Modal API

Reporting API

User API

Get Campaign Bids

Path Parameters

Query Parameters

Response