Состояние потока

Возвращает список потоков по каждому типу событий. Каждый поток содержит список 5-минутных окон с размерами данных и составом полей экспорта.

Формат запроса

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

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

Тип данных, из которых сформирован поток.

Допустимые значения:

  • event;
  • installation;
  • session_start;
  • session_end;
  • push_token;
  • crash;
  • error;
  • click;
  • revenue;
  • ecommerce;
  • ad_revenue.

status.streams.stream_windows

Список окон потока.

status.streams.stream_windows.stream_window_timestamp

Секундный unix-timestamp, указывающий на окно данных. Он используется для указания окна для скачивания данных.

status.streams.stream_windows.export_schema_id

Идентификатор набора полей CSV.

status.streams.stream_windows.payload_bytes

Размер файла CSV в байтах без учета заголовка CSV.

status.streams.stream_windows.event_count

Количество событий в файле CSV.

status.streams.stream_windows.update_timestamp

Секундный unix-timestamp. Означает время последнего изменения данных в данном окне. Изменения происходят в последних окнах, в которые данные дописываются в настоящее время.

status.export_fields

Содержит список наборов полей CSV, которые были использованы для формирования окон данных.

status.export_fields.export_schema_id

Идентификатор набора полей CSV.

status.export_fields.field_names

Список строковых имен полей, выбранных для экспорта. Подробнее о полях в статье Типы данных для экспорта.

Пример

Запрос:

curl -X GET 'https://api.appmetrica.yandex.ru/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",
                    ...
                ]
            },
            ...
        ]
    }
}

Если вы не нашли ответ на свой вопрос, то вы можете задать его через форму обратной связи. Пожалуйста, опишите возникшую проблему как можно подробнее. Если возможно, приложите скриншот.

Написать в службу поддержки
Предыдущая
Ресурсы API
Следующая
Скачивание данных