Перейти к основному контенту

Получение результатов диалогов

Описание

API позволяет получить результаты обзвона с указанными параметрами.

Данная документация описывает API для получения результатов обзвона с заданными параметрами. В случае успешного запроса будут возвращены необходимые данные о звонках, их продолжительности и количество.

POST
https://ai-assistant.is74.ru/api/analytics/{project_id}/report

Значение project_id вы можете уточнить у вашего личного менеджера или через техническую поддержку платформы.

 
{
  "analytics_filter": {
    "scenario_id": 0,
    "start_block_id": 0,
    "outgoing_campaign_id": 12345,
    "date_start": "string",
    "date_end": "string"
  },
  "columns": [
    {
      "id": 0,
      "name": "string",
      "display_name": "string",
      "column_type": "string",
      "table_type": "string",
      "data_type": "text"equal",
      "filter_type": "equal",
      "filter_value": "string",
      "sorting": "asc"equal"
    }
  ]
}
Параметры запроса
Analytics filter Value Rules Description
scenario_id required integer
ID сценария
start_block_id required integer ID стартового блока сценария
outgoing_campaign_id required integer ID обзвона, результаты которого необходимо получить
start_block_id required integer Дата начала периода для получения результатов
schedule requiredjson
Дата окончания периода для получения результатов
columns array

Информация о полях, которые необходимо получить
Columns
Columns Value Rules Description
id integer
ID колонкистолбца
name string Название колонкистолбца
display_name string Отображаемое название колонки ?столбца
column_type string Тип данных в колонкистолбце
table_type

stringdateTime

 ?Используется для приведения типа при выгрузке в excel таблицу
data_type arrayequal ?

Получить набор столбцов соответствующих типу:

    "text" "number" "datetime" "dialog" "goal"
    filter_type equal

    ?Тип фильтра применяемый к столбцу:

      "equal" "contains" "starts_with" "ends_with" "is_empty" "not_empty" "is_true" "not_true"
      filter_value string

      ?Значение выбранного фильтра. То с чем должно проводиться сравнение
      sorting stringequal

      Сортировка, может принимать значения:

      • asc - по возрастанию;"asc"
      • desc - по убыванию."desc"
      Пример запроса 
      {
  "analytics_filter": {
    "scenario_id": 951,
    "start_block_id": 10,
    "outgoing_campaign_id": 12345,
    "date_start": "2000-01-01T08:00:59.096Z",
    "date_end": "2000-01-01T18:04:59.096Z"
  },
  "columns": [
    {
      "id": 1,
      "name": "phone_number",
      "display_name": "Phone Number",
      "column_type": "field",
      "table_type": "calls",
      "data_type": "text"number",
      "filter_type": "equal"contains",
      "filter_value": "+79999999999",
      "sorting": "asc"
    }
  ]
}
      Пример ответа

      Код: 200

      {
  "columns": [
    {
      "field": "phone_number",
      "display_name": "Phone Number",
      "type": "text"
    }
  ],
  "data": [
    {
      // Результаты данных
    }
  ],
  "total_duration": 3600,
  "avg_duration": 120,
  "count": 30
}

      Ошибки

      • В случае ошибки будет возвращен соответствующий HTTP статус код и сообщение об ошибке.






      Наверх