Getting information about objects exported to Yandex Cloud
Returns information about objects exported to Yandex Cloud accounting for the specified counter.
Request
GET
https://api-metrika.yandex.net/export/v1/cloud/counter/{counterId}
Path parameters
|
Name |
Description |
|
counterId |
Type: integer Yandex Metrica counter ID. |
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 |
CloudExportStatistics
Export statistics.
|
Name |
Description |
|
bytes_per_second_by_day |
Type: integer Average number of bytes per second over one day. |
|
bytes_per_second_by_hour |
Type: integer Average number of bytes per second over one hour. |
|
bytes_per_second_by_month |
Type: integer Average number of bytes per second over one month. |
|
bytes_per_second_by_week |
Type: integer Average number of bytes per second over one week. |
|
bytes_per_second_by_year |
Type: integer Average number of bytes per second over one year. |
|
update_time |
Type: string<date-time> Update date in ISO 8601 format. For example, Example: |
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
List of cloud_export_table objects.
|
Name |
Description |
|
ce_id |
Type: integer Internal Yandex Metrica ID. Generated automatically when you create an export. |
|
columns |
Type: string[] Example |
|
statistics |
Type: CloudExportStatistics Export statistics. Example |
|
status |
Type: string Status of the table data export to Yandex Cloud:
Example: |
|
table_name |
Type: string Table name. Possible values:
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: |
|
owned |
Type: boolean |
|
site |
Type: string Example: |
Example
{
"counter_id": 0,
"owned": true,
"name": "example",
"site": "example"
}
CloudExport
List of cloud_exports objects.
|
Name |
Description |
|
folder_id |
Type: string Folder ID in Yandex Cloud. Pattern: Example: |
|
transfer_id |
Type: string Transfer ID in Yandex Cloud. Pattern: Example: |
|
ce_id |
Type: integer Internal Yandex Metrica ID. Generated automatically when you create an export. |
|
locked |
Type: boolean |
|
quota |
Type: integer Quota value. |
|
status |
Type: string Status of export to Yandex Cloud. Possible values:
Example: |
|
tables |
Type: CloudExportTable[] Example |
|
type |
Type: string 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.