---
metadata:
  - name: generator
    content: Diplodoc Platform v5.64.0
alternate:
  - https://boost.yandex.com/doc/en/analytics/content/mobile-api/stat/intro.md
  - https://boost.yandex.com/doc/ru/analytics/content/mobile-api/stat/intro.md
  - https://boost.yandex.com/doc/zh/analytics/content/mobile-api/stat/intro.md
  - href: https://boost.yandex.com/doc/zh/analytics/content/mobile-api/stat/intro.md
    type: text/markdown
    title: Markdown version
  - href: https://boost.yandex.com/doc/zh/llms.txt?revision=r21738064
    rel: describedby
---
> **Documentation Index:** Fetch the complete configuration index at https://boost.yandex.com/doc/zh/llms.txt?revision=r21738064

# 简介

使用报表 API，您可以在不使用 Analytics module 界面 的情况下获取应用的统计数据。

维度和指标用于发出 API 请求。

- 维度是可以用于分组数据的属性。

    在API请求中，维度通过`dimensions`参数设置。 如果需要列出多个维度，请用逗号分隔。

    也可以不添加维度生成报告；在这种情况下，会计算总结果。

- 指标是基于会话属性的数值。

    在API请求中，指标设置在`metrics`参数中。 如果需要列出多个指标，请用逗号分隔。

{% cut "关于术语的更多信息" %}

要更好地理解“维度”和“指标”这两个术语，请考虑一个设备制造商报告的例子：

| Device manufacturer | 用户数量 |
| ----- | ----- |
| Apple | | 1803 |
| Samsung | 1272 |
| NOKIA | 809 |

where

- `设备制造商`是会话属性，用于分组报告数据（一个_维度_）。
- `用户数量`是根据数值会话属性（一个_指标_）计算得到的值，对应指定的维度。

{% note info "" %}

如果您熟悉 SQL，可以把维度想象为用于分组的列，而指标则是聚合函数返回的结果。

{% endnote %}

{% endcut %}

您可以通过在 API 请求中指定指标和维度来创建想要的报告结构。

例如，要获取按设备制造商和设备型号名称分组的数据的用户数量报告，请使用此请求：

```httpget translate=no
GET /stat/v1/data?id=1111&metrics=ym:ge:users&dimensions=ym:ge:mobileDeviceBranding,ym:ge:mobileDeviceModel&limit=5 HTTP/1.1
Host: api.boost.yandex.com
Authorization: OAuth <your_token>
```

其中 `<your_token>` 是 OAuth 令牌，您可以通过遵循 [本指南](https://boost.yandex.com/doc/zh/analytics/content/mobile-api/intro/authorization.md#get-oauth-token) 获取。

{% cut "示例响应" %}

```json translate=no
{

    "query": {
        "ids": [
            1111
        ],
        "dimensions": [
            "ym:ge:mobileDeviceBranding",
            "ym:ge:mobileDeviceModel"
        ],
        "metrics": [
            "ym:ge:users"
        ],
        "sort": [
            "-ym:ge:users"
        ],
        "date1": "2015-08-28",
        "date2": "2015-09-03",
        "limit": 5,
        "offset": 1

    },
    "data": [
        {
            "dimensions": [
                {
                    "name": "Apple"
                },
                {
                    "name": "iPad 4"
                }

            ],
            "metrics": [
                1240
            ]
        },
        {

            "dimensions": [
                {
                    "name": "Apple"

                },
                {
                    "name": "iPad mini 1G"
                }

            ],
            "metrics": [
                1236
            ]
        },
        {
            "dimensions": [
                { 
                    "name": "Apple"
                },
                {
                    "name": "iPad Air"
                }
            ],
            "metrics": [
                948
            ]
        },
        {
            "dimensions": [
                {
                    "name": "Apple"
                },
                {
                    "name": "iPad 2"
                }
            ],
            "metrics": [
                866
            ]
        },
        {

            "dimensions": [
                {
                    "name": "Apple"
                },
                {
                    "name": "iPad 3"
                }
            ],
            "metrics": [
                661
            ]
        }
    ],
    "total_rows": 1163,
    "sampled": false,
    "sample_share": 1,
    "sample_size": 12258000,
    "sample_space": 12258000,
    "data_lag": 0,
    "totals": [
        13290
    ],
    "min": [
        661
    ],
    "max": [
        1240
    ]

}
```

{% endcut %}

要获取对 Reporting API 的请求文本，请使用 **导出** 菜单在 Analytics module 界面中. 打开报告，配置分段、时间间隔、分组，然后点击图表上方的**导出**按钮。 在下拉菜单中选择 **复制表格 API 请求** 或 **复制图表 API 请求**。 要了解有关导出数据的更多信息，请参阅[工作与报告](https://boost.yandex.com/doc/zh/analytics/content/mobile-reports/index.md)。

## 维度和指标的兼容性 {#comp}

API 支持几种不同前缀的维度和指标类型：

- `ym:ge:` — 任何活动的维度或指标。
- `ym:ce:` — 表示您的事件已发送。
- `ym:c:` — 在跟踪报告中用于表示点击。
- `ym:i:` — 在跟踪报告中用于表示应用安装。
- `ym:s:` — 在会话维度中使用。

在同一个请求中不能使用不同的前缀。

{% note info "" %}

您可以在使用 `filters` 参数对接收的数据按维度进行分段时，指定与请求中不同的前缀。

{% endnote %}

## 报告类型 {#report-type}

最终数据可以以以下格式提供：

{% list tabs %}

- Table
  
  所有报告级别和指标以表格形式显示。
  
  要以表格形式显示数据，请使用[/stat/v1/data](https://boost.yandex.com/docs/zh/mobile-api/stat/ref/data)方法。

- Drill down
  
  生成树形报告的单个分支。
  
  要创建分支，请使用[/stat/v1/data/drilldown](https://boost.yandex.com/docs/zh/mobile-api/stat/ref/drilldown)方法。

- 按时间段

  显示按时间段（例如按天、周或月）分组的数据。 使用[/stat/v1/data/bytime](https://boost.yandex.com/docs/zh/mobile-api/stat/ref/bytime)请求来创建图表并跟踪随时间变化的统计数据。 

{% endlist %}

## 报告格式 {#report-format}

API 返回的响应使用 UTF-8 编码。 响应格式为 JSON 或 CSV。

请求中 URL 后面指定了格式：

```
获取 https://api.boost.yandex.com/stat/v1/data.**csv**?<counter_id>&<metrics>&<dimensions>
```

由于 JSON 是默认格式，可以省略：

```
获取 https://api.boost.yandex.com/stat/v1/data?<counter_id>&<metrics>&<dimensions>
```

<!-- source: zh/analytics/content/_includes/feedback-button-2.md -->
如果您没有找到所需答案，可以通过反馈表单提交您的问题。 请尽可能详细地描述问题。 如果可能，请附上截图。

<a href="../troubleshooting/feedback-new">
  <span class="button">联系支持</span>
</a>

<a href="../troubleshooting/feedback-docs">
  <span class="button">建议改进文档</span>
</a>
<!-- endsource: zh/analytics/content/_includes/feedback-button-2.md -->