Skip to content
Topsort Documentation
API

Get estimated clicks of a future campaign for a given vendor

POST
/v1/campaign-service/estimated-clicks

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

Get estimated clicks of a future campaign.

Authentication

Topsort’s APIs are authenticated via bearer tokens. Requests must include an authorization header containing your private API key.

Don't have an API key yet? Learn how to generate one.

Authorization
required
string

The header containing a private API key. Format this header as follows:

Authorization: Bearer <YOUR-API-KEY>

Query Parameters

object
vendor_id
required

The ID of the vendor to get estimated clicks.

string
>= 1 characters

The ID of the vendor to get estimated clicks.

Request Body

application/json
object
budget
required

The amount of money in the budget in minor units of currency according to ISO 4217.

integer format: int64
< 2000000000
budgetPeriod
required
string
Allowed values: daily weekly monthly total
isAutoBidding

Whether auto-bidding is enabled for the future campaign.

boolean
default: true
products
required

List of product details.

Array<object>
object
bidAmount

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

integer format: int64
categoryIds

Categories of the product to be sponsored using category based auctions.

Array<string>
default:
price
required

Product price in minor units of currency according to ISO 4217.

integer format: int64

Responses

Successful Response

application/json
object
estimatedClicks
required

Estimated number of clicks the campaign can get with the given budget.

integer