Toppie API

[BETA] Create Toppie Campaign

Create a new agency campaign with the provided details.

post/public/v1/toppie/campaigns

Request

  • Base URL: https://api.topsort.com
  • URL: https://api.topsort.com/public/v1/toppie/campaigns
  • Auth: HTTP bearer

Request body

namestring required

Campaign name, this will be propagated to campaigns in marketplaces

budgetinteger required

Total budget for this campaign, to be distributed across marketplaces

budgetPeriod'daily' | 'weekly' | 'monthly' | 'total'

The periodicity of the budget.

targetsstring[] required

List of targets for the campaign

startDatestring date-time

Date when to start the campaign, specified in RFC 3339, if not set that campaign will start immediately after the campaign creation. Must include the Timezone definition.

endDatestring date-time

Date when to stop the campaign, specified in RFC 3339, if not set the campaign will never stop. This date must be greater than the start date and must be in the future. Must include the Timezone definition.

targetRoasnumber required

Target ROAS for the campaign

Response

Successful Response

idstring uuid required

Internal identifier for the agency campaign

namestring required

Campaign name

adFormat'banner' | 'listing' required
chargeType'CPM' | 'CPC' | 'CPA' required

Campaign charge type.

CPM: cost per mille impressions CPC: cost per click CPA: cost per action. CPA reflects the total cost to achieve a conversion.

accountIdstring uuid required

Account that owns this campaign

budgetinteger required

Total budget for this campaign

bidCountinteger nullable

Bid count for the campaign (optional)

budgetPeriod'daily' | 'weekly' | 'monthly' | 'total' required

The periodicity of the budget.

startDatestring date-time required

Date when the campaign starts, specified in RFC 3339. Must include the Timezone definition.

endDatestring date-time required

Date when the campaign ends, specified in RFC 3339. Must include the Timezone definition.

targetRoasnumber required

Target ROAS for the campaign

currencyCodestring required

Currency code this campaign is working with in ISO 4217 format

isActiveboolean required

Flag to indicate if the campaign is active or not

createdAtstring date-time required

Date and time when the campaign was created

Example response

{
  "currencyCode": "USD"
}

Changes

No recorded changes to this operation across all 1 revision of this API.