E-commerce

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):

ecom_type,ecom_screen_name,ecom_screen_search_query,ecom_screen_payload,ecom_screen_category_path_1,ecom_screen_category_path_2,ecom_screen_category_path_3,ecom_screen_category_path_4,ecom_screen_category_path_5,ecom_screen_category_path_6,ecom_screen_category_path_7,ecom_screen_category_path_8,ecom_screen_category_path_9,ecom_screen_category_path_10,ecom_product_name,ecom_product_sku,ecom_product_promocodes,ecom_product_payload,ecom_product_category_path_1,ecom_product_category_path_2,ecom_product_category_path_3,ecom_product_category_path_4,ecom_product_category_path_5,ecom_product_category_path_6,ecom_product_category_path_7,ecom_product_category_path_8,ecom_product_category_path_9,ecom_product_category_path_10,ecom_product_actual_price_fiat_unit_type,ecom_product_actual_price_fiat_value,ecom_product_actual_price_internal_components,ecom_product_original_price_fiat_unit_type,ecom_product_original_price_fiat_value,ecom_product_original_price_internal_components,ecom_cart_item_price_fiat_unit_type,ecom_cart_item_price_fiat_value,ecom_cart_item_quantity,ecom_cart_item_internal_components,ecom_referrer_type,ecom_referrer_id,ecom_order_id,ecom_order_payload,event_datetime,event_name,event_receive_datetime,event_receive_timestamp,event_timestamp,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,event_datetime,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.

ecom_type

Purchase event type. Possible values:

• show_screen
• show_product_card
• show_product_details
• add_cart_item
• remove_cart_item
• begin_checkout
• purchase

ecom_screen_name

Screen name.

ecom_screen_search_query

Search query.

ecom_screen_payload

Screen parameters as passed to the SDK. The format is a JSON object with string key-value pairs, for example:

{
  "configuration": "landscape",
  "fullscreen": "true"
}

ecom_screen_category_path_1

Screen category. Level 1.

ecom_screen_category_path_2

Screen category. Level 2.

ecom_screen_category_path_3

Screen category. Level 3.

ecom_screen_category_path_4

Screen category. Level 4.

ecom_screen_category_path_5

Screen category. Level 5.

ecom_screen_category_path_6

Screen category. Level 6.

ecom_screen_category_path_7

Screen category. Level 7.

ecom_screen_category_path_8

Screen category. Level 8.

ecom_screen_category_path_9

Screen category. Level 9.

ecom_screen_category_path_10

Screen category. Level 10.

ecom_product_name

Product name.

ecom_product_sku

Product ID.

ecom_product_promocodes

Product promo codes. The format is a JSON array of strings, for example:

["BT79IYX", "UT5412EP"]

ecom_product_payload

Product parameters as passed to the SDK. The format is a JSON object with string key-value pairs, for example:

{
  "configuration": "landscape",
  "fullscreen": "true"
}

ecom_product_category_path_1

Product category. Level 1.

ecom_product_category_path_2

Product category. Level 2.

ecom_product_category_path_3

Product category. Level 3.

ecom_product_category_path_4

Product category. Level 4.

ecom_product_category_path_5

Product category. Level 5.

ecom_product_category_path_6

Product category. Level 6.

ecom_product_category_path_7

Product category. Level 7.

ecom_product_category_path_8

Product category. Level 8.

ecom_product_category_path_9

Product category. Level 9.

ecom_product_category_path_10

Product category. Level 10.

ecom_product_actual_price_fiat_unit_type

Currency of the actual product price.

ecom_product_actual_price_fiat_value

Actual product price.

ecom_product_actual_price_internal_components

Components of the actual product price. The format is an array of JSON objects with one key-value pair each, for example:

[
  { "wood": 25.01 },
  { "iron": 10 }
]

ecom_product_original_price_fiat_unit_type

Currency of the base product price.

ecom_product_original_price_fiat_value

Base product price.

ecom_product_original_price_internal_components

Components of the base product price. The format is an array of JSON objects with one key-value pair each, for example:

[
  { "wood": 25.01 },
  { "iron": 10 }
]

ecom_cart_item_price_fiat_unit_type

Price currency for the item in the cart.

ecom_cart_item_price_fiat_value

Price of the item in the cart.

ecom_cart_item_quantity

Number of items in the cart.

ecom_cart_item_internal_components

Price components for the item in the cart. The format is an array of JSON objects with one key-value pair each, for example:

[
  { "wood": 25.01 },
  { "iron": 10 }
]

ecom_referrer_type

Traffic source type.

ecom_referrer_id

Traffic source ID.

ecom_order_id

Purchase ID.

ecom_order_payload

Purchase parameters as passed to the SDK. The format is a JSON object with string key-value pairs, for example:

{
  "configuration": "landscape",
  "fullscreen": "true"
}

event_datetime

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

event_name

Name of the event (as passed to the SDK).

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 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 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.

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.

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).

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.

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_name

Operating system on the user's device: ios | android | windows.

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.

application_id

Unique numeric identifier for the application in AppMetrica.