Получение списка заказов

  1. HTTP-запрос
  2. Query-параметры
  3. Ответы
    1. Код 200
      1. Представление
      2. Поля
  4. Пример

Возвращает список заказов. Также поддерживается метод POST. Чтобы получить список заказов в формате CSV, используйте эндпоинт /v2/order/list/csv.

HTTP-запрос

GET /v2/order/list\
?apiKey={string}\
&counter={string}\
&dimensions={array}\
&filter={string}\
&itemsPerPage={integer}\
&page={integer}

Query-параметры

apiKey *

string

Токен для авторизации.

counter *

string

Идентификатор счетчика, с которого будет снята статистика.

dimensions *

array

Массив измерений для выгрузки.

filter

string

Правила фильтрации результатов поиска.

itemsPerPage

integer

Число результатов на страницу.

page

integer

Порядковый номер страницы ответа.

apiKey *

string

Токен для авторизации.

counter *

string

Идентификатор счетчика, с которого будет снята статистика.

dimensions *

array

Массив измерений для выгрузки.

filter

string

Правила фильтрации результатов поиска.

itemsPerPage

integer

Число результатов на страницу.

page

integer

Порядковый номер страницы ответа.

Ответы

Код 200

Возвращает список заказов.

{
  "nextLink": string,
  "result": {},
  "totalResults": integer
}
Скопировано

Представление

Свернуть всё
Развернуть всё

Поля

nextLink

string

Ссылка на следующую страницу выдачи.

result

object

Статистика по заказам.

result.analyticsClientId

string

Google Analytics client id.

result.browser

string

Браузер.

result.browserVersion

string

Версия браузера.

result.callerPhone

string

Номер телефона, привязанный к заказу.

result.city

string

Город на основе IP.

result.comment

string

Комментарий к заказу.

result.compositeKeyword

string

Ключевое слово.

result.compositeSource

string

Источник.

result.compositeSourceType

string

Тип трафика.

result.contactPerson

string

Контактное лицо.

result.country

string

Страна на основе IP.

result.customDimension1

string

Пользовательское измерение 1.

result.customDimension2

string

Пользовательское измерение 2.

result.customDimension3

string

Пользовательское измерение 3.

result.customDimension4

string

Пользовательское измерение 4.

result.customDimension5

string

Пользовательское измерение 5.

result.dateTime

string

Дата и время заказа.

result.deviceName

string

Название устройства.

result.deviceType

string

Тип устройства.

result.district

string

Округ на основе IP.

result.email

string

Электронная почта контактного лица.

result.entryPoint

string

Страницы входа.

result.externalUserId

string

Внешний идентификатор пользователя.

result.gClid

string

Метка gclid.

result.ip

string

IP адрес пользователя.

result.lDomain

string

Домен страницы входа.

result.label

string

Параметр label.

result.margin

string

Прибыль заказа.

result.metrikaClientId

string

Yandex metrika client id.

result.orderId

string

Идентификатор заказа.

result.outPoint

string

Страницы выхода.

result.platformDescription

string

Операционная система.

result.rDomain

string

Домен реферера.

result.rTerm

string

Поисковый запрос.

result.region

string

Регион на основе IP.

result.revenue

string

Доход заказа.

result.sid

string

Идентификатор сеанса, связанного с заказом.

result.tags[] *

array

Список тегов для заказа.

result.type

boolean

Тип заказа: online - заказ с сайта, offline - заказ со звонка.

result.userAgent

string

UserAgent пользователя.

result.utmCampaign

string

Метка utm_campaign.

result.utmContent

string

Метка utm_content.

result.utmMedium

string

Метка utm_medium.

result.utmSource

string

Метка utm_source.

result.utmTerm

string

Метка utm_term.

result.uuid

string

Идентификатор пользователя.

result.yClid

string

Метка yclid.

totalResults

integer

Всего заказов в выдаче.

nextLink

string

Ссылка на следующую страницу выдачи.

result

object

Статистика по заказам.

result.analyticsClientId

string

Google Analytics client id.

result.browser

string

Браузер.

result.browserVersion

string

Версия браузера.

result.callerPhone

string

Номер телефона, привязанный к заказу.

result.city

string

Город на основе IP.

result.comment

string

Комментарий к заказу.

result.compositeKeyword

string

Ключевое слово.

result.compositeSource

string

Источник.

result.compositeSourceType

string

Тип трафика.

result.contactPerson

string

Контактное лицо.

result.country

string

Страна на основе IP.

result.customDimension1

string

Пользовательское измерение 1.

result.customDimension2

string

Пользовательское измерение 2.

result.customDimension3

string

Пользовательское измерение 3.

result.customDimension4

string

Пользовательское измерение 4.

result.customDimension5

string

Пользовательское измерение 5.

result.dateTime

string

Дата и время заказа.

result.deviceName

string

Название устройства.

result.deviceType

string

Тип устройства.

result.district

string

Округ на основе IP.

result.email

string

Электронная почта контактного лица.

result.entryPoint

string

Страницы входа.

result.externalUserId

string

Внешний идентификатор пользователя.

result.gClid

string

Метка gclid.

result.ip

string

IP адрес пользователя.

result.lDomain

string

Домен страницы входа.

result.label

string

Параметр label.

result.margin

string

Прибыль заказа.

result.metrikaClientId

string

Yandex metrika client id.

result.orderId

string

Идентификатор заказа.

result.outPoint

string

Страницы выхода.

result.platformDescription

string

Операционная система.

result.rDomain

string

Домен реферера.

result.rTerm

string

Поисковый запрос.

result.region

string

Регион на основе IP.

result.revenue

string

Доход заказа.

result.sid

string

Идентификатор сеанса, связанного с заказом.

result.tags[] *

array

Список тегов для заказа.

result.type

boolean

Тип заказа: online - заказ с сайта, offline - заказ со звонка.

result.userAgent

string

UserAgent пользователя.

result.utmCampaign

string

Метка utm_campaign.

result.utmContent

string

Метка utm_content.

result.utmMedium

string

Метка utm_medium.

result.utmSource

string

Метка utm_source.

result.utmTerm

string

Метка utm_term.

result.uuid

string

Идентификатор пользователя.

result.yClid

string

Метка yclid.

totalResults

integer

Всего заказов в выдаче.

Пример

Responses:

{
  "totalResults": 8
}
Скопировано