获取字符用量指标

Deprecated
(已弃用)此端点已弃用。请改用 /v1/workspace/analytics/query/usage-by-product-over-time,该端点将分桶大小公开为 `interval_seconds`(以秒为单位的整数),而非 `aggregation_interval`。返回当前用户或其所属整个工作区的使用指标。响应会根据指定的聚合间隔(默认:天)提供时间轴,以及该时间轴上每个间隔的使用量。使用量会按所选细分类型拆分。例如,细分类型 "voice" 将返回时间轴上每个间隔内各音色的使用量。

请求头

xi-api-keystring可选

查询参数

start_unixinteger必需

使用时间范围开始时间的 UTC Unix 时间戳(毫秒)。若要包含范围内第一天,时间戳应设为该日的 00:00:00。

end_unixinteger必需

使用时间范围结束时间的 UTC Unix 时间戳(毫秒)。若要包含范围内最后一天,时间戳应设为该日的 23:59:59。

include_workspace_metricsboolean可选默认为 false

是否包含整个工作区的统计数据。

breakdown_typeenum可选

如何细分信息。当 include_workspace_metrics 为 False 时,不能为 “user”。

aggregation_intervalenum可选

如何按时间汇总使用数据。可为 “hour”、“day”、“week”、“month” 或 “cumulative”。

允许的值:
aggregation_bucket_sizeinteger or null可选

聚合时间桶大小(秒)。会覆盖聚合间隔。

metricenum可选

要聚合的指标。

响应

成功响应

timelist of integers

包含每日 Unix 时间戳的时间轴。

usagemap from strings to lists of doubles

时间轴上各细分类型的使用量。

错误

422
Unprocessable Entity Error