GetExtractUsageRequest

Example Usage

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

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

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.GetExtractUsageQueryParamUserIds	➖	Filter by platform user IDs (the same dimension group_by=user_id reports)	[ "user_123", "user_456" ]
externalUserIds	operations.GetExtractUsageQueryParamExternalUserIds	➖	Filter by delegated end-user IDs (externalUserId, i.e. X-On-Behalf-Of subs)	[ "sub_123" ]
allOrgs	string	➖	N/A
orgIds	operations.GetExtractUsageQueryParamOrgIds	➖	Filter by organization IDs (cluster admins only, implies cluster scope)	[ "org_123" ]
groupBy	operations.GetExtractUsageQueryParamGroupBy	➖	Group by specified fields	[ "model" ]
models	operations.GetExtractUsageQueryParamModels	➖	Filter by model names	[ "meetkai:functionary-urdu-mini-pak" ]
xOnBehalfOf	string	➖	Optional external end-user identifier forwarded by the API gateway.