Введение
API сервиса AppMetrica позволяет:
- Управлять приложениями, не используя веб-интерфейс.
- Получать статистику приложения (количество пользователей, устройств и др.).
- Формировать отчеты, в том числе с помощью сегментации.
Для использования API AppMetrica нужна авторизация с помощью OAuth-токена. Необходимо отправлять авторизационный токен в каждом запросе к API.
Для иллюстрации возможностей API в справочнике приведены примеры обращения к сервису. Методы в примерах возвращают демонстрационные данные, доступные для просмотра всем пользователям.
Структура API
API включает в себя следующие разделы:
- API управления — позволяет добавлять, редактировать, удалять приложения.
- API отчетов — позволяет получать статистику приложения.
- Logs API — позволяет получить неагрегированные данные о приложении.
- Data Stream API — позволяет выгружать данные в виде файлов формата CSV или JSON.
- Post API — позволяет загружать информацию о событиях в AppMetrica.
- Push API — позволяет создавать push-кампании.
Версионирование
Все разделы API AppMetrica поддерживают версионирование. У каждой версии есть определенный идентификатор (v1, v2 и т. п.). При выходе новой версии API предыдущая версия продолжает работать для поддержания обратной совместимости.
Если вы начинаете работу с API, используйте самую последнюю версию. Если вы уже используете предыдущие версии API, рекомендуем постепенно переходить на последнюю, т. к. поддержка старых версий ограничена во времени.
При формировании запроса к API всегда указывайте версию, с которой вы хотите работать.
https://api.appmetrica.yandex.ru/stat/v1/data?id=...
https://api.appmetrica.yandex.ru/stat/v2/data?id=...
Ресурсы
API AppMetrica построен по REST-принципам.
Все, чем можно управлять через API, представлено в виде ресурсов: статистика, список счетчиков, собственно счетчик, цели счетчика и каждая конкретная цель, доступы к счетчику и т. д.
- читать содержимое и текущее состояние ресурса (GET);
- изменять содержимое и состояние и записывать его в ресурс (PUT);
- удалять ресурс (DELETE);
- выполнять специальные действия ― например, добавлять новые элементы в список (POST).
У каждого ресурса есть свой уникальный URL. Все действия выполняются соответствующими методами протокола HTTP на URL'ы ресурсов.