API Яндекс.Метрики

API служит для вызова функций Яндекс.Метрики программным способом. Это позволяет автоматизировать различные действия, доступные в веб-интерфейсе Метрики, например создание счетчиков, настройку целей, получение статистики посещаемости.

Примечание. 

Для работы с API желательно общее знакомство с Метрикой. Обратитесь к справке за дополнительным описанием.

Как сделать запрос к API

В первую очередь необходим авторизационный токен. Он выражает согласие конкретного пользователя Яндекса на доступ к его данным в Метрике через API. В примерах ниже использован токен тестового пользователя 05dd3dd84ff948fdae2bc4fb91f13e22. Он позволяет читать данные Метрики и служит для изучения API.

Следующий запрос возвращает список счетчиков тестового пользователя:

http://api-metrika.yandex.ru/counters?oauth_token=05dd3dd84ff948fdae2bc4fb91f13e22

По умолчанию API отвечает в формате XML. Чтобы получить ответ JSON, к адресной части запроса добавляют мнемонику .json. Параметр pretty=1 улучшает читабельность ответа:

http://api-metrika.yandex.ru/counters.json?pretty=1&oauth_token=05dd3dd84ff948fdae2bc4fb91f13e22

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

Как получить статистику

Отчеты Метрики получают с помощью GET-запросов. Следующий запрос возвращает данные посещаемости по времени суток в формате JSON для тестового пользователя:

http://api-metrika.yandex.ru/stat/traffic/hourly.json?id=2138128&pretty=1&oauth_token=05dd3dd84ff948fdae2bc4fb91f13e22

Полный список отчетов и примеры запросов приведены в разделе Получение статистики.

С чего начать разработку приложения

Получите авторизационный токен.

Выберите формат взаимодействия — JSON или XML.

Изучите справочник ресурсов. В нем перечислены объекты Метрики и даны ссылки на описание действий с ними: создание, редактирование, удаление, получение сведений.