ReportABMetricGroup - 查询指标组报表

查询指标组的报表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
pairec:ReportABMetricGroupnone
*全部资源
*

请求语法

POST /api/v1/abmetricgroups/{ABMetricGroupId}/action/report HTTP/1.1

请求参数

名称类型必填描述示例值
ABMetricGroupIdstring

指标组 ID。

1
bodyobject

请求体参数。

InstanceIdstring

实例 ID,可通过接口 ListInstances 获取。

pairec-cn-test1
ReportTypestring

报表类型。

  • Realtime-实时报表

  • Offline-离线报表

  • Market-大盘报表

Offline
SceneIdstring

场景 ID,可通过 ListScenes 获取。

1
ExperimentGroupIdstring

实验组 ID,可通过接口 ListExperimentGroups 获取(离线、实时报表需要)。

3
ExperimentIdsstring

实验 ID 列表,可通过 ListExperiments 获取。

3,4,5
BaseExperimentIdstring

基准实验 ID。

3
TimeStatisticsMethodstring

统计时间类型(实时报表需要)。

  • Hour-按小时统计。

  • Day-从当日 0 点开始累加。

Hour
DimensionFieldsstring

维度字段。

{"gender":"man"}
StartDatestring

开始日期。

2021-07-01
EndDatestring

结束日期。

2021-07-01

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 ID。

59CE7EC6-F268-5D71-9215-32922CC50D72
ExperimentReportobject

实验报表。

object

报表信息。

Baselineboolean

是否是基准实验数据。

true
MetricResultsobject

指标结果。

object

指标结果。

object

指标结果。

ExpIdstring

实验 ID。

2
ExpNamestring

实验名称。

test实验
MetricNamestring

指标名称。

pv
MetricValuestring

指标值。

100
DimensionValuestring

维度值。

ALL
Datestring

日期。

20230206
PercentDiffstring

相较于 base 的增长率。

0.1
PercentDiffStrstring

相较于 base 的增长率(string 类型)。

"0.1"
GroupDimensionarray

维度字段。

GroupDimensionstring

维度信息。

["all"]

示例

正常返回示例

JSON格式

{
  "RequestId": "59CE7EC6-F268-5D71-9215-32922CC50D72",
  "ExperimentReport": {
    "key": {
      "Baseline": true,
      "MetricResults": {
        "key": {
          "key": {
            "ExpId": 2,
            "ExpName": "test实验",
            "MetricName": "pv",
            "MetricValue": 100,
            "DimensionValue": "ALL",
            "Date": 20230206,
            "PercentDiff": 0.1,
            "PercentDiffStr": 0.1
          }
        }
      }
    }
  },
  "GroupDimension": [
    [
      "all"
    ]
  ]
}

错误码

访问错误中心查看更多错误码。