Stream status
Returns a list of streams for each event type. Each stream contains a list of 5-minute windows with data sizes and the composition of export fields.
Request format
GET https://api.appmetrica.yandex.ru/datastream/v1/application/{id}/status
|
|
App ID |
Response format
{
"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",
...
]
},
...
]
}
}
|
|
API response. |
|
|
List of streams with export data. |
|
|
The type of data that forms the stream. Acceptable values:
|
|
|
List of stream windows. |
|
|
Unix timestamp in seconds pointing to the data window. It is used to specify a window for downloading data. |
|
|
ID of the set of CSV fields. |
|
|
The size of the CSV file in bytes, excluding the CSV header. |
|
|
The number of events in the CSV file. |
|
|
Unix timestamp in seconds. Indicates the time of the last data change in this window. Changes occur in the last windows to which data is currently being appended. |
|
|
Contains a list of sets of CSV fields that were used to generate data windows. |
|
|
ID of the set of CSV fields. |
|
|
List of string names of fields selected for export. For more information about the fields, see Data types for export. |
Example
Request:
curl -X GET 'https://api.appmetrica.yandex.ru/datastream/v1/application/1111/status' \
-H 'Authorization: OAuth oauth_token'
Response:
{
"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",
...
]
},
...
]
}
}
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.