GET
/
public
/
v1
/
campaign-service
/
products-in-campaign
Get Products In Campaign
curl --request GET \
  --url https://api.topsort.com/public/v1/campaign-service/products-in-campaign \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "nextPage": "SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo=",
  "productsInCampaign": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

A valid API key generated in Topsort's UI.

Query Parameters

​
vendor_id
string

The ID of the vendor to get sponsored products.

​
next_page
string

A token provided in a previous response. If not empty, it is used to retrieve the page that follows.

​
limit
integer
default:100

The pagination limit.

Required range: 0 < x <= 100
​
look_ahead_hours
integer
default:0

Include products whose campaigns are scheduled to start within the N next given hours.

​
fetch_active_products
boolean
default:false

Whether to fetch only active products. If false, all products will be fetched even if the campaign or the bid are inactive.

Response

Successful Response

Scrolled response for products in campaign.

​
hasMore
boolean
required

Flag that indicates whether more results are available. true indicates there is a next page of results. false indicates this response contains the last page of results.

​
productsInCampaign
string[]
required

List of sponsored product ids.

​
nextPage
string

Pagination cursor. Provide this value as a next_page query parameter in a new request to retrieve the next page of results.

Minimum length: 1
Example:

"SSBzb2xlbW5seSBzd2VhciB0aGF0IEkgYW0gdXAgdG8gbm8gZ29vZAo="