服务端集成 · 报表查询 · 报表指标查询

说明如何通过 Gravity Engine OpenAPI 获取多维报表可用的预置指标和自定义指标，涵盖认证、请求参数、筛选条件和返回字段。

此接口提供多维报表的指标查询功能，支持获取引力预置指标和用户自定义指标。

申请引力开发者应用

在正式接入本接口之前，您需要在引力后台-引力开发者页面申请引力开发者应用，申请之后，我们将在一个工作日内完成审核，审核通过之后，您的开发者应用才可以正常拉取数据。

创建好开发者应用之后，请复制 app_key 参数，并发送给研发同学以供后续接口调用使用。

接口信息

请求地址

https://api-insight.gravity-engine.com/openapi/api/v1/report/metrics/list/

请求方法

POST

字段	类型	描述
Authorization	string	具体如何生成，请参考【签名生成】

body 参数

参数名	必填	类型	说明	描述
`data_topic`	Y	string	数据主题	固定值：`adreport`
`metric_type`	Y	string	指标类型	`gravity_preset`（引力预置指标）、`user_custom`（用户自定义指标）
`sign`	Y	string	签名	详情请参考【签名生成】

请求示例

curl 'https://backend.gravity-engine.com/openapi/api/v1/report/metrics/list/' \
-H 'Content-Type: application/json' \
-H 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhcHBfa2V5IjoiMWMyOGU2MDNlNzE2NGNiYWFjZWEwMGUAbcgaTNhNGQifQ.eEXRsuZgD_-wN1B6oYsKlfMPVpcDmZf-XlmM-T95vbs' \
-d '{
  "data_topic": "adreport",
  "metric_type": "gravity_preset",
  "sign": "7c17ef21cd4fc9c9736307dd6ebbd631"
}'

应答示例

应答参数指标说明

字段名	类型	说明	示例值
`name`	string	指标字段名	`weibo_tansfer_cost_firstday_roi`
`cname`	string	指标中文名	微博_首日 ROI
`exclusion_dims`	array	不能和该指标组合使用的维度列表	`["csite", "os_family"]`
`tip`	string	计算公式或详细说明	首日付费金额/消耗

{
    "data": {
        "metric_type": "gravity_preset",
        "metrics": [
            {
                "name": "withdrawal_roi",
                "cname": "总ROI(含提现)",
                "exclusion_dims": [],
                "tip": "(总收入-提现金额)/平台_消耗"
            },
            {
                "name": "weibo_tansfer_cost_firstday_roi",
                "cname": "微博_首日ROI",
                "exclusion_dims": [
                    "csite",
                    "os_family"
                ],
                "tip": "首日付费金额/消耗"
            },
            {
                "name": "weibo_tansfer_cost_firstday",
                "cname": "微博_首日付费金额",
                "exclusion_dims": [
                    "csite",
                    "os_family"
                ],
                "tip": ""
            }
        ]
    },
    "extra": {
        "error": "",
        "request_id": "84b2f4bd9e534066992e80bdc0de8ba7"
    },
    "code": 0,
    "msg": "成功"
}

报表指标查询