Stream status

返回每种事件类型的流列表。 每个流包含一个 5 分钟窗口列表,其中包含数据大小和导出字段的组成。

请求格式

GET https://api.appmetrica.yandex.com/datastream/v1/application/{id}/status

id

App ID

响应格式

{
    "status": {
        "streams": [
            {
                "data_type": string,
                "stream_windows": [
                    {
                        "stream_window_timestamp": int,
                        "export_schema_id": int,
                        "payload_bytes": int,
                        "event_count": int,
                        "update_timestamp": int
                    },
                    ...
                ]
            },
            ...
        ],
        "export_fields": [
            {
                "export_schema_id": int,
                "field_names": [
                    "event_datetime",
                    "event_json",
                    "event_name",
                    "event_timestamp",
                    "session_id",
                    "installation_id",
                    "appmetrica_device_id",
                    "city",
                    "connection_type",
                    "country_iso_code",
                    ...
                ]
            },
            ...
        ]
    }
}

status

API 响应。

status.streams

包含导出数据的流列表。

status.streams[i].data_type

构成流的数据类型。

可接受的值:

  • event
  • installation
  • session_start
  • session_end
  • push_token
  • crash
  • error
  • click
  • revenue
  • ecommerce
  • ad_revenue
  • attributed_event
  • deeplink

status.streams[i].stream_windows

流窗口列表。

status.streams[i].stream_windows[j].stream_window_timestamp

指向数据窗口的 Unix 时间戳(以秒为单位)。 用于指定下载数据的窗口。

status.streams[i].stream_windows[j].export_schema_id

CSV 字段集的 ID。

status.streams[i].stream_windows[j].payload_bytes

CSV 文件的大小(以字节为单位),不包括 CSV 标头。

status.streams[i].stream_windows[j].event_count

CSV 文件中的事件数量。

status.streams[i].stream_windows[j].update_timestamp

Unix 时间戳(以秒为单位)。 指示此窗口中最后一次数据更改的时间。 更改发生在当前正在追加数据的最后几个窗口中。

status.export_fields

包含用于生成数据窗口的 CSV 字段集列表。

status.export_fields[i].export_schema_id

CSV 字段集的 ID。

status.export_fields[i].field_names

为导出选择的字段的字符串名称列表。 关于字段的更多信息,请参见导出的数据类型。

Example

请求:

curl -X GET 'https://api.appmetrica.yandex.com/datastream/v1/application/1111/status' \
-H 'Authorization: OAuth oauth_token'

响应:

{
    "status": {
        "streams": [
            {
                "data_type": string,
                "stream_windows": [
                    {
                        "stream_window_timestamp": int,
                        "export_schema_id": int,
                        "payload_bytes": int,
                        "event_count": int,
                        "update_timestamp": int
                    },
                    ...
                ]
            },
            ...
        ],
        "export_fields": [
            {
                "export_schema_id": int,
                "field_names": [
                    "event_datetime",
                    "event_json",
                    "event_name",
                    "event_timestamp",
                    "session_id",
                    "installation_id",
                    "appmetrica_device_id",
                    "city",
                    "connection_type",
                    "country_iso_code",
                    ...
                ]
            },
            ...
        ]
    }
}

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

联系支持 为文档提出改进建议
上一篇
下一篇