API отчетности версии 2.0 для публикаторов

Содержание

Общие сведения

API отчетности предлагает публикаторам программный способ доступа к данным, находящимся на панели управления. Ключ API отчетности одинаков для всех ваших приложений. У каждого приложения есть уникальный идентификатор API отчетности, который можно найти на соответствующей странице приложения.

Хост

Хост: https://report.api.vungle.com/ext/pub/reports/performance

Аутентификация

Безопасность регулируется в заголовке запроса. Найдите свой ключ API на странице отчетов панели управления Vungle. Если у вас еще нет ключа API, запросите его по электронной почте: tech-support@vungle.com.

Заголовки запросов

Ключ Значение Описание
Authorization: Bearer [API Key] Ключ API
Vungle-Version: 1 Версия API
Accept: text/csv or application/json Accepted data format for results. Default is text/csv.

 

Результаты

  • Формат. Мы поддерживаем выходные данные в форматах JSON и CSV.
  • Диапазон данных. Доступны хронологические данные за шесть месяцев. Если вам нужны более старые данные, обратитесь к своему менеджеру по работе с клиентами по электронной почте: tech-support@vungle.com.
  • Если данных нет. Имейте в виду, что если данные для вашего запроса не найдены, Vungle возвращает пустой ответ 200. Это означает, что запрос выполнен, но данных для возврата нет.

Ресурс: GET /reports/performance

Параметры фильтрации

Параметры фильтрации позволяют ограничить результаты подмножеством данных о производительности. Большинство фильтров необязательны, при их применении Vungle возвращает все результаты для такого фильтра.

Имя параметра Формат Действие Если недоступен Пример
start Дата ISO8601 Ограничивает набор результатов данными о производительности, полученными не ранее указанной даты Запрос отклоняется start=2017-01-01
end Дата ISO8601 Ограничивает набор результатов данными о производительности, полученными не позднее ранее указанной даты Запрос отклоняется end=2017-01-02 
country  Список кодов стран по ISO 3166-1 Alpha-2 (с разделителями-запятыми) Возвращает только данные о производительности, соответствующие указанным странам Возвращает все страны

country=US

country=US,CA

country=US,CA,AU
applicationId  Список идентификаторов приложений Vungle для возврата (с разделителями-запятыми) Возвращает данные о производительности только для указанных приложений Возвращает все приложения

applicationId=586e201e242e3fd308000220

applicationId=586e201e242e3fd308000220,585849c3756684a50c0000a0
incentivized ‘true’/’false’ or 1/0 Возвращает данные о производительности только для стимулированного или только для нестимулированного трафика Возвращает данные и для стимулированного, и для нестимулированного трафика

incentivized=true

incentivized=false

Параметр dimensions

Измерения помогут вам сделать отчеты более или менее детальными. Измерения отправляются в виде списка с разделителями-запятыми в параметре dimensions. Если вы не запрашиваете измерение явным образом, Vungle не разбивает по нему отчет.

Использование параметра dimensions

Имя параметра Формат Пример
dimensions Список из особых строк, указанных в таблице ниже (с разделителями-запятыми)

dimensions=platform

dimensions=application,date,country

 

Доступные измерения

Название 
измерения
Результат Пример результата
platform Строка с группировкой по платформам
platform
iOS
application Группировка по идентификаторам и именам приложений Vungle
application id application name
58086457cdf5f9eb6d000060 Sonic Dash
placement Группировка по идентификаторам и именам размещений
placement id placement name
12345678 Level 3
date  Группировка по датам 
date
2017-01-01
country Группировка по странам 
country
US
incentivized Группировка по стимулированному трафику
incentivized
true
false

Если для измерений, требующих поиска по имени (например, по имени приложения), Vungle не удается найти данные, мы возвращаем строку Unknown (Неизвестно) вместо имени.

Параметр aggregates

Параметр aggregates определяет, какие данные о функционировании вас интересуют. Сводные показатели отправляются в виде списка с разделителями-запятыми в параметре aggregates. Если сводного показателя нет в списке, Vungle считает, что вам эти данные не нужны.

Использование параметра aggregates

Имя параметра Формат Пример
aggregates Список из особых строк, указанных в таблице ниже (с разделителями-запятыми)

aggregates=views

aggregates=views,installs,ecpm

 

Доступные сводные показатели

Название 
измерения
Результат
views целое число
completes целое число
clicks  целое число 
revenue  целое число
ecpm (доход публикатора * 1000 / просмотры) в виде числа с плавающей точкой

  

Примеры запросов и ответов

Пример 1: доход в формате JSON

Запрос


curl -i -H "Authorization: Bearer [API KEY]" -H "Vungle-Version:1" -H "Accept:application/json" -X GET "https://report.api.vungle.com/ext/pub/reports/performance?dimensions=date,country,platform&aggregates=views,revenue&start=2017-03-01&end=2017-03-05"

Ответ


[
    {
        "platform" : "iOS",
        "date": "2017-03-01",
        "country": "US",
        "views": 1234,
        "revenue": 123.0,
        "ecpm": 99.67,       
    },
    {
        "platform" : "iOS",
        "date": "2017-03-01",
        "country": "CA",
        "view": 35,
        "revenue": 2.0,
        "ecpm": 57.14,
    },
    ...
]

Пример 2: доход в формате CSV

Запрос


curl -i -H "Authorization: Bearer [API KEY]" -H "Vungle-Version:1" -H "Accept:application/json" -X GET "https://report.api.vungle.com/ext/pub/reports/performance?dimensions=date,country,platform&aggregates=views,revenue&start=2017-03-01&end=2017-03-05"

Ответ


Platform,date,country,views,revenue
ios,2017-03-01,US,1234,123.0
ios,2017-03-01,CA,35,2.0
...

Example 3: Placement

Запрос

curl -i -H "Authorization: Bearer [API KEY]" -H "Vungle-Version:1" -H "Accept:application/json" -X GET 
"https://report.api.vungle.com/ext/pub/reports/performance?dimensions=placement&aggregates=views,revenue&start=2017-03-01&end=2017-03-05"

Ответ


[
    {
        "placement id" : "12345678",
        "placement name": "level 3",
        "views": 1234,
        "revenue": 123.0       
    }
]
Была ли эта статья полезной?
Пользователи, считающие этот материал полезным: 0 из 0
Еще есть вопросы? Отправить запрос

Комментарии