Getting information about objects exported to Yandex Cloud

Returns information about objects exported to Yandex Cloud accounting for the specified tag.

Request

GET

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

Path parameters

Name

Description

counterId

Type: integer

Yandex Metrica tag ID.

Responses

200 OK

Body

application/json

{
  "cloud_exports": [
    {
      "ce_id": 0,
      "folder_id": "example",
      "transfer_id": "example",
      "status": "example",
      "quota": 0,
      "type": "example",
      "locked": true,
      "tables": [
        {
          "ce_id": 0,
          "table_name": "example",
          "status": "example",
          "columns": [
            null
          ],
          "statistics": {}
        }
      ]
    }
  ]
}

Name

Description

cloud_exports

Type: CloudExport[]

Example

[
  {
    "ce_id": 0,
    "folder_id": "example",
    "transfer_id": "example",
    "status": "example",
    "quota": 0,
    "type": "example",
    "locked": true,
    "tables": [
      {
        "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"
        }
      }
    ]
  }
]

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, `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

List of cloud_export_table objects.

Name	Description
ce_id	Type: integer Internal Yandex Metrica ID. Generated automatically when creating an export.
columns	Type: string[] Example `[ "example" ]`
statistics	Type: CloudExportStatistics Export statistics. 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 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. Example: `example`
table_name	Type: string Table name. Possible values: `HITS`: Yandex Metrica, hits. `HITS_V2`: Yandex Metrica, refresh hits. `VISITS`: Yandex Metrica, sessions. 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"
  }
}

CloudExport

List of cloud_exports objects.

Name	Description
folder_id	Type: string Folder ID in Yandex Cloud. Pattern: `^[0-9a-zA-Z]{10,64}$` Example: `example`
transfer_id	Type: string Transfer ID in Yandex Cloud. Pattern: `^[0-9a-zA-Z]{10,64}$` Example: `example`
ce_id	Type: integer Internal Yandex Metrica ID. Generated automatically when creating an export.
locked	Type: boolean
quota	Type: integer Quota value.
status	Type: string Status of export to Yandex Cloud. Possible values: `ACTIVE`: Export enabled. `DELETED`: Export disabled. Example: `example`
tables	Type: CloudExportTable[] 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" } } ]`
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_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"
      }
    }
  ]
}

Was the article helpful?

List of accessible clients

Disabling export for the tag