查询余额扣减分析
POST/api/v1/credits/analytics
按余额来源和分配汇总消费、退款及预扣。原始调用数和零费用事件使用 readUsageAnalytics。
SDK 0.0.1更新于
发起请求
按余额来源和分配汇总消费、退款及预扣。原始调用数和零费用事件使用 readUsageAnalytics。
- 调用凭据
- 仅服务端 API Key。由可信后端调用。
- 所需权限
credits:read
base URL 和 App ID 来自 SDK 接入页。示例使用占位值，不会执行请求。服务端 Key 不可放入浏览器。
1curl -X POST "$GROOVE_BASE_URL/api/v1/credits/analytics" \2 -H "Authorization: Bearer $GROOVE_SECRET_KEY" \3 -H "X-Groove-Project: $GROOVE_PROJECT_ID" \4 -H "X-Groove-Environment: sandbox" \5 -H "Content-Type: application/json" \6 -d '{7 "customerId": null,8 "query": {9 "range": {10 "kind": "absolute",11 "from": "2026-10-01T00:00:00.000Z",12 "to": "2026-10-03T12:00:00.000Z"13 },14 "timezone": "UTC",15 "filterBy": [],16 "interval": "day",17 "entitlementId": null,18 "groupBy": "customer",19 "entityId": null,20 "topN": null,21 "after": null,22 "limit": 5023 }24}'
响应选项卡列出字段类型，不是响应示例；实际值由客户状态决定。
请求参数
JSON 请求体
customerIduuid | null必填Indiana 客户 ID。服务端从已验证身份关联；客户 Token 调用时省略并使用 Token 绑定的客户。
queryobject必填本次操作的 query 值，类型和约束见字段标注。
展开子字段
rangeobject | object | object必填本次操作的 range 值，类型和约束见字段标注。
展开子字段
kind"absolute" | "last_days" | "billing_cycles"必填本次操作的 kind 值，类型和约束见字段标注。
fromdate-time可选本次操作的 from 值，类型和约束见字段标注。
todate-time可选本次操作的 to 值，类型和约束见字段标注。
days1 | 7 | 30 | 90可选本次操作的 days 值，类型和约束见字段标注。
membershipIduuid可选本次操作的 membershipId 值，类型和约束见字段标注。
countinteger可选本次操作的 count 值，类型和约束见字段标注。
min: 1 · max: 12
includeCurrentboolean可选本次操作的 includeCurrent 值，类型和约束见字段标注。
timezonestring必填本次操作的 timezone 值，类型和约束见字段标注。
maxLength: 100
filterByarray必填本次操作的 filterBy 值，类型和约束见字段标注。
maxItems: 5
展开子字段
keystring必填本次操作的 key 值，类型和约束见字段标注。
pattern: ^[a-z][a-z0-9_]{0,63}$
valuesarray必填本次操作的 values 值，类型和约束见字段标注。
minItems: 1 · maxItems: 20
intervalenum必填本次操作的 interval 值，类型和约束见字段标注。
查看允许值
"hour""day""week""month"
entitlementIduuid | null必填本次操作的 entitlementId 值，类型和约束见字段标注。
entityIduuid | null必填当前客户范围内的实体 ID；只用于已配置的实体和许可功能。
topNinteger | null必填本次操作的 topN 值，类型和约束见字段标注。
groupByenum | string必填本次操作的 groupBy 值，类型和约束见字段标注。
afterobject | null必填本次操作的 after 值，类型和约束见字段标注。
展开子字段
bucketdate-time必填本次操作的 bucket 值，类型和约束见字段标注。
groupstring必填本次操作的 group 值，类型和约束见字段标注。
maxLength: 240
isOtherboolean必填本次操作的 isOther 值，类型和约束见字段标注。
entitlementIduuid必填本次操作的 entitlementId 值，类型和约束见字段标注。
resourceIduuid必填本次操作的 resourceId 值，类型和约束见字段标注。
limitinteger必填一页返回的最大记录数量，受契约上限限制。
min: 1 · max: 100
响应字段
成功响应包含 requestId 和 scope。结合实际业务状态或 accepted 判断操作结果；可选字段不可用时省略。
HTTP 200 · application/json
requestIduuid必填服务端生成的 HTTP 请求 UUID，排查请求时提供这个值。
scopeobject必填响应实际所属的 App 和环境。Header 只能核对，不能切换 Key 范围。
展开子字段
projectIdstring必填凭据绑定的 App ID。
minLength: 1
environmentenum必填独立数据范围：sandbox 或 live。
查看允许值
"sandbox""live"
analyticsobject必填本次操作的 analytics 值，类型和约束见字段标注。
展开子字段
fromdate-time必填本次操作的 from 值，类型和约束见字段标注。
todate-time必填本次操作的 to 值，类型和约束见字段标注。
intervalenum必填本次操作的 interval 值，类型和约束见字段标注。
查看允许值
"hour""day""week""month"
timezonestring必填本次操作的 timezone 值，类型和约束见字段标注。
maxLength: 100
rowsarray必填本次操作的 rows 值，类型和约束见字段标注。
maxItems: 100
展开子字段
bucketdate-time必填本次操作的 bucket 值，类型和约束见字段标注。
groupstring必填本次操作的 group 值，类型和约束见字段标注。
maxLength: 240
isOtherboolean必填本次操作的 isOther 值，类型和约束见字段标注。
entitlementIduuid必填本次操作的 entitlementId 值，类型和约束见字段标注。
resourceIduuid必填本次操作的 resourceId 值，类型和约束见字段标注。
consumedUnitsstring必填本次操作的 consumedUnits 值，类型和约束见字段标注。
pattern: ^-?(0|[1-9]\d{0,23})(\.\d{1,12})?$
refundedUnitsstring必填本次操作的 refundedUnits 值，类型和约束见字段标注。
pattern: ^-?(0|[1-9]\d{0,23})(\.\d{1,12})?$
reservedUnitsstring必填本次操作的 reservedUnits 值，类型和约束见字段标注。
pattern: ^-?(0|[1-9]\d{0,23})(\.\d{1,12})?$
chargedstring必填本次操作的 charged 值，类型和约束见字段标注。
pattern: ^-?(0|[1-9]\d{0,23})(\.\d{1,12})?$
refundedstring必填本次操作的 refunded 值，类型和约束见字段标注。
pattern: ^-?(0|[1-9]\d{0,23})(\.\d{1,12})?$
reservedstring必填本次操作的 reserved 值，类型和约束见字段标注。
pattern: ^-?(0|[1-9]\d{0,23})(\.\d{1,12})?$
netUnitsstring必填本次操作的 netUnits 值，类型和约束见字段标注。
pattern: ^-?(0|[1-9]\d{0,23})(\.\d{1,12})?$
netChargedstring必填本次操作的 netCharged 值，类型和约束见字段标注。
pattern: ^-?(0|[1-9]\d{0,23})(\.\d{1,12})?$
nextCursorobject | null必填下一页游标；null 表示结束。原样传回，改筛选条件时清空。
展开子字段
bucketdate-time必填本次操作的 bucket 值，类型和约束见字段标注。
groupstring必填本次操作的 group 值，类型和约束见字段标注。
maxLength: 240
isOtherboolean必填本次操作的 isOther 值，类型和约束见字段标注。
entitlementIduuid必填本次操作的 entitlementId 值，类型和约束见字段标注。
resourceIduuid必填本次操作的 resourceId 值，类型和约束见字段标注。
处理错误
常见失败| 错误码 | 处理方式 |
|---|
| UNAUTHENTICATED | 核对 Key，或将过期客户 Token 重新签发一次。 |
| FORBIDDEN | 核对当前 Key 权限与客户访问范围。 |
| INVALID_REQUEST | 检查字段类型、UUID、十进制字符串和互斥字段。 |
| SCOPE_MISMATCH | 使用凭据绑定的 App 和环境。 |
常见失败
UNAUTHENTICATED
- 处理方式
- 核对 Key，或将过期客户 Token 重新签发一次。
FORBIDDEN
- 处理方式
- 核对当前 Key 权限与客户访问范围。
INVALID_REQUEST
- 处理方式
- 检查字段类型、UUID、十进制字符串和互斥字段。
SCOPE_MISMATCH
- 处理方式
- 使用凭据绑定的 App 和环境。
相关:完整请求与错误约定·返回接口索引