应用事件

返回特定日期范围内的事件数据。

请求格式

获取 https://api.appmetrica.yandex.com/logs/v1/export/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>]
  & [skip_unavailable_shards=<bool>]

应用ID*

按应用在 AppMetrica 中的数字 ID 过滤。

date_since*

日期范围的开始，格式为 yyyy-mm-dd hh:mm:ss。 您还可以定义影响 date_dimension 查询参数中数据的日期和时间类型。

date_until*

日期范围的结束，格式为 yyyy-mm-dd hh:mm:ss。 您还可以定义影响 date_dimension 查询参数中数据的日期和时间类型。

fields*

用逗号分隔的字段列表，用于示例。

一个包含所有可用字段的列表（便于快速复制）：

event_datetime,event_json,event_name,event_receive_datetime,event_receive_timestamp,event_timestamp,session_id,installation_id,appmetrica_device_id,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_name,os_version,profile_id,windows_aid,app_build_number,app_package_name,app_version_name,application_id

日期维度

此参数定义计算日期范围的起点：

  • default：事件在设备上发生时。
  • receive：服务器收到事件信息时。

限制

列表中项目数量的限制。 默认取最大值。 不保证请求之间的结果一致（结果排序可能存在差异）。

使用_utf8_bom

启用字节顺序标记使用的参数。 默认值为 false。

<any field name>

按可用字段之一的值过滤。 仅支持相等检查操作。

跳过不可用的分片

用于提高数据可用性。 默认值为 false。

响应格式

如果请求了所有可用的字段：

{
  "data": [
    {
      "event_datetime": "string",
      "event_json": "string",
      "event_name": "string",
      "event_receive_datetime": "string",
      "event_receive_timestamp": "integer",
      "event_timestamp": "integer",
      "session_id": "integer",
      "installation_id": "string",
      "appmetrica_device_id": "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",
      "operator_name": "string",
      "original_device_model": "string",
      "os_name": "string",
      "os_version": "string",
      "profile_id": "string",
      "windows_aid": "string",
      "app_build_number": "integer",
      "app_package_name": "string",
      "app_version_name": "string",
      "application_id": "integer"
    },
    ...
  ]
}

应用ID,ios_ifa,操作系统名称,...
1111,024AE7EB-4128-4237-9803-D24950323D4D,ios,...
1111,3A86D5E8-1985-4A23-B147-5A1C0CF8781E,ios,...
1111,,android
...

event_datetime

事件的日期和时间，格式为 yyyy-mm-dd hh:mm:ss。

event_json

序列化为 JSON 的事件属性。

event_name

事件名称（按传递给 SDK 的方式）。

事件接收日期时间

服务器端收到事件的日期和时间。 由于网络延迟或用户设备在事件发生时未连接，可能与 event_datetime 不同。

事件接收时间戳

服务器端收到事件的时间，格式为 Unix time。 由于网络延迟或用户设备在事件发生时未连接，可能与 event_timestamp 不同。

event_timestamp

事件的时间，格式为 Unix time。

使用 Post API，您只能在事件日期（event_timestamp）与上传日期之间的差异不超过 14 天时上传事件。 API 期望以秒为单位的值。

session_id

会话 ID。 installation_id、session_id 和平台设备 ID（google_aid / ios_ifa）的值集允许您唯一标识用户的会话。

installation_id

安装 ID。

城市

城市名称（英文）。

连接类型

连接类型。 可能的值：wifi | cell | unknown。

country_iso_code

ISO 国家代码。

device_ipv6

事件时的 IP 地址，格式为 IPv6。 例如，2a02:6b8::40c:6676:baff:fea6:53d8, ::ffff:5.255.232.147。

device_locale

设备上的语言。

设备制造商

AppMetrica 服务检测到的设备制造商（例如，Apple 或 Samsung）。

设备型号

AppMetrica 服务检测到的设备型号（例如，Galaxy S6）。

device_type

AppMetrica 服务检测到的设备类型。 可能的值：phone | tablet | unknown。

google_aid

设备的 Google AID，格式为从设备接收的格式。

ios_ifa

设备的 IFA，格式为从设备接收的格式。

ios_ifv

应用的 IFV，格式为从设备接收的格式。

mcc

移动国家代码。

mnc

移动网络代码。

operator_name

移动运营商名称。

原始设备型号

设备的出厂型号（例如，对于 Galaxy S8，可能的值有：SM-G9550、SM-G9558 等）。

os_name

用户设备上的操作系统：ios | android | windows。

os_version

用户设备上的操作系统版本。

profile_id

用户个人资料 ID。

windows_aid

设备的 Windows AID，格式为从设备接收的格式。

应用构建号

应用构建号。

应用程序包名

Android 的包名，或 iOS 的 Bundle ID（例如，ru.yandex.metro）。

app_version_name

开发者指定的应用版本格式。

application_id

应用在 AppMetrica 中的唯一数字标识符。

Example

请求：

curl -X GET \
  'https://api.appmetrica.yandex.com/logs/v1/export/events.json?application_id=1111&date_since=2018-10-10&date_until=2018-10-11&fields=event_datetime,event_json,event_name,event_receive_datetime,event_receive_timestamp,event_timestamp,session_id,installation_id,appmetrica_device_id,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_name,os_version,profile_id,windows_aid,app_build_number,app_package_name,app_version_name,application_id' \
  -H 'Authorization: OAuth oauth_token'

响应:

{
  "data": [
    {
      "event_datetime": "yyyy-mm-dd hh:mm:ss",
      "event_json": "{\"name\":\"Alice\", \"age\":\"18\", \"favorite_games\":{\"strategies\":\"Age of Empires\"}}",
      "event_name": "New person",
      "event_receive_datetime": "yyyy-mm-dd hh:mm:ss",
      "event_receive_timestamp": "1556258667",
      "event_timestamp": "1556258660",
      "session_id": "10000000049",
      "installation_id": "installation_id__example",
      "appmetrica_device_id": "123456789012345678",
      "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",
      "operator_name": "MTS RUS",
      "original_device_model": "iPhone10,3",
      "os_name": "ios",
      "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",
      "application_id": "1111"
    }
  ]
}

另请参见

如果您没有找到所需答案，可以通过反馈表单提交您的问题。 请尽可能详细地描述问题。 如果可能，请附上截图。

联系支持 为文档提出改进建议
上一篇
回传
下一篇
电子商务