--- metadata: - name: generator content: Diplodoc Platform v5.50.6 alternate: - https://appmetrica.yandex.com.tr/docs/en/mobile-api/logs/ref/deeplinks.md - https://appmetrica.yandex.com.tr/docs/ru/mobile-api/logs/ref/deeplinks.md --- > **Documentation Index:** Fetch the complete configuration index at https://appmetrica.yandex.com.tr/docs/en/llms.txt # Openings via deeplink Returns openings via deeplink data for a specific date range. ## Request format {#request-format} ``` GET https://api.appmetrica.yandex.com/logs/v1/export/deeplinks.{csv | json} ? application_id= & date_since= & date_until= & fields= & [date_dimension=] & [limit=] & [use_utf8_bom=] & [=] & [skip_unavailable_shards=] ``` #| || `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](https://appmetrica.yandex.com.tr/docs/en/mobile-api/logs/endpoints.md) for the sample. A list that contains all available fields (for quick copy): ```objectivec translate=no 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,event_datetime,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` | 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`. || || `` | Filtering by the value of one of the available fields. Only the equality check operation is supported. || || `skip_unavailable_shards` | Used for [improving data accessibility](../request-procedure.md#availability). The default value is `false`. || |# ## Response format {#response-format} If all available fields are requested: {% list tabs %} - JSON ```json translate=no { "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" }, ... ] } ``` - CSV ``` application_id,ios_ifa,os_name,... 1111,024AE7EB-4128-4237-9803-D24950323D4D,ios,... 1111,3A86D5E8-1985-4A23-B147-5A1C0CF8781E,ios,... 1111,,android ... ``` {% endlist %} #| || `deeplink_url_host` | Deeplink domain name. For example, for a link formatted as `[scheme]:[//host][/path][?parameters]`, it returns `host`. || || `deeplink_url_parameters` | Parameters that are passed to the deeplink. For more information about passing parameters, see [Tracking URL parameters](https://appmetrica.yandex.com.tr/docs/en/mobile-tracking/tracking-specification.md#to-deeplink). || || `deeplink_url_path` | URL path of the deeplink. For example, for a link formatted as `[scheme]:[//host][/path][?parameters]`, it returns `path`. || || `deeplink_url_scheme` | URL scheme of the deeplink. For example, for a link formatted as `[scheme]:[//host][/path][?parameters]`, it returns `scheme`. || || `event_datetime` | Date and time of the event in `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 [Unix time](https://en.wikipedia.org/wiki/Unix_time) 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 [Unix time](https://en.wikipedia.org/wiki/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 14 days. The API expects a value in seconds. || || `is_reengagement` | Indicates that the tracker was created for a remarketing campaign. || || `profile_id` | User profile ID. || || `publisher_id` | ID of the AppMetrica publisher. || || `publisher_name` | Name of the AppMetrica partner. || || `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. || || `tracker_name` | Name of the tracker being added to the AppMetrica interface. || || `tracking_id` | ID of the AppMetrica tracker. || || `android_id` | Android device ID. || || `appmetrica_device_id` | A unique device identifier detected by the AppMetrica service. In Android from [AppSetId](https://developer.android.com/identity/app-set-id), in iOS from [IFV](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor). || || `appmetrica_sdk_version` | Version of the AppMetrica SDK. || || `city` | The name of the city 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](https://en.wikipedia.org/wiki/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` | 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. || || `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 {#example} Request: ```bash translate=no curl -X GET \ 'https://api.appmetrica.yandex.com/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: ```json translate=no { "data": [ { "deeplink_url_host": "deeplink_url_host__example", "deeplink_url_parameters": "custom_parameter=value1&another_param=value2", "deeplink_url_path": "deeplink_url_path__example", "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": "Advertising iOS campaign", "tracking_id": "12345678901234567890", "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", "device_type": "phone", "google_aid": "google_aid__example", "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": "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 Suggest an improvement for documentation