调用ListMessageMetrics获取短信发送统计数据_人工智能平台 PAI(PAI)-阿里云帮助中心

获取短信发送统计数据，可按指定条件获取分类别详细数据。

接口说明

获取 [开始日期, 结束日期] 闭区间内的数据，返回数据按日期升序排列，发送统计为空的日期不返回。

发送数据在 48 小时内会随实际短信发送状态不断更新，最终数据以 48 小时后数据为准。

调试

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

调试

授权信息

当前API暂无授权信息透出。

请求语法

GET /api/v2/messages/metrics

请求参数

名称	类型	必填	描述	示例值
EndDate	string	是	结束日期，格式 20220102。	20210321
GroupId	string	否	关联人群 ID。	10ed87f5-3ca8-4a43-9d83-b30519be7241
PageNumber	integer	否	分页数，从 1 开始，默认为 1。	1
PageSize	integer	否	分页大小，默认为 10。	10
ScheduleId	string	否	关联触达计划 ID。	08d19262-bd76-48fd-80e8-6a225ac388c1
Signature	string	否	签名名称。	PAI通知
SignatureId	string	否	签名 ID，同时只能指定签名名称或签名 ID 其中之一。	b1fe24e2-6a1b-42c6-901e-bfb2e898b5f3
StartDate	string	是	开始日期，格式 20220102。	20210321
TemplateCode	string	否	模板号。	SMS_123456
TemplateId	string	否	模板 ID，同时只能指定模板 Code 或模板 ID 其中之一。	5480e3e7-f578-42d2-8ce8-217dec75f2e6
TemplateType	integer	否	模板类型。 0 : 验证码。 1 : 短信通知。 2 : 推广短信。	2

返回参数

名称	类型	描述	示例值
	object	成功获取短信发送统计列表。
Data	object	返回数据。
Metrics	object []	分页返回的统计数据条目列表。
Date	string	发送日期。	20210321
Fail	integer	发送失败。	0
Pending	integer	发送中。	0
Rate	float	发送成功率。	0.8
Success	integer	发送成功。	0
Total	integer	总计短信数量。	0
PageNumber	integer	分页数，从 1 开始，默认为 1。	1
PageSize	integer	分页大小，默认为 10。	10
TotalCount	integer	总统计数据条目数量。	0
ErrorCode	integer	错误码。	0
ErrorMessage	string	错误信息。	OK
RequestId	string	请求 ID。	f8651828-609d-4de8-ab49-ab781d7fd85a

示例

正常返回示例

JSON格式

{
  "Data": {
    "Metrics": [
      {
        "Date": "20210321",
        "Fail": 0,
        "Pending": 0,
        "Rate": 0.8,
        "Success": 0,
        "Total": 0
      }
    ],
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 0
  },
  "ErrorCode": 0,
  "ErrorMessage": "OK",
  "RequestId": "f8651828-609d-4de8-ab49-ab781d7fd85a"
}