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

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

Request

GET

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

Path parameters

Name

Description

counterId

Type: integer

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

Responses

200 OK

OK

Body

application/json
{
  "cloud_exports": [
    {
      "ce_id": 0,
      "folder_id": "example",
      "transfer_id": "example",
      "status": "example",
      "quota": 0,
      "create_time": "2025-01-01T00:00:00Z",
      "type": "example",
      "locked": true,
      "counter_ids": [
        0
      ],
      "tables": [
        {
          "ce_table_id": 0,
          "ce_id": 0,
          "table_name": "example",
          "status": "example",
          "delete_time": "2025-01-01T00:00:00Z",
          "create_time": "2025-01-01T00:00:00Z",
          "columns": [
            null
          ],
          "humanized_table_name": "example",
          "statistics": {},
          "date1": "2025-01-01",
          "date2": "2025-01-01",
          "progress": 0.5,
          "removed_counters": [
            null
          ]
        }
      ],
      "counters": [
        {
          "counter_id": 0,
          "owned": true,
          "name": "example",
          "site": "example"
        }
      ]
    }
  ]
}

Name

Description

cloud_exports

Type: CloudExport[]

Example
[
  {
    "ce_id": 0,
    "folder_id": "example",
    "transfer_id": "example",
    "status": "example",
    "quota": 0,
    "create_time": "2025-01-01T00:00:00Z",
    "type": "example",
    "locked": true,
    "counter_ids": [
      0
    ],
    "tables": [
      {
        "ce_table_id": 0,
        "ce_id": 0,
        "table_name": "example",
        "status": "example",
        "delete_time": "2025-01-01T00:00:00Z",
        "create_time": "2025-01-01T00:00:00Z",
        "columns": [
          "example"
        ],
        "humanized_table_name": "example",
        "statistics": {
          "bytes_per_second_by_hour": 0,
          "bytes_per_second_by_day": 0,
          "bytes_per_second_by_week": 0,
          "bytes_per_second_by_month": 0,
          "bytes_per_second_by_year": 0,
          "update_time": "2025-01-01T00:00:00Z"
        },
        "date1": "2025-01-01",
        "date2": "2025-01-01",
        "progress": 0.5,
        "removed_counters": [
          {}
        ]
      }
    ],
    "counters": [
      null
    ]
  }
]

CloudExportStatistics

Статистика по экспорту.

Name

Description

bytes_per_second_by_day

Type: integer

Среднее количество байт в секунду, период расчета — сутки.

bytes_per_second_by_hour

Type: integer

Среднее количество байт в секунду, период расчета — час.

bytes_per_second_by_month

Type: integer

Среднее количество байт в секунду, период расчета — месяц.

bytes_per_second_by_week

Type: integer

Среднее количество байт в секунду, период расчета — неделя.

bytes_per_second_by_year

Type: integer

Среднее количество байт в секунду, период расчета — год.

update_time

Type: string<date-time>

Дата обновления в формате ISO 8601, например 2024-03-04T17:10:03Z.

Example: 2025-01-01T00:00:00Z
Example
{
  "bytes_per_second_by_hour": 0,
  "bytes_per_second_by_day": 0,
  "bytes_per_second_by_week": 0,
  "bytes_per_second_by_month": 0,
  "bytes_per_second_by_year": 0,
  "update_time": "2025-01-01T00:00:00Z"
}

CloudExportTable

Список объектов cloud_export_table.

Name

Description

ce_id

Type: integer

Внутренний идентификатор Метрики. Автоматически генерируется при создании экспорта.

columns

Type: string[]

Example
[
  "example"
]

statistics

Type: CloudExportStatistics

Статистика по экспорту.

Example
{
  "bytes_per_second_by_hour": 0,
  "bytes_per_second_by_day": 0,
  "bytes_per_second_by_week": 0,
  "bytes_per_second_by_month": 0,
  "bytes_per_second_by_year": 0,
  "update_time": "2025-01-01T00:00:00Z"
}

status

Type: string

