Получение списка источников

Метод	`get.sources`
Описание	Получение списка источников
Кому доступен	Агент, Клиент
Необходимые компоненты для работы с методом	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		да	да	да	Уникальный идентификатор источника
`name`	string		да	да	да	Название источника
`description`	string		да			Описание источника
`group_id`	number		да			Идентификатор группы источника
`group_name`	string		да			Группа источника
`channel_id`	number		да			Идентификатор канала источника
`channel_name`	string		да	да	да	Название канала источника
`channel_mnemonic`	string		да	да	да	Мнемоника канала
`filter`	object		да	да	да	Условие фильтрации данных
`priority`	number		да	да	да	Сквозной идентификатор, используемый для сортировки.
`is_custom`	boolean		да	да	да	Создан ли источник пользователем клиента
`state`	enum	`active` Источник активен `off` Источник отключен `removed` Источник удален	да	да	да	Статус источника источника
`icon_mnemonic`	string				да	Мнемоника иконки источника
`static_parameters`	array	нет	нет	нет	да	Статические метки, проставляемые для обращений по данному источнику
`parameter`	enum	нет	нет	нет	да	Тип метки
`value`	string	нет	нет	нет	да	Значение метки

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

Копировать

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

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

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

Копировать

{
  "jsonrpc": "2.0",
  "id": "HXw4IeLYAfblv6FRkzRNd",
  "result": {
    "data": [
      {
        "id": 8,
        "name": "Google Ads4",
        "filter": null,
        "group_id": 2,
        "priority": 1,
        "is_custom": true,
        "channel_id": 2,
        "group_name": "Google Ads2",
        "channel_name": "Контекстная реклама2",
        "channel_mnemonic": "contex2t",
        "icon_mnemonic": "google_ads",
        "static_parameters": [
         {
          "parameter": "utm_source",
          "value": "utm_source"
         }
        ]]
      },
      {
        "id": 2,
        "name": "Google Ads3",
        "filter": null,
        "group_id": 2,
        "priority": 2,
        "is_custom": true,
        "channel_id": 2,
        "group_name": "Google Ads2",
        "channel_name": "Контекстная реклама2",
        "channel_mnemonic": "contex2t",
        "icon_mnemonic": "google_ads",
        "static_parameters": null
      }
    ],
    "metadata": {
      "total_items": 2,
      "version": null,
      "limits": {}
    }
  }
}

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

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