Pull API — получение отчетов AppsFlyer по API

Введение

Все CSV-отчеты AppsFlyer доступны с помощью интерфейсов API. Секретный ключ и примеры можно найти на странице "Доступ к API" в своем аккаунте AppsFlyer.

Обязательные параметры API

api_token — ключ авторизации внешнего API пользователя: "{следует использовать ключ API владельца аккаунта}"

Требуемые параметры: api_token, from и to.

Для отчетов по необработанным данным доступны также следующие параметры:

  • от стартовой даты отчета, формат: гггг-мм-дд или гггг-мм-дд чч:мм. Например, 2010-01-01 или 2010-01-01%2000%3A15
  • to — дата окончания отчета; формат как у параметра from

Параметры API — необязательно

Фильтр отчетов по медиа-источнику и повторной атрибуции

Чтобы отфильтровать отчеты только по определенному медиа-источнику, необходимо добавить в запрос два параметра:

media_Source
также является необязательным параметром, он указывае на фактический медиа-источник. Например, для отчета по необработанным данным с категорией и часовым поясом:
https://hq.appsflyer.com/export/com.greatapp/installs_report/v5?api_token=xxxx&from=2016-11-09&to=2016-11-09&category=standard&media_source=googleadwords_int&timezone=+01:00
event_name
(только для отчета о внутренних событиях) может использоваться, чтобы отфильтровать данные отчета о необработанных данных (внутренние события) только по определенному событию или событиям. Например: event_name=af_purchase,ftd
необязательный параметр для фильтрации по медиа-источнику (category=standard) или по кампании Facebook (category=facebook).

Для экспорта ретаргетинга

reattr=true
используется для получения отчетов об атрибуции при ретаргетинге.

Пользовательские отчеты с помощью Pull API

fields
интерфейс Pull API (версии 5 и выше) позволяет клиентам выбирать поля в отчетах, чтобы загружать только релевантную информацию.

Указать поля можно, добавив в вызов API специальный параметр fields.

Введите в качестве значения параметра fields названия нужных столбцов в API. Пример: fields=country_code,city

&fields=название_API_A,название_API_Б

Пример:

Извлечение списка всех городов, из которых устанавливалось приложение, и кодов соответствующих стран:

https://hq.appsflyer.com/export/id341333333/installs_report/v5?api_token=24b7b9fe-6ddd-4ddd-94c8-xxxxxxxxxxx&from=2017-03-09&to=2017-03-10&fields=country_code,city

Полный список полей и названий их API вы найдете по ссылке.

Часовой пояс и валюта

  • timezone(необязательный параметр):

Добавив параметр timezone= в ссылку Pull API, вы сможете получить отчет для выбранного часового пояса (вместо GMT, который установлен по умолчанию). В отчетах по необработанным данным AppsFlyer поддерживает два формата часовых поясов: числовой (например, +10:00) или Joda-Time (например, Europe/Madrid). Формат Joda-Time предусматривает переход на летнее/зимнее время. Пример: timezone=%2B10:00 (url-encoded for +10:00). Только для отчетов об эффективности поддерживается формат времени Joda. Например:

https://hq.appsflyer.com/export/greatapp/daily_report/v5?api_token=xxxxxxxx &from=2016-11-09&to=2016-11-09&category=standard&media_source=googleadwords_int&timezone= Europe/Madrid

  • currency (необязательный параметр)

используется для получения данных о доходах и расходах в выбранной вами валюте (вместо USD по умолчанию). Этот параметр настраивается администратором аккаунта.

currency=preferred используется для получения данных о доходах и расходах в выбранной вами валюте.

Политика использования API

Чтобы ознакомиться с нашей политикой использования API, нажмите сюда

 Примечание

По умолчанию отчет об эффективности Pull API показывает данные Facebook только на уровне кампании. Чтобы отчет показывал информацию о Facebook на уровнях блока рекламы и рекламных объявлений, добавьте параметр &category=facebook. Данный способ актуален только для Facebook.

