yandex_metrica_get_report
Run Yandex Metrica Reporting API queries to return aggregated visits, users, bounce rate, and traffic source stats. Use for summaries, breakdowns, or two-period comparisons.
Instructions
Run a Yandex Metrica Reporting API query and return aggregated statistics such as visits, users, bounce rate, and traffic sources. Use when the user wants a summary, a breakdown, or a comparison of two periods via date1_b and date2_b. Do not use this for row-level visits or pageviews; call yandex_metrica_evaluate_logs_request and the other Logs API tools. Metrics use the ym:s: prefix for visits and ym:pv: for hits.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| lang | No | Language for dimension value names (default: ru) | |
| sort | No | Sort fields. Prefix with '-' for descending, e.g. ['-ym:s:visits', 'ym:s:date'] | |
| date1 | No | Start date (YYYY-MM-DD or 'today', 'yesterday', '7daysAgo'). Default: 7daysAgo | |
| date2 | No | End date (YYYY-MM-DD or relative). Default: today | |
| limit | No | Rows to return (default 100) | |
| offset | No | Row offset for pagination (1-based) | |
| preset | No | Preset report name (e.g. 'sources_summary'). Overrides metrics/dimensions. | |
| date1_b | No | Comparison segment B start date. When provided with date2_b, uses the comparison endpoint (/stat/v1/data/comparison). date1/date2 become segment A. Each row returns two sets of metrics. | |
| date2_b | No | Comparison segment B end date. Must be provided together with date1_b. | |
| filters | No | Filter expression, e.g. "ym:s:trafficSourceName=='Organic Search'" | |
| metrics | Yes | Metrics to include, e.g. ['ym:s:visits', 'ym:s:pageviews', 'ym:s:bounceRate']. Max 20. | |
| accuracy | No | Sampling accuracy (default: medium) | |
| currency | No | Currency code (ISO 4217), e.g. 'RUB' | |
| filters_a | No | Segmentation filter for segment A only (comparison mode) | |
| filters_b | No | Segmentation filter for segment B only (comparison mode) | |
| dimensions | No | Dimensions for grouping, e.g. ['ym:s:date', 'ym:s:regionCityName'] | |
| attribution | No | Attribution model for traffic source metrics. 'lastsign' = last significant source; 'automatic' = auto-attribution. | |
| counter_ids | Yes | One or more counter IDs to query | |
| include_undefined | No | Include rows with undefined dimension values |