You need to enable JavaScript to run this app.
导航

查询画质评估时序数据

最近更新时间2023.08.22 15:00:57

首次发布时间2023.02.17 15:17:28

本接口支持通过指定查询时间段和时间粒度,获取画质评估上报数据。

说明

单次查询的时间跨度不能超过 90 天。

请求说明

  • 接口名称:DescribeImageXClientScoreByTime
  • 请求方式:POST
  • 接口地址示例:https://imagex.volcengineapi.com/?Action=DescribeImageXClientScoreByTime&Version=2018-08-01
  • 请求频率:
    • API 整体的请求频率限制为 100 次/秒
    • 单用户请求频率限制为 50 次/秒
  • 数据延迟:数据延迟为 15 min

说明

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

请求参数

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

Query

参数类型是否必填描述
ActionString接口名称。
VersionString接口版本。veImageX 当前 API 的版本为 2018-08-01

Body

参数类型是否必选描述

Appid

String

需应用 ID。默认为空,不传则匹配账号下的所有的 App ID。

说明

您可以通过调用获取应用列表的方式获取所需的 AppID。

AppVerArray of String需要匹配的 App 版本,不传则匹配 App 的所有版本。

OS

String

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

  • iOS
  • Android
  • WEB
SdkVerArray of String需要匹配的 SDK 版本,不传则匹配所有版本
CountryString需要匹配的国家名称,不传则匹配所有国家,取值海外匹配海外所有国家。
ProvinceString需要匹配的省份名称,不传则匹配所有省份。

Isp

Array of String

需要匹配的运营商名称,不传则匹配所有运营商。取值如下所示:

  • 电信
  • 联通
  • 移动
  • 铁通
  • 鹏博士
  • 教育网
  • 其他
DomainArray of String需要匹配的域名,不传则匹配所有域名。您可以通过调用获取服务下全部域名获取所需的域名。

ImageType

Array of String

需要匹配的图片类型,不传则匹配所有图片类型。取值如下所示:

  • GIF
  • PNG
  • JPEG
  • HEIF
  • HEIC
  • WEBP
  • AWEBP
  • VVIC
  • 其他
ExtraDimsArray of ExtraDims需要匹配的自定义维度项

GroupBy

String

拆分维度。默认为空,不拆分。支持取值:

  • 公共维度:AppidOSAppVerSdkVerImageTypeCountryProvinceIspDomain
  • 自定义维度:您可以通过调用 GetImageXQueryDims接口获取自定义维度指标

ScoreType

String

打分类型。取值如下所示:

  • vq:查询 vqscore 指标
  • aes:查询美学指标
  • noi:查询噪声指标
  • psnr:查询 psnr 指标
  • ssim:查询 ssim 指标
  • vmaf:查询 vmaf 指标

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

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

返回参数

参数类型描述
ScoreDataArray of ScoreData画质打分数据

ScoreData

参数类型描述
TypeString数据类型,不拆分时值为 Total ,拆分时为具体的维度值
CountInteger该数据类型对应的总上报量
DataArray of Data具体上报数据

Data

参数类型描述
ValueFloat画质评估在该图片维度的分值
CountInteger数据对应的上报量
TimestampString数据对应时间点,按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=DescribeImageXClientScoreByTime&Version=2018-08-01 
{
    "StartTime": "1995-09-20T12:11:14Z",
    "EndTime": "1970-02-01T06:47:41Z",
    "Granularity": "5m",
    "ScoreType": "vq",
    "Province": "北京",
    "Appid": "61**09",
    "Domain": [
        "test.com"
    ],
    "ImageType": [
        "GIF"
    ],
    "ExtraDims": [
        {
            "Dim": "xxx",
            "Vals": [
                "xxxxx"
            ]
        }
    ],
    "Country": "中国",
    "OS": "iOS",
    "SdkVer": [
        "1.2.0"
    ],
    "Isp": [
        "联通"
    ],
    "AppVer": [
        "12.2.3.0"
    ],
    "GroupBy": ""
}

正常返回示例

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

异常返回示例

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

错误码

访问公共错误码以及通用错误码获取详细信息。