Ad Revenue

Returns Ad Revenue data for a specific date range.

Request format

GET https://api.appmetrica.yandex.ru/logs/v1/export/ad_revenue_events.{csv | json}
  ? application_id=<int>
  & date_since=<string>
  & date_until=<string>
  & fields=<string>
  & [date_dimension=<string>]
  & [limit=<string>]
  & [use_utf8_bom=<bool>]
  & [<any field name>=<string>]

application_id*

Filtering by the app's numeric ID in AppMetrica

date_since*

Start of the date range in yyyy-mm-dd hh:mm:ss format. You can also define the date and time type that affects the data in the date_dimension query parameter.

date_until*

End of the date range in yyyy-mm-dd hh:mm:ss format. You can also define the date and time type that affects the data in the date_dimension query parameter.

fields*

A comma-separated list of fields for the sample.

A list that contains all available fields (for quick copy):

ad_revenue_datetime,ad_revenue_timestamp,ad_revenue_receive_datetime,ad_revenue_receive_timestamp,ad_revenue,ad_revenue_currency,ad_revenue_type,ad_revenue_data_source,ad_revenue_network,ad_revenue_placement_id,ad_revenue_placement_name,ad_revenue_unit_id,ad_revenue_unit_name,ad_revenue_precision,ad_revenue_payload,session_id,installation_id,android_id,appmetrica_device_id,appmetrica_sdk_version,city,connection_type,country_iso_code,device_ipv6,device_locale,device_manufacturer,device_model,device_type,google_aid,ios_ifa,ios_ifv,mcc,mnc,operator_name,original_device_model,os_version,profile_id,windows_aid,app_build_number,app_package_name,app_version_name

date_dimension

This parameter defines the point to calculate the date range from:

  • default: When the event occurred on the device.
  • receive: When the server received information about the event.

limit

Limit on the number of items in the list. Takes the maximum value by default. There is no guarantee that results will match from request to request (there may be differences in results sorting).

use_utf8_bom

Parameter that enables the use of byte order mark. The default value is false.

<any field name>

Filtering by the value of one of the available fields. Only the equality check operation is supported.

Response format

If all available fields are requested:

{
  "data": [
    {
      "ad_revenue_type": "string",
      "ad_revenue": "string",
      "ad_revenue_currency": "string",
      "ad_revenue_data_source": "string",
      "ad_revenue_network": "string",
      "ad_revenue_placement_id": "string",
      "ad_revenue_placement_name": "string",
      "ad_revenue_unit_id": "string",
      "ad_revenue_unit_name": "string",
      "ad_revenue_precision": "string",
      "ad_revenue_payload": "string",
      "ad_revenue_datetime": "string",
      "ad_revenue_receive_datetime": "string",
      "ad_revenue_receive_timestamp": "integer",
      "ad_revenue_timestamp": "integer",
      "session_id": "integer",
      "installation_id": "string",
      "android_id": "string",
      "appmetrica_device_id": "integer",
      "appmetrica_sdk_version": "integer",
      "city": "string",
      "connection_type": "string",
      "country_iso_code": "string",
      "device_ipv6": "string",
      "device_locale": "string",
      "device_manufacturer": "string",
      "device_model": "string",
      "google_aid": "string",
      "ios_ifa": "string",
      "ios_ifv": "string",
      "mcc": "integer",
      "mnc": "integer",
      "operator_name": "string",
      "original_device_model": "string",
      "os_version": "string",
      "profile_id": "string",
      "windows_aid": "string",
      "app_build_number": "integer",
      "app_package_name": "string",
      "app_version_name": "string"
    },
    ...
  ]
}
application_id,ios_ifa,os_name,...
1111,024AE7EB-4128-4237-9803-D24950323D4D,ios,...
1111,3A86D5E8-1985-4A23-B147-5A1C0CF8781E,ios,...
1111,,android
...

ad_revenue_datetime

Date and time of the event in yyyy-mm-dd hh:mm:ss format.

ad_revenue_timestamp

Time of the event in Unix time format.

With the Post API, you can upload events only if the difference between the event date (event_timestamp) and the upload date is no more than seven days. The API expects a value in seconds.

ad_revenue_receive_datetime

Date and time the event was received on the server side. May differ from ad_revenue_datetime due to network delays or if the user's device was not connected at the time of the event.

ad_revenue_receive_timestamp

Time when the event was received on the server side in Unix time format. May differ from ad_revenue_timestamp due to network delays or if the user's device was not connected at the time of the event.

ad_revenue

Ad Revenue amount.

ad_revenue_currency

Ad Revenue currency.

ad_revenue_type

Ad Revenue type. Possible values:

  • native
  • banner
  • rewarded
  • interstitial
  • mrec
  • other

ad_revenue_data_source

Flag indicating that Ad Revenue was automatically collected. Possible values:

  • autocollected
  • manual

ad_revenue_network

Advertising network.

ad_revenue_placement_id

Ad placement ID

ad_revenue_placement_name

Ad placement name.

ad_revenue_unit_id

