文档中心

查询大图文件分辨率 Top URL

最近更新时间：2023.07.04 20:07:10

首次发布时间：2023.01.03 19:26:16

本接口支持查询大图文件分辨率 Top URL 数据。

说明

单次查询最大时间间隔为 93 天。

注意事项

请求频率：
- API 整体的请求频率限制为 100 次/秒。
- 单用户请求频率限制为 50 次/秒。
数据延迟：数据延迟约为 4 小时。

请求说明

请求方式：POST
请求地址：https://imagex.volcengineapi.com/?Action=DescribeImageXSensibleTopResolutionURL&Version=2018-08-01

说明

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

请求参数

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

参数	类型	是否必选	示例值	描述
Content-Type	String	是	`application/json`	请求头字段

Query

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

Body

参数	类型	是否必选	示例值	描述
Appid	String	否	`87534`	应用 ID。默认为空，不传则匹配账号下的所有的 App ID。您可以通过调用获取应用列表的方式获取所需的 AppID。
OS	String	否	`WEB`	需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示： `iOS` `Android` `WEB`
AppVer	Array of String	否	`1.0.0`	需要匹配 App 版本，缺省情况下则匹配 App 的所有版本。
SdkVer	Array of String	否	`1.0.0.0`	需要匹配的 SDK 版本，不传则匹配所有版本。
ImageType	Array of String	否	`PNG`	需要匹配的图片类型，缺省情况下则匹配所有图片类型。支持以下取值： `GIF` `PNG` `JPEG` `HEIF` `HEIC` `WEBP` `AWEBP` `VVIC` `其他`
ExtraDims	Array of ExtraDims	否		需要匹配的自定义维度项
StartTime	String	是	`2019-06-02T00:00:00+08:00`	获取数据起始时间点。日期格式按照`ISO8601`表示法，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`，比如`2019-06-02T00:00:00+08:00`。
EndTime	String	是	`2019-06-03T00:00:00+08:00`	获取数据结束时间点，需在起始时间点之后。日期格式按照`ISO8601`表示法，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`，比如`2019-06-02T00:00:00+08:00`。
Top	Integer	否	`1000`	查询 Top URL 条数，取值范围为(0,1000]。缺省情况下默认为 1000。
OrderByIdx	Integer	是	`1`	支持以下取值： `1`：按上报次数降序排序； `2`：按图片分辨率降序排序； `3`：按 view 分辨率降序排序。

ExtraDims

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

返回参数

参数	类型	示例值	描述
TopUrlData	Array of TopUrlData		具体数据

TopUrlData

参数	类型	示例值	描述
Count	Integer	`134`	上报次数
ImageHeight	Integer	`833`	图片高
ImageWidth	Integer	`481`	图片宽
URL	String	`http://xxx.image`	图片 URL
ViewHeight	Integer	`800`	图片展示背景 view 高。
ViewWidth	Integer	`500`	图片展示背景 view 宽。
ActivityViewTree	String	`Controller/View`	Activity+View 树，控件信息。
BizTag	String	`xxxx`	业务标识

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=DescribeImageXSensibleTopResolutionURL&Version=2018-08-01
{
    "Appid": "123",
  	"OS": "Android",
  	"AppVer": [
        "1.0.0"
    ],
  	"SdkVer": [
        "1.0.0.0"
    ],
  	"ImageType": [
        "PNG"
    ],
  	"ExtraDims": [
        {
            "Dim": "biz_tag",
            "Vals": [
                "xxx"
            ]
        }
    ],
    "StartTime": "2019-06-02T00:00:00+08:00",
    "EndTime": "2019-06-03T00:00:00+08:00",
  	"Top": 100,
    "OrderByIdx": 1
}

返回示例

{
    "ResponseMetadata": {
		    "RequestId": "201806041104200100100232280022D30",
        "Action": "DescribeImageXSensibleTopResolutionURL",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "TopUrlData": [
            {
              	"ImageWidth": 612,
                "ImageHeight": 581,
                "ViewWidth": 481,
                "ViewHeight": 833,
                "URL": "http://xxx.image",
                "ActivityViewTree": "Controller/View",
                "BizTag": "",
                "Count": 123
            }
        ]
    }
}

错误码

访问公共错误码和 veImageX 错误码获取详细信息。