You need to enable JavaScript to run this app.
导航
查询大图文件分辨率 Top URL
最近更新时间:2024.08.09 10:19:04首次发布时间:2023.01.03 19:26:16

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

说明

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

注意事项

  • 请求频率:
    • API 整体的请求频率限制为 100 次/秒
    • 单用户请求频率限制为 50 次/秒
  • 数据延迟:数据延迟约为 4 小时
  • 单次查询最大时间间隔为 93 天

请求说明

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

说明

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

请求参数

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

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

Query

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

Body

参数类型是否必选示例值描述
AppidString87534应用 ID。默认为空,不传则匹配账号下的所有的 App ID。您可以通过调用获取应用列表的方式获取所需的 AppID。

OS

String

WEB

需要匹配的系统类型,不传则匹配非 WEB 端的所有系统。取值如下所示:

  • iOS
  • Android
  • WEB
AppVerArray of String1.0.0需要匹配 App 版本,缺省情况下则匹配 App 的所有版本。
SdkVerArray of String1.0.0.0需要匹配的 SDK 版本,不传则匹配所有版本。

ImageType

Array of String

PNG

需要匹配的图片类型,缺省情况下则匹配所有图片类型。支持以下取值:

  • GIF
  • PNG
  • JPEG
  • HEIF
  • HEIC
  • WEBP
  • AWEBP
  • VVIC
  • 其他
ExtraDimsArray of ExtraDims需要匹配的自定义维度项
StartTimeString2019-06-02T00:00:00+08:00获取数据起始时间点。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
EndTimeString2019-06-03T00:00:00+08:00获取数据结束时间点,需在起始时间点之后。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00
TopInteger1000查询 Top URL 条数,取值范围为(0,1000]。缺省情况下默认为 1000。

OrderByIdx

Integer

1

支持以下取值:

  • 1:按上报次数降序排序;
  • 2:按图片分辨率降序排序;
  • 3:按 view 分辨率降序排序。

ExtraDims

参数类型是否必选示例值描述

Dim

String

biz_tag

自定义维度名称。

说明

您可以通过调用获取自定义维度列表来获取。

Vals

Array of String

4g

需要匹配的对应维度值。

说明

您可以通过调用获取自定义维度值来获取。

返回参数

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

TopUrlData

参数类型示例值描述
CountInteger134上报次数
ImageHeightInteger833图片高
ImageWidthInteger481图片宽
URLStringhttp://xxx.image图片 URL
ViewHeightInteger800图片展示背景 view 高。
ViewWidthInteger500图片展示背景 view 宽。
ActivityViewTreeStringController/ViewActivity+View 树,控件信息。
BizTagStringxxxx业务标识

示例

请求示例

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 错误码获取详细信息。