Статус экспорта таблицы с данными в Yandex Cloud:

  • NEW — Таблица новая, не экспортировалась.
  • ACTIVATING — Экспорт таблицы в процессе.
  • ACTIVE — Экспорт таблицы включен.
  • DELETING — Экспорт таблицы отключается.
  • DELETED — Экспорт таблицы отключен.

Example: example

table_name

Type: string

Название таблицы. Возможные значения:

  • HITS — Метрика хиты.
  • HITS_V2 — Метрика обновляемые хиты.
  • VISITS — Метрика визиты.

Example: example
Example
{
  "ce_id": 0,
  "table_name": "example",
  "status": "example",
  "columns": [
    "example"
  ],
  "statistics": {
    "bytes_per_second_by_hour": 0,
    "bytes_per_second_by_day": 0,
    "bytes_per_second_by_week": 0,
    "bytes_per_second_by_month": 0,
    "bytes_per_second_by_year": 0,
    "update_time": "2025-01-01T00:00:00Z"
  }
}

CounterWithBasicData

Name

Description

counter_id

Type: integer

name

Type: string

Example: example

owned

Type: boolean

site

Type: string

Example: example
Example
{
  "counter_id": 0,
  "owned": true,
  "name": "example",
  "site": "example"
}

CloudExport

Список объектов cloud_exports.

Name

Description

folder_id

Type: string

Идентификатор папки в Yandex Cloud.

Pattern: ^[0-9a-zA-Z]{10,64}$

Example: example

transfer_id

Type: string

Идентификатор трансфера в Yandex Cloud.

Pattern: ^[0-9a-zA-Z]{10,64}$

Example: example

ce_id

Type: integer

Внутренний идентификатор Метрики. Автоматически генерируется при создании экспорта.

locked

Type: boolean

quota

Type: integer

Значение квоты.

status

Type: string

Статус экспорта в Yandex Cloud. Возможные значения:

  • ACTIVE — экспорт включен.
  • DELETED — экспорт отключен.

Example: example

tables

Type: CloudExportTable[]

Example
[
  {
    "ce_table_id": 0,
    "ce_id": 0,
    "table_name": "example",
    "status": "example",
    "delete_time": "2025-01-01T00:00:00Z",
    "create_time": "2025-01-01T00:00:00Z",
    "columns": [
      "example"
    ],
    "humanized_table_name": "example",
    "statistics": {
      "bytes_per_second_by_hour": 0,
      "bytes_per_second_by_day": 0,
      "bytes_per_second_by_week": 0,
      "bytes_per_second_by_month": 0,
      "bytes_per_second_by_year": 0,
      "update_time": "2025-01-01T00:00:00Z"
    },
    "date1": "2025-01-01",
    "date2": "2025-01-01",
    "progress": 0.5,
    "removed_counters": [
      {
        "counter_id": 0,
        "owned": true,
        "name": "example",
        "site": "example"
      }
    ]
  }
]

type

Type: string

Example: example
Example
{
  "ce_id": 0,
  "folder_id": "example",
  "transfer_id": "example",
  "status": "example",
  "quota": 0,
  "type": "example",
  "locked": true,
  "tables": [
    {
      "ce_table_id": 0,
      "ce_id": 0,
      "table_name": "example",
      "status": "example",
      "delete_time": "2025-01-01T00:00:00Z",
      "create_time": "2025-01-01T00:00:00Z",
      "columns": [
        "example"
      ],
      "humanized_table_name": "example",
      "statistics": {
        "bytes_per_second_by_hour": 0,
        "bytes_per_second_by_day": 0,
        "bytes_per_second_by_week": 0,
        "bytes_per_second_by_month": 0,
        "bytes_per_second_by_year": 0,
        "update_time": "2025-01-01T00:00:00Z"
      },
      "date1": "2025-01-01",
      "date2": "2025-01-01",
      "progress": 0.5,
      "removed_counters": [
        {
          "counter_id": 0,
          "owned": true,
          "name": "example",
          "site": "example"
        }
      ]
    }
  ]
}

No longer supported, please use an alternative and newer version.

Предыдущая
Список доступных клиентов
Следующая
Отключение экспорта на счетчике