Skip to content

Получение всех отчетов пользователя

Метод get.reports_list
Описание Получение всех отчетов пользователя
Кому доступен Агент, Клиент
Необходимые компоненты для работы с методом Data API для настройки
Вес метода 1 балл

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

Название Тип Обязательный Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
Для получения списка пользователей клиента необходимо использовать метод "get.customer_users"
limit number нет Количество возвращаемых записей. См. раздел "Постраничный вывод"
offset number нет Сдвиг - определяет с какого номера записи возвращать "limit" записей. По умолчанию "0". См. раздел "Постраничный вывод"
filter object нет См. раздел "Критерии фильтрации"
fields array нет См. раздел "Представление возвращаемых данных"
sort array нет См. раздел "Сортировка данных"

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

Название Тип Допустимые значения Фильтрация Сортировка Ответ по умолчанию Описание
id number да да да Уникальный идентификатор отчета пользователя
type enum
  • summary_analytics
  • ad_analytics
  • chat_summary
  • call_summary
  • communications
  • call_tracking_monitoring
  • deals
  • chats
  • dashboard
  • calls
  • mgf_calls
  • communications_operator_workplace
  • person_summary
  • leads
да да да Тип отчета пользователя
name string да Название отчета пользователя
description string да Описание отчета пользователя
group_id number да Идентификатор группы отчета
sort number Сортировка отчетов в меню
is_mobile boolean да да Отчет используется в мобильной версии ЛК
is_editable boolean да да Является ли редактируемым
is_favorite boolean да да Является ли отчет избранным
date_time_added_to_favorite iso8601 YYYY-MM-DD hh:mm:ss да да Дата и время добавление отчета в избранное

JSON структура запроса

{
    "jsonrpc":"2.0",
    "id":"number",
    "method":"get.reports_list",
    "params":{
        "access_token":"string",
        "user_id":"number",
        "offset":"number",
        "limit":"number",
        "filter":{

        },
        "sort":[
        {
        "field":"string",
        "order":"string"
        }
        ],
        "fields":[
        "string"
        ]
    }
}

JSON структура ответа

{
    "jsonrpc": "2.0",
    "id": "number",
    "result": {
        "metadata": {

        },
        "data": [
            {
            "id": "number",
            "type": "enum",
            "name": "string",
            "description": "string",
            "group_id": "number",
            "sort": "number",
            "is_mobile": "boolean",
            "is_editable": "boolean",
            "is_favorite": "boolean",
            "date_time_added_to_favorite": "iso8601"  
            }
        ]
    }
}

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

{
    "result": {
        "metadata": {
            "total_items": 1
        },
        "data": [
            {
                "name": "Анализ трафика",
                "type": "summary_analytics",
                "id": 2,
                "description": null,
                "group_id": 6,
                "sort": 200,
                "is_mobile": false,
                "is_editable": false,
                "is_favorite": true,
                "date_time_added_to_favorite": "2024-08-20 13:54:07"                
            }
        ]
    },
    "id": "1",
    "jsonrpc": "2.0"
}

Список возвращаемых ошибок

Смотрим раздел "Список ошибок для методов с глаголом get"