Getting information about objects exported to Yandex Cloud

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

  1. Request syntax
  2. Response format

Request syntax

counterId: Yandex Metrica tag ID.

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

Sample request


GET https://api-metrika.yandex.net/export/v1/cloud/counter/2215573

Response format


{
    "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 > 
            }
        }, ... ]
    }, ... ]
}
Parameters Description
cloud_exports List of cloud_exports objects.
cloud_exports
ce_id Internal Yandex Metrica ID. Generated automatically when creating an export.
folder_id Folder ID in Yandex Cloud.
transfer_id Transfer ID in Yandex Cloud.
status Status of export to Yandex Cloud.

Possible values:

  • ACTIVE: Export enabled.
  • DELETED: Export disabled.
quota Quota value.
tables List of cloud_export_table objects.
tables
ce_id Internal Yandex Metrica ID. Generated automatically when creating an export.
table_name Table name.

Possible values:

  • HITS: Yandex Metrica, hits.
  • HITS_V2: Yandex Metrica, refresh hits.
  • VISITS: Yandex Metrica, sessions.
status Status of table data export to Yandex Cloud.

Possible values:

  • NEW: New table, never exported.
  • ACTIVATING: Table export in progress.
  • ACTIVE: Table export is enabled.
  • DELETING: Disabling table export.
  • DELETED: Table export is disabled.
columns List of table columns to be exported to Yandex Cloud.
statistics Export statistics.
statistics
bytes_per_second_by_hour Average number of bytes per second over one hour.
bytes_per_second_by_day Average number of bytes per second over one day.
bytes_per_second_by_week Average number of bytes per second over one week.
bytes_per_second_by_month Average number of bytes per second over one month.
bytes__per_second_by_year Average number of bytes per second over one year.
update_time Update date in ISO 8601 format. For example, 2024-03-04T17:10:03Z.
Parameters Description
cloud_exports List of cloud_exports objects.
cloud_exports
ce_id Internal Yandex Metrica ID. Generated automatically when creating an export.
folder_id Folder ID in Yandex Cloud.
transfer_id Transfer ID in Yandex Cloud.
status Status of export to Yandex Cloud.

Possible values:

  • ACTIVE: Export enabled.
  • DELETED: Export disabled.
quota Quota value.
tables List of cloud_export_table objects.
tables
ce_id Internal Yandex Metrica ID. Generated automatically when creating an export.
table_name Table name.

Possible values:

  • HITS: Yandex Metrica, hits.
  • HITS_V2: Yandex Metrica, refresh hits.
  • VISITS: Yandex Metrica, sessions.
status Status of table data export to Yandex Cloud.

Possible values:

  • NEW: New table, never exported.
  • ACTIVATING: Table export in progress.
  • ACTIVE: Table export is enabled.
  • DELETING: Disabling table export.
  • DELETED: Table export is disabled.
columns List of table columns to be exported to Yandex Cloud.
statistics Export statistics.
statistics
bytes_per_second_by_hour Average number of bytes per second over one hour.
bytes_per_second_by_day Average number of bytes per second over one day.
bytes_per_second_by_week Average number of bytes per second over one week.
bytes_per_second_by_month Average number of bytes per second over one month.
bytes__per_second_by_year Average number of bytes per second over one year.
update_time Update date in ISO 8601 format. For example, 2024-03-04T17:10:03Z.