← К справке Документация GetCourse

Поля API GetCourse

Export API · Пользователи, группы, заказы и платежи

https://{account}.getcourse.ru/pl/api/account

Для выгрузки передайте ключ API и хотя бы один фильтр. Даты в фильтрах задаются в формате YYYY-MM-DD. После запуска заберите результат по ID выгрузки. Список групп возвращается отдельным запросом.

Поля экспорта приведены по документации GetCourse.

Записей в справочнике — 148

Методы и получение выгрузки

ПолеОписание
GET /pl/api/account/usersЗапускает выгрузку пользователей.
GET /pl/api/account/groupsВозвращает список групп.
GET /pl/api/account/groups/{ID}/usersЗапускает выгрузку пользователей указанной группы.
GET /pl/api/account/dealsЗапускает выгрузку заказов.
GET /pl/api/account/paymentsЗапускает выгрузку платежей.
GET /pl/api/account/exports/{export_id}Проверяет готовность экспорта и возвращает данные в JSON.
POST /pl/api/account/fieldsВозвращает справочники дополнительных полей пользователей и заказов. Передайте key и action=get в форме.
keyСекретный ключ API аккаунта.
{ID}ID группы в пути запроса.
{export_id}Идентификатор выгрузки, полученный при её запуске.

Источник GetCourse

Фильтры пользователей

ПолеОписание
created_at[from]Начальная дата регистрации, YYYY-MM-DD.
created_at[to]Конечная дата регистрации, YYYY-MM-DD.
statusСтатус пользователя. Допустимы active и in_base.
emailОдин или несколько адресов электронной почты через запятую.
idgrouplistДополнительный параметр. id добавляет список ID групп, id_date добавляет ID и даты вступления. Для запуска нужен отдельный фильтр.

Источник GetCourse

Фильтры пользователей группы

ПолеОписание
created_at[from]Начальная дата создания пользователей группы, YYYY-MM-DD.
created_at[to]Конечная дата создания пользователей группы, YYYY-MM-DD.
statusСтатус пользователя. Допустимы active и in_base.
added_at[from]Начальная дата включения в группу, YYYY-MM-DD.
added_at[to]Конечная дата включения в группу, YYYY-MM-DD.

Источник GetCourse

Фильтры заказов

ПолеОписание
created_at[from]Начальная дата создания заказов.
created_at[to]Конечная дата создания заказов.
payed_at[from]Начальная дата оплаты.
payed_at[to]Конечная дата оплаты.
finished_at[from]Начальная дата завершения.
finished_at[to]Конечная дата завершения.
status_changed_at[from]Начальная дата изменения статуса заказа.
status_changed_at[to]Конечная дата изменения статуса заказа.
statusДопустимые значения: new, payed, cancelled, in_work, payment_waiting, part_payed, waiting_for_return, not_confirmed, pending.
user_in_groupID группы, к которой относятся покупатели.
user_idОдин или несколько ID покупателей через запятую.

Источник GetCourse

Фильтры платежей

ПолеОписание
created_at[from]Начальная дата создания платежей.
created_at[to]Конечная дата создания платежей.
status_changed_at[from]Начальная дата изменения статуса платежа.
status_changed_at[to]Конечная дата изменения статуса платежа.
statusДопустимые значения: expected, accepted, returned, tobalance, frombalance, returned_to_balance.

Источник GetCourse

Поля групп

ПолеОписание
idИдентификатор группы.
nameНазвание группы.
last_added_atДата и время последнего добавления в группу. Если группу ещё никто не пополнял, значение null.

Источник GetCourse

Столбцы пользователей

ПолеОписание
idИдентификатор пользователя.
EmailЭлектронная почта профиля.
Тип регистрацииСпособ появления пользователя в аккаунте.
СозданДата создания профиля.
Последняя активностьКогда пользователь был активен в последний раз.
ИмяИмя профиля.
ФамилияФамилия профиля.
ТелефонТелефон из профиля.
Дата рожденияДата рождения в профиле.
ВозрастВозраст пользователя.
СтранаСтрана пользователя.
ГородГород пользователя.
От партнераПартнёр, связанный с привлечением пользователя.
Дополнительные поля пользователейНазвания и значения полей, настроенных в аккаунте.
Откуда пришелИсточник перехода.
utm_sourceИсточник трафика.
utm_mediumКанал трафика.
utm_campaignНазвание или идентификатор рекламной кампании.
utm_termКлючевое слово или другая метка таргетинга.
utm_contentМетка объявления или варианта объявления.
utm_groupМетка группы.
ID партнераИдентификатор партнёра.
Email партнераАдрес электронной почты партнёра.
ФИО партнераИмя партнёра.
ФИО персонального менеджераИмя закреплённого сотрудника.
VK-IDИдентификатор профиля ВКонтакте.
id групп пользователяСписок ID групп при idgrouplist=id.
id групп пользователя/дата добавленияСписок ID групп и дат включения при idgrouplist=id_date.
ID группыИдентификатор группы при выгрузке через groups/{ID}/users.
Добавлен в группуДата и время добавления при выгрузке через groups/{ID}/users.

