Получение списка воронок продаж

Метод	`get.sales_funnel`
Описание	Получение списка воронок продаж
Кому доступен	Агент, Клиент

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

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

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

Название	Тип	Фильтрация	Сортировка	Описание
`ext_id`	string	да	да	Внешний идентификатор воронки продаж
`name`	string	да	да	Название воронки продаж
Этапы воронки продаж
`stages`	array			Список этапов воронки продаж
`stage_ext_id`	string			Внешний идентификатор этапа
`stage_name`	string			Название этапа
`stage_status`	enum			Статус этапа. Возможные статусы "in_process", "success", "failed"
`stage_order`	number			Порядковый номер этапа

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

Копировать

{
 "jsonrpc":"2.0",
 "id":"number",
 "method":"get.sales_funnel",
 "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": {
    "data": [
      {
        "ext_id": "string",
        "name": "string",
        "stages": [
          {
            "stage_ext_id":"string",
            "stage_name": "string",
            "stage_status": "enum",
            "stage_order": "number"
          }
        ]
      }
    ],
    "metadata": "object"
  }
}

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

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