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<int32>

Yandex Metrica counter ID.
Example: 2215573

Responses

200 OK

Body

application/json

{
    "cloud_exports": [
        {
            "ce_id": 0,
            "folder_id": "string",
            "transfer_id": "string",
            "status": "string",
            "quota": 0,
            "type": "string",
            "locked": false,
            "tables": [
                {
                    "ce_id": 0,
                    "table_name": "string",
                    "status": "string",
                    "columns": [
                        "string"
                    ],
                    "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": "2022-12-29T18:02:01Z"
                    }
                }
            ]
        }
    ]
}

Name

Description

cloud_exports

Type: CloudExport[]

List of cloud_exports objects.

CloudExport

List of cloud_exports objects.

Name	Description
folder_id*	Type: string Folder ID in Yandex Cloud. Pattern: `^[0-9a-zA-Z]{10,64}$`
transfer_id*	Type: string Transfer ID in Yandex Cloud. Pattern: `^[0-9a-zA-Z]{10,64}$`
ce_id	Type: integer<int32> Internal Yandex Metrica ID. Generated automatically when you create an export.
locked	Type: boolean
quota	Type: integer<int64> Quota value.
status	Type: string Status of export to Yandex Cloud. Possible values: `ACTIVE`: Export enabled. `DELETED`: Export disabled.
tables	Type: CloudExportTable[] List of `cloud_export_table` objects.
type	Type: string

CloudExportTable

List of cloud_export_table objects.

Name	Description
ce_id	Type: integer<int32> Internal Yandex Metrica ID. Generated automatically when you create an export.
columns	Type: string[] List of the table columns that you want to export to Yandex Cloud.
statistics	Type: CloudExportStatistics Export statistics.
status	Type: string Status of the table data export to Yandex Cloud: `NEW`: New table, never exported. `ACTIVATING`: Table export in progress. `ACTIVE`: Table export is enabled. `DELETING`: Disabling table export. `DELETED`: Table export is disabled.
table_name	Type: string Table name. Possible values: `HITS`: Yandex Metrica, hits. `HITS_V2`: Yandex Metrica, refresh hits. `VISITS`: Yandex Metrica, sessions.

CloudExportStatistics

Export statistics.

Name	Description
bytes_per_second_by_day	Type: integer<int64> Average number of bytes per second over one day.
bytes_per_second_by_hour	Type: integer<int64> Average number of bytes per second over one hour.
bytes_per_second_by_month	Type: integer<int64> Average number of bytes per second over one month.
bytes_per_second_by_week	Type: integer<int64> Average number of bytes per second over one week.
bytes_per_second_by_year	Type: integer<int64> Average number of bytes per second over one year.
update_time	Type: string<date-time> Update date in ISO 8601 format. For example, `2024-03-04T17:10:03Z`.