Источник GetCourse

Столбцы заказов

ПолеОписание
ID заказаВнутренний идентификатор заказа.
НомерНомер заказа в интерфейсе.
ID пользователяВнутренний идентификатор покупателя.
ПользовательИмя покупателя.
EmailАдрес электронной почты покупателя.
ТелефонТелефон покупателя.
Дата созданияКогда заказ был создан.
Дата оплатыКогда была зафиксирована оплата.
Состав заказаПозиции заказа.
СтатусТекущее состояние заказа.
Стоимость, RUBСтоимость заказа в рублях.
ОплаченоСумма оплаты.
Комиссия платежной системыСумма комиссии провайдера оплаты.
ПолученоСумма поступления по заказу.
НалогСумма налога по заказу.
Осталось после вычета комиссии платежной системы и налогаОстаток после двух указанных удержаний.
Другие комиссииПрочие комиссии по заказу.
ЗаработаноИтоговый заработок по данным GetCourse.
ВалютаВалюта заказа.
МенеджерСотрудник, закреплённый за заказом.
ГородГород покупателя.
Платежная системаПровайдер оплаты.
ID партнераИдентификатор партнёра.
Использован промокодДанные об использованном промокоде.
ПромоакцияАкция, применённая к заказу.
Дополнительные поля заказаПоля, заданные в настройках аккаунта.
ID партнера заказаИдентификатор партнёра по заказу.
Email партнера заказаЭлектронная почта партнёра по заказу.
ФИО партнера заказаИмя партнёра по заказу.
ID партнера пользователяИдентификатор партнёра, закреплённого за покупателем.
Email партнера пользователяЭлектронная почта партнёра покупателя.
ФИО партнера пользователяИмя партнёра покупателя.
utm_sourceИсточник трафика заказа.
utm_mediumКанал трафика заказа.
utm_campaignМетка рекламной кампании заказа.
utm_contentМетка объявления заказа.
utm_termКлючевое слово или метка таргетинга заказа.
utm_groupМетка группы для заказа.
Партнерский источникИсточник партнёрского перехода.
Партнерский кодКод партнёрской атрибуции.
Партнер (сессия)Партнёр, связанный с сессией.
user_utm_sourceИсточник трафика из данных пользователя.
user_utm_mediumКанал трафика из данных пользователя.
user_utm_campaignМетка кампании из данных пользователя.
user_utm_contentМетка объявления из данных пользователя.
user_utm_termКлючевое слово или метка таргетинга из данных пользователя.
user_utm_groupМетка группы из данных пользователя.
user_gcpcЗначение gcpc из данных пользователя.
ТегиТеги заказа, разделены вертикальной чертой.
Теги предложенийТеги предложений заказа, разделены вертикальной чертой.
Дата измененияКогда заказ изменился в последний раз.
Статус измененКогда последний раз изменился статус.
ОплаченПризнак оплаты заказа.
БесплатныйПризнак бесплатного заказа.
Причина отказаУказанная причина отказа.
Комментарий к причине отказаПояснение к причине отказа.
GetCourse Pay: Статус рассрочкиСостояние рассрочки через GetCourse Pay.
Клиент: денег принесСумма, которую принёс покупатель.
Клиент: оплачено заказовКоличество оплаченных заказов покупателя.
СтранаСтрана покупателя.
Комментарий к клиентуПримечание из карточки покупателя.
Статус подписки клиентаСостояние подписки покупателя.
Клиент: дата регистрацииКогда покупатель зарегистрировался.
Клиент: давность регистрацииСколько времени прошло с регистрации.
Клиент: давность последней активностиСколько времени прошло с последней активности.
Клиент: дата последней активностиКогда покупатель был активен в последний раз.
ЗадачиСвязанные задачи в формате [статус] название.

Источник GetCourse

Столбцы платежей

ПолеОписание
Номер платежаНомер записи о платеже.
ПользовательИмя плательщика.
E-MailЭлектронная почта плательщика.
ЗаказСвязанный заказ.
Дата созданияКогда запись о платеже была создана.
Тип платежаСпособ оплаты или платёжная система.
СтатусСостояние платежа.
СуммаСумма платежа.
КомиссииКомиссии по платежу.
ПолученоСумма поступления по платежу.
Код платежаКод платежа в выгрузке.
TitleНазвание предложения.

Источник GetCourse