Примеры ссылок Pull API

Категория отчета Тип отчета Пример ссылки

Отчеты об эффективности

Партнерский отчет

https://hq.appsflyer.com/export/id123456789/partners_report/v5?api_token=<ВСТАВИТЬ API TOKEN>&from=yyyy-mm-dd&to=yyyy-mm-dd

 

Ежедневный партнерский отчет

https://hq.appsflyer.com/export/id123456789/partners_by_date_report/v5?api_token=<ВСТАВИТЬ API TOKEN>&from=yyyy-mm-dd&to=yyyy-mm-dd

 

Ежедневный отчет

https://hq.appsflyer.com/export/id123456789/daily_report/v5?api_token=<ВСТАВИТЬ API TOKEN>&from=yyyy-mm-dd&to=yyyy-mm-dd

 

Гео-отчет

https://hq.appsflyer.com/export/id123456789/geo_report/v5?api_token=<ВСТАВИТЬ API TOKEN>&from=yyyy-mm-dd&to=yyyy-mm-dd

 

Ежедневный гео-отчет

https://hq.appsflyer.com/export/id123456789/geo_by_date_report/v5?api_token=<ВСТАВИТЬ API TOKEN>&from=yyyy-mm-dd&to=yyyy-mm-dd

Отчеты по необработанным данным

Отчет об установках

https://hq.appsflyer.com/export/id123456789/installs_report/v5?api_token=<ВСТАВИТЬ API TOKEN>&from=yyyy-mm-dd&to=yyyy-mm-dd

 

Отчет о внутренних событиях

https://hq.appsflyer.com/export/id123456789/in_app_events_report/v5?api_token=<ВСТАВИТЬ API TOKEN>&from=yyyy-mm-dd&to=yyyy-mm-dd

 

Отчет об удалениях

https://hq.appsflyer.com/export/id123456789/uninstall_events_report/v5?api_token=<ВСТАВИТЬ API TOKEN>&from=yyyy-mm-dd&to=yyyy-mm-dd

 

 

Отчет об органических установках

https://hq.appsflyer.com/export/id123456789/organic_installs_report/v5?api_token=<ВСТАВИТЬ API TOKEN>&from=yyyy-mm-dd&to=yyyy-mm-dd

 

Отчет об органических внутренних событиях

https://hq.appsflyer.com/export/id123456789/organic_in_app_events_report/v5?api_token=<ВСТАВИТЬ API TOKEN>&from=yyyy-mm-dd&to=yyyy-mm-dd

Отчет о правилах валидации

Отчет о недействительных установках

https://hq.appsflyer.com/export/id123456789/invalid_installs_report/v5?api_token=<ВСТАВИТЬ API TOKEN>&from=yyyy-mm-dd&to=yyyy-mm-dd&additional_fields=rejected_reason,rejected_reason_value

 

Отчет о недействительных внутренних событиях

https://hq.appsflyer.com/export/id123456789/invalid_in_app_events_report/v5?api_token=<ВСТАВИТЬ API TOKEN>&from=yyyy-mm-dd&to=yyyy-mm-dd&additional_fields=rejected_reason,rejected_reason_value

Версия API (V5)

  • Изменения:
    • В версии v5 кампании Facebook группируются только по признаку кампании, а не по кампаниям и группам объявлений.
    • На странице экспорта данных для сводных отчетов используется API v5.
  • Без изменений:
    • Существующий API (v4) до сих пор доступен для использования.
    • Формат файлов и заголовки в новой версии не изменены.

 Примечания

Чтобы использовать отчеты об эффективности V4, измените параметр v5 на v4.

Например, здесь v5 (выделено красным) следует изменить на v4.

https://hq.appsflyer.com/export/{app_id}/geo_report/v5?api_token={api_token}
&from={from_date}&to={to_date}
Была ли эта статья полезной?
Пользователи, считающие этот материал полезным: 2 из 3