Ресурсы и вызов методов

Ресурсы

API Яндекс Метрики построен по REST-принципам.

Все, чем можно управлять через API, представлено в виде ресурсов: статистика, список счетчиков, собственно счетчик, цели счетчика и каждая конкретная цель, доступы к счетчику и т. д.

То есть ресурс — это некая целостная часть системы, с которой можно работать:

  • читать содержимое и текущее состояние ресурса (GET);
  • изменять содержимое и состояние и записывать его в ресурс (PUT);
  • удалять ресурс (DELETE);
  • выполнять специальные действия ― например, добавлять новые элементы в список (POST).

У каждого ресурса есть свой уникальный URL. Все действия выполняются соответствующими методами протокола HTTP на URL'ы ресурсов.

Например, чтобы получить информацию о счетчике, необходимо сделать GET-запрос на URL счетчика. А чтобы создать новый счетчик, необходимо сделать POST-запрос с телом счетчика на URL ресурса «список счетчиков».

Вызов методов

Примечание

Запросы к API Яндекс Метрики передаются по протоколу HTTPS.

Запрос к сервису задается в следующем формате:

<тип_метода> https://api-metrika.yandex.net/<раздел_API>/<версия>/<имя_метода>.<формат_результата>?<параметры>

<тип метода>

GET, POST, PUT или DELETE.

<раздел_API>

Название раздела API, в котором выполняется действие. Текущие разделы:

  • management (API Управления и Logs API).
  • stat (API отчетов).
  • analytics (API, совместимый с Google Analitics Core Reporting API).

<версия>

Номер текущей версии API.

<имя_метода>

URL ресурса, над которым выполняется действие.

<формат_результата>

Необязательная часть запроса. Задает формат результата. По умолчанию данные передаются в формате JSON.

<параметры>

Обязательные и необязательные параметры запроса.

Узнайте больше

Предыдущая
Версионирование
Следующая
Квотирование