Ad unit ID.

ad_revenue_unit_name

Ad unit name.

ad_revenue_precision

Accuracy of the Ad Revenue amount (as passed to the SDK). For example, "publisher_defined" or "estimated".

ad_revenue_payload

Additional data serialized into JSON.

session_id

Session ID. The set of values installation_id, session_id and the platform device ID (google_aid / ios_ifa) allows you to uniquely identify a user's session.

installation_id

Installation ID.

android_id

Android device ID.

appmetrica_device_id

A unique device identifier detected by the AppMetrica service.

appmetrica_sdk_version

Version of the AppMetrica SDK.

city

The name of the city where the click was made (in English).

connection_type

Type of connection. Possible values: wifi | cell | unknown.

country_iso_code

ISO country code.

device_ipv6

The IP address at the time of the event in IPv6 format. For example, 2a02:6b8::40c:6676:baff:fea6:53d8, ::ffff:5.255.232.147.

device_locale

The language on the device.

device_manufacturer

The device manufacturer detected by the AppMetrica service (for example, Apple or Samsung).

device_model

The device model detected by the AppMetrica service (for example, Galaxy S6).

google_aid

The device's Google AID in the format received from the device.

ios_ifa

The device's IFA in the format received from the device.

ios_ifv

IFV for the app in the format received from the device.

mcc

Mobile country code.

mnc

Mobile network code.

operator_name

Name of the mobile operator.

original_device_model

Factory model of the device (for example, the following values are possible for Galaxy S8: SM-G9550, SM-G9558, and so on).

os_version

The version of the operating system on the user's device.

profile_id

User profile ID.

windows_aid

The device's Windows AID in the format received from the device.

app_build_number

App build number.

app_package_name

The package name for Android, or the Bundle ID for iOS (for example, ru.yandex.metro).

app_version_name

The app version in the format specified by the developer.

Example

Request:

curl -X GET \
  'https://api.appmetrica.yandex.ru/logs/v1/export/ad_revenue_events.json?application_id=1111&date_since=2018-10-10&date_until=2018-10-11&fields=ad_revenue_datetime,ad_revenue_timestamp,ad_revenue_receive_datetime,ad_revenue_receive_timestamp,ad_revenue,ad_revenue_currency,ad_revenue_type,ad_revenue_data_source,ad_revenue_network,ad_revenue_placement_id,ad_revenue_placement_name,ad_revenue_unit_id,ad_revenue_unit_name,ad_revenue_precision,ad_revenue_payload,session_id,installation_id,android_id,appmetrica_device_id,appmetrica_sdk_version,city,connection_type,country_iso_code,device_ipv6,device_locale,device_manufacturer,device_model,device_type,google_aid,ios_ifa,ios_ifv,mcc,mnc,operator_name,original_device_model,os_version,profile_id,windows_aid,app_build_number,app_package_name,app_version_name' \
  -H 'Authorization: OAuth oauth_token'

Response:

{
  "data": [
    {
      "ad_revenue_type": "banner",
      "ad_revenue": "299",
      "ad_revenue_currency": "RUB",
      "ad_revenue_data_source": "manual",
      "ad_revenue_network": "network__example",
      "ad_revenue_placement_id": "ad_revenue_placement_id__example",
      "ad_revenue_placement_name": "ad_revenue_placement_name__example",
      "ad_revenue_unit_id": "ad_revenue_unit_id__example",
      "ad_revenue_unit_name": "ad_revenue_unit_name__example",
      "ad_revenue_precision": "estimated",
      "ad_revenue_payload": "{\"example_key1\":\"example_value1\", \"example_key2\":\"example_value2\"}",
      "ad_revenue_datetime": "yyyy-mm-dd hh:mm:ss",
      "ad_revenue_receive_datetime": "yyyy-mm-dd hh:mm:ss",
      "ad_revenue_receive_timestamp": "1556258667",
      "ad_revenue_timestamp": "1556258660",
      "session_id": "10000000049",
      "installation_id": "installation_id__example",
      "android_id": "android_id__example",
      "appmetrica_device_id": "123456789012345678",
      "appmetrica_sdk_version": "3001000",
      "city": "Moscow",
      "connection_type": "wifi",
      "country_iso_code": "RU",
      "device_ipv6": "::ffff:5.255.232.147",
      "device_locale": "ru_RU",
      "device_manufacturer": "Apple",
      "device_model": "iPhone X",
      "google_aid": "google_aid__example",
      "ios_ifa": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "ios_ifv": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "mcc": "250",
      "mnc": "1",
      "operator_name": "MTS RUS",
      "original_device_model": "iPhone10,3",
      "os_version": "12.2",
      "profile_id": "test",
      "windows_aid": "windows_aid__example",
      "app_build_number": "1",
      "app_package_name": "ru.yandex.metro",
      "app_version_name": "1.0"
    }
  ]
}

If you didn't find the answer you were looking for, you can use the feedback form to submit your question. Please describe the problem in as much detail as possible. Attach a screenshot if possible.

Contact support