Skip to main content
GET
Offer orders

Авторизации

X-API-Key
string
header
обязательно

Your API key from the Studio Dashboard

Параметры пути

id
integer
обязательно

Numeric resource id.

Требуемый диапазон: x >= 1

Параметры запроса

page
integer
по умолчанию:1

Page number, 1-indexed.

Требуемый диапазон: x >= 1
page_size
integer
по умолчанию:25
Требуемый диапазон: 1 <= x <= 100
sort
enum<string>
по умолчанию:date_desc

Sort order.

  • date_desc: newest orders first (by campaign end date; default).
  • date_asc: oldest orders first.
  • price_desc: highest price first.
  • price_asc: lowest price first.
  • romi_desc: best return on marketing investment first. Orders where ROMI is hidden (either party opted out) always sort to the bottom; if the offer hides ROMI globally, the API falls back to date_desc.
  • dialogs_desc: most dialogs (3-message threshold) first.
Доступные опции:
date_desc,
date_asc,
price_desc,
price_asc,
romi_desc,
dialogs_desc

Ответ

Successful response. Capped at the 500 most-recent matching rows; pagination.total reflects that cap, not the absolute count of orders ever placed on this offer.

success
boolean
Пример:

true

data
object[]
pagination
object

Page-based pagination, returned by every list endpoint that isn't a cursor feed.