Get Campaigns
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.
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.
The header containing a private API key. Format this header as follows:
Authorization: Bearer <YOUR-API-KEY>
Query Parameters
object
The ID of the vendor. Omit to get campaigns for all vendors.
The ID of the vendor. Omit to get campaigns for all vendors.
Filter by the approval status of banner campaigns.
Filter by the approval status of banner campaigns.
The pagination offset.
The pagination offset.
The pagination limit.
The pagination limit.
Filter by active/inactive campaigns.
Filter by active/inactive campaigns.
Optional sort by date of campaign creation.
Optional sort by date of campaign creation.
Responses
Successful Response
The campaigns response.
object
An array of campaigns.
The campaign model.
object
The ad format of the campaign. Can be listing or banner.
The amount of active bids associated with this campaign.
The budget assigned to the campaign.
object
The amount of money in the budget in minor units of currency according to ISO 4217.
The amount carried over from the last period.
The remaining amount of the budget.
The used amount of the budget.
Deprecated. This field is always null. For behavioral data use reporting service.
Deprecated. This field is always null. For behavioral data use reporting service.
The ID of the campaign.
The bidding method for the campaign.
How campaigns are going to be charged, by click or by per mille impressions
When was this campaign created.
The end date of the campaign.
Daily price for an exclusive campaign, can only be set if a campaign is exclusive
The ID of the vendor. Deprecated. Use vendor_id instead.
Whether this campaign is active.
Whether this campaign is “smart”.
Whether this is a promoted shop campaign.
The ID of the marketplace.
The name of the campaign.
object
The assets for the banner campaign, if adFormat is banner.
Represents the banner resource file, it’s location, mimetype, dimensions and size.
object
The mime type of the asset.
The width and height of an asset.
object
The height of the image.
The width of the image.
The file size of the asset, in bytes.
The url where the asset is located.
The targeted device for this campaign, if adFormat is banner.
The external slot id provided by the marketplace.
object
The starting date of the campaign.
Represents the review status of a banner campaign.
The ID of the user who reviewed the campaign. If it’s null and the status is not "pending" then it means this campaign has autoapproval status.
The target return on ad spend (ROAS) for this campaign. This is only applicable for autobidding listing campaigns.
The ID of the vendor.
The uuid of the wallet to be used with this campaign.
Whether this is the last page of results or not.
The parameters that should be used to fetch the next page.
object
How many items to return.
How many items to skip from the beginning of the list.
Validation Error