查询采集样本量--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

查询采集样本量

最近更新时间：2024.08.09 10:23:21首次发布时间：2023.01.03 19:26:21

本接口支持查询感知指标采集样本量数据。

说明

该接口属于历史版本 API，建议您使用新版 DescribeImageXSensibleCountByTime 接口。

请求说明

接口名称：DescribeImageXSensibleCountByTime
请求方式：POST
接口地址示例：https://imagex.volcengineapi.com/?Action=DescribeImageXSensibleCountByTime&Version=2018-08-01
请求频率：
- API 整体的请求频率限制为 100 次/秒。
- 单用户请求频率限制为 50 次/秒。
数据延迟：数据延迟约为 15 分钟。
单次查询的最大时间跨度 90 天。

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。

Body

参数	类型	是否必选	描述
Appid	String	否	应用 ID，缺省情况下匹配账号下所有 AppID。说明您可以通过调用获取应用列表的方式获取所需的 AppID。
OS	String	否	需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示： `iOS` `Android` `WEB`
AppVer	Array of String	否	需要匹配 App 版本，缺省情况下则匹配 App 的所有版本。
SdkVer	Array of String	否	需要匹配的 SDK 版本，缺省情况下则匹配所有版本。
ImageType	Array of String	否	需要匹配的图片类型，缺省情况下则匹配所有图片类型。支持以下取值： `GIF` `PNG` `JPEG` `HEIF` `HEIC` `WEBP` `AWEBP` `VVIC` `其他`
ExtraDims	Array of ExtraDims	否	需要匹配的自定义维度项。
GroupBy	String	否	拆分维度。默认为空，不拆分。支持取值：公共维度：`Appid`、`OS`、`AppVer`、`SdkVer`、`ImageType` 自定义维度：您可以通过调用 GetImageXQueryDims接口获取自定义维度指标
StartTime	String	是	获取数据起始时间点。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，例如`2019-06-02T00:00:00+08:00`。起始时间与结束时间间隔小于等于 90 天。
EndTime	String	是	获取数据结束时间点，需在起始时间点之后。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，例如`2019-06-02T00:00:00+08:00`。起始时间与结束时间间隔小于等于 90 天。
Granularity	String	是	返回数据的时间粒度，支持以下取值： `5m`：5分钟； `1h`：1小时； `1d`：1天。

ExtraDims

参数	类型	是否必选	描述
Dim	String	是	自定义维度名称。说明您可以通过调用获取自定义维度列表来获取。
Vals	Array of String	是	需要匹配的对应维度值。说明您可以通过调用获取自定义维度值来获取。

返回参数

参数	类型	描述
SensibleCountData	Array of SensibleCountData	采集样本量数据

SensibleCountData

参数	类型	描述
Type	String	数据类型，不拆分时值为`Total`，拆分时为具体的维度值。
Count	Integer	该数据类型对应的总上报量。
Data	Array of Data	具体数据

Data

参数	类型	描述
Value	Integer	上报量数据，与`Count`数值相同。
Count	Integer	上报量数据。
Timestamp	String	数据对应时间点，按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=DescribeImageXSensibleCountByTime&Version=2018-08-01 
{
  	"Appid": "123",
  	"OS": "Android",
  	"AppVer": [
        "1.0.0"
    ],
  	"SdkVer": [
        "1.0.0.0"
    ],
  	"ImageType": [
        "PNG"
    ],
  	"ExtraDims": [
        {
            "Dim": "country",
            "Vals": [
                "中国"
            ]
        }
    ],
    "StartTime": "2019-06-02T00:00:00+08:00",
    "EndTime": "2019-06-03T00:00:00+08:00",
    "Granularity": "5m",
    "GroupBy": "OS"
}

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "DescribeImageXSensibleCountByTime"
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"        
    }
    "Result": {
        "SensibleCountData": [
            {
                "Type": "Total",
                "Count": 2385,
                "Data": [
                    {
                        "Count": 2385,
                        "Timestamp": "2020-01-01T08:00:00+08:00",
                        "Value": 2385
                    }
                ]
            }
        ]
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "DescribeImageXSensibleCountByTime",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "Code": "200000",
            "Message": "参数异常"
        }
    }
}

错误码

访问错误码获取详细信息。