Получение информации об объектах, которые экспортируются в Yandex Cloud

Возвращает информацию об объектах, которые экспортируются в Yandex Cloud, с учетом указанного счетчика.

  1. Синтаксис запроса
  2. Формат ответа

Синтаксис запроса

counterId — идентификатор счетчика Метрики.

https://api-metrika.yandex.net/export/v1/cloud/counter/{counterId}
 ? 

Формат ответа


{
    "cloud_exports" : [ {
        "ce_id" :  < integer > ,
        "folder_id" :  < string > ,
        "transfer_id" :  < string > ,
        "status" :  < cloud_export_status > ,
        "quota" :  < long > ,
        "tables" : [ {
            "ce_id" :  < integer > ,
            "table_name" :  < cloud_export_table_name > ,
            "status" :  < cloud_export_table_status > ,
            "columns" : [  < string > , ... ],
            "statistics" : {
                "bytes_per_second_by_hour" :  < long > ,
                "bytes_per_second_by_day" :  < long > ,
                "bytes_per_second_by_week" :  < long > ,
                "bytes_per_second_by_month" :  < long > ,
                "bytes__per_second_by_year" :  < long > ,
                "update_time" :  < instant > 
            }
        }, ... ]
    }, ... ]
}
Параметры Описание
cloud_exports Список объектов cloud_exports.
cloud_exports
ce_id Внутренний идентификатор Метрики. Автоматически генерируется при создании экспорта.
folder_id Идентификатор папки в Yandex Cloud.
transfer_id Идентификатор трансфера в Yandex Cloud.
status Статус экспорта в Yandex Cloud.

Возможные значения:

  • ACTIVE — Экспорт включен.
  • DELETED — Экспорт отключен.
quota Значение квоты.
tables Список объектов cloud_export_table.
tables
ce_id Внутренний идентификатор Метрики. Автоматически генерируется при создании экспорта.
table_name Название таблицы.

Возможные значения:

  • HITS — Метрика хиты.
  • HITS_V2 — Метрика обновляемые хиты.
  • VISITS — Метрика визиты.
status Статус экспорта таблицы с данными в Yandex Cloud.

Возможные значения:

  • NEW — Таблица новая, не экспортировалась.
  • ACTIVATING — Экспорт таблицы в процессе.
  • ACTIVE — Экспорт таблицы включен.
  • DELETING — Экспорт таблицы отключается.
  • DELETED — Экспорт таблицы отключен.
columns Список столбцов таблицы для экспорта в Yandex Cloud.
statistics Статистика по экспорту.
statistics
bytes_per_second_by_hour Среднее количество байт в секунду, период расчета — час.
bytes_per_second_by_day Среднее количество байт в секунду, период расчета — сутки.
bytes_per_second_by_week Среднее количество байт в секунду, период расчета — неделя.
bytes_per_second_by_month Среднее количество байт в секунду, период расчета — месяц.
bytes__per_second_by_year Среднее количество байт в секунду, период расчета — год.
update_time Дата обновления в формате ISO 8601, например 2024-03-04T17:10:03Z.
Параметры Описание
cloud_exports Список объектов cloud_exports.
cloud_exports
ce_id Внутренний идентификатор Метрики. Автоматически генерируется при создании экспорта.
folder_id Идентификатор папки в Yandex Cloud.
transfer_id Идентификатор трансфера в Yandex Cloud.
status Статус экспорта в Yandex Cloud.

Возможные значения:

  • ACTIVE — Экспорт включен.
  • DELETED — Экспорт отключен.
quota Значение квоты.
tables Список объектов cloud_export_table.
tables
ce_id Внутренний идентификатор Метрики. Автоматически генерируется при создании экспорта.
table_name Название таблицы.

Возможные значения:

  • HITS — Метрика хиты.
  • HITS_V2 — Метрика обновляемые хиты.
  • VISITS — Метрика визиты.
status Статус экспорта таблицы с данными в Yandex Cloud.

Возможные значения:

  • NEW — Таблица новая, не экспортировалась.
  • ACTIVATING — Экспорт таблицы в процессе.
  • ACTIVE — Экспорт таблицы включен.
  • DELETING — Экспорт таблицы отключается.
  • DELETED — Экспорт таблицы отключен.
columns Список столбцов таблицы для экспорта в Yandex Cloud.
statistics Статистика по экспорту.
statistics
bytes_per_second_by_hour Среднее количество байт в секунду, период расчета — час.
bytes_per_second_by_day Среднее количество байт в секунду, период расчета — сутки.
bytes_per_second_by_week Среднее количество байт в секунду, период расчета — неделя.
bytes_per_second_by_month Среднее количество байт в секунду, период расчета — месяц.
bytes__per_second_by_year Среднее количество байт в секунду, период расчета — год.
update_time Дата обновления в формате ISO 8601, например 2024-03-04T17:10:03Z.