# 获取妙搭应用运营数据总览

获取妙搭应用运营数据总览

## 请求

基本 |  
---|---
HTTP URL | https://open.feishu.cn/open-apis/spark/v1/apps/:app_id/analytics/overview
HTTP Method | GET
接口频率限制 | [20 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 获取妙搭应用信息(spark:app:read)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`<br>或<br>`user_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)

### 路径参数

名称 | 类型 | 描述
---|---|---
app_id | string | 应用 ID<br>**示例值**："app_4jbp6bx8fwjgm"

### 查询参数

名称 | 类型 | 必填 | 描述
---|---|---|---
start_time | string | 是 | 运营分析区间起始时间戳，单位：秒（Unix 时间戳）<br>**示例值**：1690000000
end_time | string | 是 | 运营分析区间结束时间戳，单位：秒（Unix 时间戳）。须满足 end_time >= start_time<br>**示例值**：1690086400

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
active_users | open_api_analytics_metric | 单个运营指标对象（含本区间值、上一等长区间值与环比）。
value | string | 本区间指标值
prev_value | string | 上一等长区间的指标值（环比基准）
diff | string | 环比绝对变化 = value - prev_value
ratio | number(float) | 环比变化率（小数，如 -0.714 表示下降 71.4%）；prev_value 为 0 时为 0
signups | open_api_analytics_metric | 单个运营指标对象（含本区间值、上一等长区间值与环比）。
value | string | 本区间指标值
prev_value | string | 上一等长区间的指标值（环比基准）
diff | string | 环比绝对变化 = value - prev_value
ratio | number(float) | 环比变化率（小数，如 -0.714 表示下降 71.4%）；prev_value 为 0 时为 0
page_views | open_api_analytics_metric | 单个运营指标对象（含本区间值、上一等长区间值与环比）。
value | string | 本区间指标值
prev_value | string | 上一等长区间的指标值（环比基准）
diff | string | 环比绝对变化 = value - prev_value
ratio | number(float) | 环比变化率（小数，如 -0.714 表示下降 71.4%）；prev_value 为 0 时为 0

### 响应体示例
```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "active_users": {
            "value": "12500",
            "prev_value": "15000",
            "diff": "-2500",
            "ratio": -0.1667
        },
        "signups": {
            "value": "12500",
            "prev_value": "15000",
            "diff": "-2500",
            "ratio": -0.1667
        },
        "page_views": {
            "value": "12500",
            "prev_value": "15000",
            "diff": "-2500",
            "ratio": -0.1667
        }
    }
}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
400 | 3340001 | Invalid request parameter | 请检查一下请求参数是否正确，是否符合接口入参要求。
404 | 3340004 | App not found | 请检查该appID是否存在或是否有权限查看
500 | 3340500 | Internal server error | 服务端异常，请稍后再试