Отчет по событиям

Возвращает отчет о событиях.

Формат запроса

GET https://api.tickets.yandex.net/api/crm\
 ? action=crm.report.event\
 & auth=<string>\
 & city_id=<number>\
 & event_ids=<number>

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

Query-параметр	Описание
action*	string Идентификатор запроса.
auth*	string Идентификатор внешней системы.
city_id*	number Идентификатор города.
event_ids*	number Идентификатор события. Можно указать несколько идентификаторов через запятую.

* Обязательный параметр

Формат ответа

JSON

{
  "status": string,
  "result": [
    {
      "event_id": number,
      "event_name": string,
      "event_date": string,
      "activity_id": number,
      "agent": string,
      "agent_id": number,
      "tickets_count": number,
      "tickets_available": number,
      "tickets_booked": number,
      "tickets_sold": number,
      "tickets_agent": number,
      "tickets_season": number,
      "tickets_returned": number,
      "tickets_discount": number,
      "tickets_discount_sum": number,
      "tickets_sold_sum": number
    }
  ]
}

Параметры ответа

Параметр	Описание
status	string Статус выполнения запроса. Возможные значения: `0` — запрос выполнен; `1` — произошла ошибка.
result[]	[object] Результат выполнения запроса.
result[].event_id	number Идентификатор события.
result[].event_name	number Название события.
result[].event_date	string Дата события в формате YYYY-MM-DD hh:mm:ss.
result[].activity_id	number Идентификатор мероприятия.
result[].agent	string Название агента.
result[].agent_id	string Идентификатор агента.
result[].tickets_count	number Зависит от значения параметра `result[].agent`: если `"-"`, то это количество билетов, заведенных в продажу, за вычетом билетов, выданных офлайн-агентам на рспространение; если отличается от `"-"`, то это количество билетов, выданных офлайн-агенту на распространение.
result[].tickets_available	number Количество доступных для продажи билетов.
result[].tickets_booked	number Количество забронированных билетов.
result[].tickets_sold	number Зависит от значения параметра `result[].agent`: если `"-"`, то это количество билетов, проданных без участия агентов (продажи в кассе или в личном кабинете); если отличается от `"-"`, то это количество проданных агентом билетов.
result[].tickets_agent	number Зависит от значения параметра `result[].agent`: если `"-"`, то значение будет `0`; если отличается от `"-"`, то это количество выданных офлайн-агенту билетов, которые еще не проданы.
result[].tickets_season	number Количество билетов, проданных в абонементе.
result[].tickets_returned	number Количество возвращенных билетов.
result[].tickets_discount	number Количество билетов, проданных со скидками.
result[].tickets_discount_sum	number Общая сумма скидки.
result[].tickets_sold_sum	number Общая сумма продаж.

Пример ответа

{
  "status": "0",
  "result": [
    {
      "event_id": 7591177,
      "event_name": "Расхитители гробниц",
      "event_date": "2023-06-01 19:00:00",
      "activity_id": 7591176,
      "agent": "test",
      "agent_id": "1751392",
      "tickets_count": 42,
      "tickets_available": 0,
      "tickets_booked": 0,
      "tickets_sold": 2,
      "tickets_agent": 40,
      "tickets_season": 0,
      "tickets_returned": 0,
      "tickets_discount": 0,
      "tickets_discount_sum": 0,
      "tickets_sold_sum": 0
    },
    {
      "event_id": 7591177,
      "event_name": "Расхитители гробниц",
      "event_date": "2023-06-01 19:00:00",
      "activity_id": 7591176,
      "agent": "test",
      "agent_id": "33663",
      "tickets_count": 2,
      "tickets_available": 0,
      "tickets_booked": 0,
      "tickets_sold": 0,
      "tickets_agent": 2,
      "tickets_season": 0,
      "tickets_returned": 0,
      "tickets_discount": 0,
      "tickets_discount_sum": 0,
      "tickets_sold_sum": 0
    },
    {
      "event_id": 7591177,
      "event_name": "Расхитители гробниц",
      "event_date": "2023-06-01 19:00:00",
      "activity_id": 7591176,
      "agent": "ВТБ",
      "agent_id": "1746373",
      "tickets_count": 16,
      "tickets_available": 0,
      "tickets_booked": 0,
      "tickets_sold": 0,
      "tickets_agent": 16,
      "tickets_season": 0,
      "tickets_returned": 0,
      "tickets_discount": 0,
      "tickets_discount_sum": 0,
      "tickets_sold_sum": 0
    },
    {
      "event_id": 7591177,
      "event_name": "Расхитители гробниц",
      "event_date": "2023-06-01 19:00:00",
      "activity_id": 7591176,
      "agent": "Передает контент в arm / test",
      "agent_id": "908156",
      "tickets_count": 3,
      "tickets_available": 0,
      "tickets_booked": 0,
      "tickets_sold": 3,
      "tickets_agent": 0,
      "tickets_season": 0,
      "tickets_returned": 0,
      "tickets_discount": 0,
      "tickets_discount_sum": 0,
      "tickets_sold_sum": 60
    },
    {
      "event_id": 7591177,
      "event_name": "Расхитители гробниц",
      "event_date": "2023-06-01 19:00:00",
      "activity_id": 7591176,
      "agent": "-",
      "agent_id": "0",
      "tickets_count": 288,
      "tickets_available": 283,
      "tickets_booked": 0,
      "tickets_sold": 3,
      "tickets_agent": 0,
      "tickets_season": 0,
      "tickets_returned": 0,
      "tickets_discount": 0,
      "tickets_discount_sum": 0,
      "tickets_sold_sum": 55
    }
  ]
}

Была ли статья полезна?

Список событий

Список заказов