Документация
Справочник разработчика
API управления
Управление клиентами Директа
API отчетов v1
Группировки
Клики
Параметры посетителей

Форматы входных данных и результата

Краткое содержание

Формат входных данных

Входные структуры данных POST- и PUT-методов передаются в теле запроса. Входные структуры совпадают с выходными структурами GET-методов соответствующих ресурсов.

Совет. 

Чтобы корректно сформировать входную структуру для POST- или PUT-метода, вызовите GET-метод для уже существующего ресурса. Скопируйте полученную структуру и задайте нужные значения полей.

POST- и PUT-методы API принимают входные данные в формате JSON.

Формат входных данных указывается в HTTP-заголовке Content-Type.

Возможные значения заголовка: application/x-yametrika+json или application/json.

Формат результата

API управления возвращает ответы в кодировке UTF-8. Ответы имеют формат JSON.

Например, в результате выполнения следующего запроса будут получены данные о счетчике:

GET https://api-metrika.yandex.ru/management/v1/counter/<counter_id>

Пример:

POST /management/v1/counters HTTP/1.1
Host: api-metrika.yandex.ru
Authorization: OAuth <access_token>
Content-Type: application/x-yametrika+json
Content-Length: 127

{
     "counter" : {
         "site" : "www.example.ru",
         "name" : "Наименование счетчика",
    }
}

Для удобства отладки результат может отображаться в отформатированном виде. Для этого в запросе любого типа передайте параметр pretty со значением равным 1:

GET https://api-metrika.yandex.ru/management/v1/counter/<counter_id>?pretty=1
PUT https://api-metrika.yandex.ru/management/v1/counter/<counter_id>?pretty=1

При успешном выполнении DELETE-методов API возвращает HTTP-статус с кодом 200. Если HTTP-статус содержит другой код, удаление не выполнено.