Openings via deeplink

  1. Request format
  2. Response format
  3. Example

Request format

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

Filtering by the app's numeric ID in AppMetrica

date_since *

Start of the date range in the 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 the 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):

deeplink_url_host,deeplink_url_parameters,deeplink_url_path,deeplink_url_scheme,event_datetime,event_receive_datetime,event_receive_timestamp,event_timestamp,is_reengagement,profile_id,publisher_id,publisher_name,session_id,tracker_name,tracking_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,original_device_model,os_version,windows_aid,app_build_number,app_package_name,app_version_name
date_dimension
The parameter defines what date and time are used as a condition for getting into the data sample:
  • default — When the event occurred on the device;
  • receive — When the server received event information.
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.

*  Required

Response format

If all available fields are requested:
{
  "data": [
    {
      "deeplink_url_host": "string",
      "deeplink_url_parameters": "string",
      "deeplink_url_path": "string",
      "deeplink_url_scheme": "string",
      "event_datetime": "string",
      "event_receive_datetime": "string",
      "event_receive_timestamp": "integer",
      "event_timestamp": "integer",
      "is_reengagement": "boolean",
      "profile_id": "string",
      "publisher_id": "integer",
      "publisher_name": "string",
      "session_id": "integer",
      "tracker_name": "string",
      "tracking_id": "integer",
      "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",
      "device_type": "string",
      "google_aid": "string",
      "ios_ifa": "string",
      "ios_ifv": "string",
      "mcc": "integer",
      "mnc": "integer",
      "original_device_model": "string",
      "os_version": "string",
      "windows_aid": "string",
      "app_build_number": "integer",
      "app_package_name": "string",
      "app_version_name": "string"
    },
    ...
  ]
}
deeplink_url_host
The deeplink domain name. For example, for the following link [scheme]:[//host][/path][?parameters], it returns host.
deeplink_url_parameters
Parameters that are passed to deeplink. For more information about transmitting parameters, see Parameters of the tracking URL.
deeplink_url_path
URL path of the deeplink. For example, for the following link [scheme]:[//host][/path][?parameters], it returns path.
deeplink_url_scheme
URL scheme of the deeplink. For example, for the following link [scheme]:[//host][/path][?parameters], it returns scheme.
event_datetime
Date and time of the event in the yyyy-mm-dd hh:mm:ss format.
event_receive_datetime
Date and time the event was received on the server side. May differ from event_datetime due to network delays or if the user's device was not connected at the time of the event.
event_receive_timestamp
Time when the event was received on the server side, in the UNIX timestamp format. May differ from event_timestamp due to network delays or if the user's device was not connected at the time of the event.
event_timestamp
Time of the event in the UNIX timestamp format.
is_reengagement
Indicates that the tracker was created for a remarketing campaign.
profile_id
User profile ID.
publisher_id
ID of the AppMetrica publisher. You may use it to identify the publisher in AppMetrica reports.
publisher_name
Name of the AppMetrica partner.
session_id
Session ID.
tracker_name
Name of the tracker being added to the AppMetrica interface
tracking_id
ID of the AppMetrica tracker. You may use it to identify the publisher in AppMetrica reports.
android_id
The 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 event, in the 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).
device_type
The device type detected by the AppMetrica service. Possible values: phone | tablet | unknown.
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.
original_device_model
Device model from the manufacturer (e.g. for Galaxy S8 the following values are possible: SM-G9550, SM-G9558, etc.).
os_version
The version of the operating system on the user's device.
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/deeplinks.json?application_id=1111&date_since=2018-10-10&date_until=2018-10-11&fields=deeplink_url_host,deeplink_url_parameters,deeplink_url_path,deeplink_url_scheme,event_datetime,event_receive_datetime,event_receive_timestamp,event_timestamp,is_reengagement,profile_id,publisher_id,publisher_name,session_id,tracker_name,tracking_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,original_device_model,os_version,windows_aid,app_build_number,app_package_name,app_version_name' \
  -H 'Authorization: OAuth oauth_token'

Response:

{
  "data": [
    {
      "deeplink_url_host": "",
      "deeplink_url_parameters": "custom_parameter=value1&another_param=value2",
      "deeplink_url_path": "",
      "deeplink_url_scheme": "myscheme",
      "event_datetime": "yyyy-mm-dd hh:mm:ss",
      "event_receive_datetime": "yyyy-mm-dd hh:mm:ss",
      "event_receive_timestamp": "1556258667",
      "event_timestamp": "1556258660",
      "is_reengagement": "false",
      "profile_id": "test",
      "publisher_id": "39",
      "publisher_name": "AdColony",
      "session_id": "10000000049",
      "tracker_name": "Аdvertising iOS campaign",
      "tracking_id": "12345678901234567890",
      "android_id": "",
      "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",
      "device_type": "phone",
      "google_aid": "",
      "ios_ifa": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "ios_ifv": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
      "mcc": "250",
      "mnc": "1",
      "original_device_model": "iPhone10,3",
      "os_version": "12.2",
      "windows_aid": "",
      "app_build_number": "1",
      "app_package_name": "ru.yandex.metro",
      "app_version_name": "1.0"
    }
  ]
}