Поля 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} | Идентификатор выгрузки, полученный при её запуске. |
Фильтры пользователей
| Поле | Описание |
|---|---|
created_at[from] | Начальная дата регистрации, YYYY-MM-DD. |
created_at[to] | Конечная дата регистрации, YYYY-MM-DD. |
status | Статус пользователя. Допустимы active и in_base. |
email | Один или несколько адресов электронной почты через запятую. |
idgrouplist | Дополнительный параметр. id добавляет список ID групп, id_date добавляет ID и даты вступления. Для запуска нужен отдельный фильтр. |
Фильтры пользователей группы
| Поле | Описание |
|---|---|
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. |
Фильтры заказов
| Поле | Описание |
|---|---|
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_group | ID группы, к которой относятся покупатели. |
user_id | Один или несколько ID покупателей через запятую. |
Фильтры платежей
| Поле | Описание |
|---|---|
created_at[from] | Начальная дата создания платежей. |
created_at[to] | Конечная дата создания платежей. |
status_changed_at[from] | Начальная дата изменения статуса платежа. |
status_changed_at[to] | Конечная дата изменения статуса платежа. |
status | Допустимые значения: expected, accepted, returned, tobalance, frombalance, returned_to_balance. |
Поля групп
| Поле | Описание |
|---|---|
id | Идентификатор группы. |
name | Название группы. |
last_added_at | Дата и время последнего добавления в группу. Если группу ещё никто не пополнял, значение null. |
Столбцы пользователей
| Поле | Описание |
|---|---|
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. |
Столбцы заказов
| Поле | Описание |
|---|---|
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. |
Клиент: денег принес | Сумма, которую принёс покупатель. |
Клиент: оплачено заказов | Количество оплаченных заказов покупателя. |
Страна | Страна покупателя. |
Комментарий к клиенту | Примечание из карточки покупателя. |
Статус подписки клиента | Состояние подписки покупателя. |
Клиент: дата регистрации | Когда покупатель зарегистрировался. |
Клиент: давность регистрации | Сколько времени прошло с регистрации. |
Клиент: давность последней активности | Сколько времени прошло с последней активности. |
Клиент: дата последней активности | Когда покупатель был активен в последний раз. |
Задачи | Связанные задачи в формате [статус] название. |
Столбцы платежей
| Поле | Описание |
|---|---|
Номер платежа | Номер записи о платеже. |
Пользователь | Имя плательщика. |
E-Mail | Электронная почта плательщика. |
Заказ | Связанный заказ. |
Дата создания | Когда запись о платеже была создана. |
Тип платежа | Способ оплаты или платёжная система. |
Статус | Состояние платежа. |
Сумма | Сумма платежа. |
Комиссии | Комиссии по платежу. |
Получено | Сумма поступления по платежу. |
Код платежа | Код платежа в выгрузке. |
Title | Название предложения. |
Поля по этому запросу не найдены.