Table

ids*

Comma-separated list of counter numbers. Used instead of the id parameter.

metrics*

Comma-separated list of metrics.

Limit: 20 metrics per request.

accuracy

Accuracy of results. Allows you to manage sampling (the number of visits used to calculate the final value). Default value: medium.

callback

Callback function that processes the API response.

date1

Start date of the report period in the format YYYY-MM-DD. You can also use the values: today, yesterday, ndaysAgo.

Default value: 6daysAgo.

date2

End date of the report period in the format YYYY-MM-DD. You can also use the values: today, yesterday, ndaysAgo.

Default value: today.

dimensions

Comma-separated list of dimensions.

Limit: 10 dimensions per request.

filters

Segmentation filter.

Limit: Maximum of 10 unique dimensions and metrics, 20 separate filters, and 10,000 characters per filter string.

group

Grouping data by time. Default value: week.

Acceptable values:

• all — The time range is not broken down.
• hours — The time range is divided into intervals of several hours.
• auto — Automatic mode.
• week — The time range is divided into weeks.
• month — The time range is divided into months.
• hour — The time range is divided into hourly intervals.
• year — The time range is divided into years.
• minutes — The time range is divided into intervals of a certain number of minutes.
• day — The time range is divided into days.
• dekaminute — The time range is divided into 10-minute intervals.
• quarter — The time range is divided into quarters.
• minute — The time range is divided into one-minute intervals.

id

The tag number. Obsolete. Use ids.

include_undefined

Outputs rows that don't have defined dimension values. This only affects the first dimension. Disabled by default.

lang

Language.

limit

Number of items on the results page.

Limit: 100000.

Default value: 100

offset

Index of the first row of requested data, starting from 1. Default value: 1.

pretty

Specifies the formatting for results. To use formatting, set the value to true. Default value: false

sort

Comma-separated list of dimensions and metrics to use for sorting. By default, sorting occurs in ascending order. To sort data in descending order, put the - sign before the dimension or metric.

Parameters

Description

total_rows

Total number of rows in the response.

sampled

Sampling flag. Indicates whether sampling was applied. Possible values: true, false.

sample_share

Percentage of data used for the calculation. Available values range from 0 to 1.

sample_size

Number of rows in the data sample.

sample_space

Number of data rows.

data_lag

Delay in updating data, in seconds.

query

Original request. Contains the request parameters, including detailed parameters from the template and parameters for attribute parametrization.

totals

Total results for metrics across the entire dataset (with filtration).

min

Minimum results for metrics among keys output.

max

Maximum results for metrics among keys output.

data

Response rows. An array in which each item is a single row of the result.

query.ids

Counter IDs.

query.dimensions

Array of dimensions.

query.metrics

Array of metrics.

query.sort

Array of sortings.

query.date1

Start date of the report period in the format YYYY-MM-DD.

query.date2

End date of the report period in the format YYYY-MM-DD.

query.filters

Segmentation filter.

query.limit

Number of items on the results page.

query.offset

Index of the first row of requested data, starting from 1.

data.dimensions

Array of dimension values for this row. Each dimension value is an object. It must have the name field, which is a text value. But it can also have additional fields, such as id.

data.metrics

Array of metric values for this row. The values in this array are numbers or null.