@@ -22245,7 +22245,7 @@ paths:
2224522245 properties:
2224622246 dimensions:
2224722247 items:
22248- description: Dimension name
22248+ description: Dimension to group by (up to 2). Use the /meta endpoint for available dimensions.
2224922249 example: model
2225022250 type: string
2225122251 maxItems: 2
@@ -22254,7 +22254,7 @@ paths:
2225422254 items:
2225522255 properties:
2225622256 field:
22257- description: Dimension to filter on
22257+ description: Dimension to filter on. Use the /meta endpoint for available dimensions.
2225822258 example: model
2225922259 type: string
2226022260 operator:
@@ -22272,7 +22272,15 @@ paths:
2227222272 - format: double
2227322273 type: number
2227422274 type: array
22275- description: Filter value (scalar or array depending on operator)
22275+ description: >-
22276+ Filter value (scalar or array depending on operator). Several dimensions are enriched in
22277+ responses (returned as human-readable labels), but filters must use the underlying ID:
22278+ `api_key_id` — numeric ID (from generation metadata) or key hash (64-char hex from GET
22279+ /api/v1/keys, resolved server-side); `user` — Clerk user ID (e.g. "user_abc123"), not the
22280+ display name; `workspace` — workspace UUID, not the workspace name; `app` — numeric app ID,
22281+ not the app title; `model` — permaslug (e.g. "openai/gpt-4o"), not the display name. Other
22282+ dimensions (provider, origin, country, etc.) are not enriched and accept the value as
22283+ returned.
2227622284 required:
2227722285 - field
2227822286 - operator
@@ -22375,6 +22383,13 @@ paths:
2237522383 - row_count
2237622384 - truncated
2237722385 type: object
22386+ warnings:
22387+ description: >-
22388+ Warnings about filter resolution issues (e.g. unresolvable api_key_id hashes). The query still
22389+ runs normally; these inform the caller that some filter values could not be resolved.
22390+ items:
22391+ type: string
22392+ type: array
2237822393 required:
2237922394 - data
2238022395 - metadata
0 commit comments