GetResponsesUsageRequest

Example Usage

import { GetResponsesUsageRequest } from "@meetkai/mka1/models/operations";

let value: GetResponsesUsageRequest = {
  startTime: 1704067200,
  endTime: 1704153600,
  limit: 30,
  page: "cursor_abc123",
  userIds: [
    "user_123",
    "user_456",
  ],
  externalUserIds: [
    "sub_123",
  ],
  orgIds: [
    "org_123",
  ],
  groupBy: [
    "model",
    "background",
  ],
  models: [
    "meetkai:functionary-urdu-mini-pak",
  ],
  background: false,
};

Fields

Field	Type	Required	Description	Example
startTime	number	✔️	N/A	1704067200
endTime	number	➖	N/A	1704153600
bucketWidth	components.BucketWidth	➖	N/A	1d
limit	number	➖	N/A	30
page	string	➖	N/A	cursor_abc123
userIds	operations.QueryParamUserIds	➖	Filter by platform user IDs (the same dimension group_by=user_id reports)	[ "user_123", "user_456" ]
externalUserIds	operations.QueryParamExternalUserIds	➖	Filter by delegated end-user IDs (externalUserId, i.e. X-On-Behalf-Of subs)	[ "sub_123" ]
allOrgs	string	➖	N/A
orgIds	operations.QueryParamOrgIds	➖	Filter by organization IDs (cluster admins only, implies cluster scope)	[ "org_123" ]
groupBy	operations.QueryParamGroupBy	➖	Group by specified fields	[ "model", "background" ]
models	operations.QueryParamModels	➖	Filter by model names	[ "meetkai:functionary-urdu-mini-pak" ]
background	boolean	➖	N/A	false
xOnBehalfOf	string	➖	Optional external end-user identifier forwarded by the API gateway.