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.

  1. Request format
  2. Response format
  3. Example

Request format

GET /datastream/v1/application/{id}/status
idApp ID.
idApp 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",
                    ...
                ]
            },
            ...
        ]
    }
}
Copied to clipboard
status
API response.
streams
List of streams with export data.
data_type

Data type from which the stream is generated.

Acceptable values:
  • event.
  • installation.
  • session_start.
  • push_token.
  • crash.
  • error.
stream_windows
List of stream windows.
stream_window_timestamp
Unix timestamp in seconds pointing to the data window. It is used to specify a window for downloading data.
export_schema_id
ID of the set of CSV fields.
payload_bytes
The size of the CSV file in bytes, excluding the CSV header.
event_count
The number of events in the CSV file.
update_timestamp
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.
export_fields
Contains a list of sets of CSV fields that were used to generate data windows.
export_schema_id
ID of the set of CSV fields.
field_names
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 '/datastream/v1/application/1111/status' \
-H 'Authorization: OAuth oauth_token'
Copied to clipboard

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",
                    ...
                ]
            },
            ...
        ]
    }
}
Copied to clipboard