参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
Authorization | String | 是 | HMAC-SHA256 Credential=BDPP2952f97532xxxxxx/20240716/cn/openPlatform/request, SignedHeaders=host;x-content-sha256;x-date, Signature=131f3d297eb22a7xxxxxx | 详细介绍请查阅调用方式文档 |
X-Tenant | String | 是 | 1 | 项目ID |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
ApiAction | String | 是 | getAllMetricList | 固定值，对应“请求说明”中的“接口名称” |
ApiVersion | String | 是 | 2024-05-22 | 固定值，版本号： 2024-05-22 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
subjectId | Int | 否 | 1 | 主体ID，参考附录-主体ID获取方式 |
filterColumns | Array | 否 | ||
sortBy | String | 否 | 排序字段 | |
order | String | 否 | 排序方式 | |
platform | String | 否 | 平台 | |
pageSize | Int | 否 | 每页大小 | |
current | Int | 否 | 页码 | |
permissionValue | String | 否 | 权限模型 | |
effectAnalysisSource | String | 否 | 效果分析数据源过滤，支持为空，如果传入值，则会过滤非传入效果分析数据源的预置指标 | |
selfCreate | Bool | 否 | 过滤出我创建的 | |
shared | Bool | 否 | 过滤出授权给我的 | |
bookmark | Bool | 否 | 只查看收藏的 |
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
msg | String | 成功 | 接口返回信息 |
code | Number | 0 | 状态码，0表示正常 |
data | Onject | 接口返回数据体 | |
traceId | String | 跟踪id |
data字段内容
参数 | 类型 | 示例值 | 描述 |
|---|---|---|---|
total | Int (int64) | ||
pageSize | Int (int32) | ||
current | Int (int32) | ||
pageNum | Int (int32) | ||
items | Array (AnalysisModuleObjResp) |
{}
{ "code": 0, "msg": "success", "data": { "total": 170, "pageSize": 10, "current": 1, "pageNum": 1, "items": [ { "id": 1760, "analysisModuleObjId": 1760, "analysisModuleObjName": "openapi2024-12-03T15:26:42.171", "name": "openapi2024-12-03T15:26:42.171", "descr": null, "seg": null, "dimension": { "type": "ATTRIBUTION_COLUMN", "attributionObj": { "type": "DETAIL", "dataSourceId": 95, "columnName": "money", "distinct": false, "breakUp": true, "method": "SUM" }, "attributionEvent": [ { "type": "EVENT", "eventDatasourceId": 105, "eventId": 118, "eventName": "click", "distinct": false, "breakUp": true, "method": "COUNT" } ] }, "period": { "startTime": "2024-11-26", "endTime": "2024-12-03", "type": "DATE" }, "metrics": { "method": "ATTRIBUTION", "period": { "periodRange": "DAY", "num": 7, "type": "RANGE" }, "attributionType": "LAST", "formatEnum": "INTEGER", "attributionEvent": [ { "type": "EVENT", "eventDatasourceId": 105, "eventId": 118, "eventName": "click", "distinct": false, "breakUp": true, "method": "COUNT" } ], "attributionObj": { "type": "DETAIL", "dataSourceId": 95, "columnName": "money", "distinct": false, "breakUp": true, "method": "SUM" } }, "segRequired": false, "dimensionRequired": false, "periodRequired": false, "metricsRequired": false, "analysisType": "ATTRIBUTION_COLUMN", "createTime": "2024-12-03 15:26:42", "analysisModuleObjCreator": "admin", "updateTime": "2024-12-03 15:26:42", "updater": "admin", "domainType": "Private", "authFilter": true, "displayConfig": { "dimensions": [ { "key": "dimensionKey1", "name": "money" } ] }, "cdpModules": [], "periodShow": "7天", "attributionModelType": "末次触点归因", "platform": "GMP", "active": false, "scheduleTime": "2024-12-03 15:26:42", "scheduleRange": null, "subjectId": 1, "usableCdpModules": [ "segAnalysis" ], "editAble": true, "deleteAble": true, "message": null, "bookmark": false, "domainInfos": [], "authSchema": null, "panelId": null, "draftId": null } } }
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。
HTTP 状态码 | 错误码 | 错误信息 | 说明 |
|---|---|---|---|
400 | invalidParameter | PARAMETER INVALID | 参数非法，检查入参。 |