API Яндекс Метрики: что это, для чего используется и как с ним работать

Виды API Метрики

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

API управления

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

API импорта данных

Нужен, чтобы передавать в Метрику информацию из внешних систем. С его помощью загружают офлайн-конверсии, данные CRM, сведения о звонках и чатах, расходы на продвижение и параметры посетителей. После обработки эти сведения дополняют данные Метрики о визитах и действиях пользователей на сайте, поэтому результаты рекламных кампаний можно оценивать с учётом информации из разных источников.

API отчётов

Используют для программного получения агрегированной статистики. В запросе можно указать нужный период, выбрать метрики и группировки, задать условия сегментации и другие параметры, после чего сервис сформирует отчёт в формате JSON или CSV. Подходит для автоматического обновления данных, интеграции с внутренними системами и построения собственных дашбордов.

Logs API

Предоставляет доступ к неагрегированным данным на уровне отдельных визитов и событий, зафиксированных счётчиком. В отличие от API отчётов, Logs API выгружает исходные данные, а не сформированные на их основе агрегированные показатели. Это позволяет строить собственные модели атрибуции, выполнять более глубокий анализ поведения аудитории, объединять данные с другими источниками и использовать их в BI-системах.

Logs API: особенности работы с неагрегированными данными

Работа с данными в Logs API выполняется поэтапно: сначала создаётся запрос на подготовку логов, затем проверяется его статус, а после завершения обработки данные скачиваются отдельными частями. Для Logs API действуют ограничения на количество запросов и время хранения подготовленной выгрузки, поэтому при регулярных выгрузках обычно автоматизируют создание запросов, проверку их статуса, скачивание частей и очистку подготовленных логов после обработки.

Что нужно для начала работы с API

Перед началом работы определите задачу и выберите подходящий API. От этого зависит, какие права доступа потребуются приложению. Затем зарегистрируйте приложение, получите OAuth-токен и используйте его для авторизации запросов.

Выбор API

Определите, какой API нужен для решения задачи. Для управления счётчиками используют API управления, для передачи информации из внешних систем — API импорта данных, для получения агрегированной статистики — API отчётов, а для выгрузки неагрегированных данных — Logs API.

Регистрация приложения

Создайте приложение в Яндекс ID. Во время регистрации укажите, что оно будет использоваться для доступа к API, затем заполните основные сведения и выберите необходимые права доступа. После этого приложение получит уникальный идентификатор — ClientID.

Получение OAuth-токена

OAuth-токен используется для авторизации запросов к API от имени пользователя. Чтобы получить токен, пользователь авторизуется в Яндекс ID с использованием ClientID приложения и предоставляет приложению запрошенные права. Владелец токена должен иметь доступ к счётчику, с которым предстоит работать.

Основные понятия при работе с API Метрики

Счётчик. Объект Метрики, который собирает данные о посещении сайта. Большинство методов API работает с конкретным счётчиком.

Метрики. Числовые показатели, рассчитываемые на основе данных о визитах и событиях. Например, количество визитов, просмотров, посетителей или достижений цели, средняя продолжительность визита и конверсии.

Группировки. Признаки, по которым распределяются данные в отчёте. Это могут быть дата, источник трафика, устройство, регион и другие параметры.

Сегменты. Условия отбора данных. Сегментация позволяет, например, отдельно анализировать визиты из определённого источника, с конкретного устройства или с достижением выбранной цели.

Цели. Настроенные действия пользователей, которые используют для оценки конверсий. Например, отправка формы, оформление заказа или переход на страницу.

Форматы данных и структура ответов API

Ответы API Яндекс Метрики возвращаются в структурированном формате, поэтому их можно автоматически обрабатывать в приложениях, BI-системах и собственных аналитических сервисах. По умолчанию большинство методов использует формат JSON, а API отчётов также позволяет получать данные в CSV. Так, ответ API отчётов вернёт сведения о выбранных метриках и группировках, итоговые показатели, параметры выполненного запроса и служебную информацию. Конкретная структура зависит от используемого метода API.

Как использовать API Яндекс Метрики на практике

Получение данных для отчётности. Через API отчётов можно программно получать агрегированную статистику с нужными метриками, группировками и условиями сегментации без ручного экспорта из интерфейса Метрики. Полученные данные используют в регулярной отчётности, собственных дашбордах и аналитических сервисах.

Автоматизация аналитики. С помощью API можно регулярно обновлять данные, рассчитывать собственные показатели, строить нестандартные отчёты и объединять статистику из разных источников без ручной обработки.

Интеграция с внешними системами. API используют для обмена данными между Метрикой, CRM, BI-платформами, внутренними сервисами и другими приложениями. Это позволяет собрать аналитику в одном месте и упростить работу с маркетинговыми данными.

Заключение

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

• Получать статистику и формировать отчёты через API
• Управлять счётчиками, целями и правами доступа
• Интегрировать Метрику с BI-платформами, внутренними сервисами и собственными приложениями
• Использовать Logs API для детального анализа неагрегированных данных
• Передавать в Метрику данные из внешних систем

Чтобы работа с API была результативной, важно правильно выбрать подходящий тип API и настроить OAuth-доступ.

Дополнительные материалы