Skip to content

GetConversationsUsageRequest

Example Usage

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

let value: GetConversationsUsageRequest = {
  startTime: 1704067200,
  endTime: 1704153600,
  limit: 30,
  page: "cursor_abc123",
  userIds: [
    "user_123",
    "user_456",
  ],
  externalUserIds: [
    "sub_123",
  ],
  orgIds: [
    "org_123",
  ],
  groupBy: [
    "user_id",
  ],
};

Fields

FieldTypeRequiredDescriptionExample
startTimenumber✔️N/A1704067200
endTimenumberN/A1704153600
bucketWidthcomponents.BucketWidthN/A1d
limitnumberN/A30
pagestringN/Acursor_abc123
userIdsoperations.GetConversationsUsageQueryParamUserIdsFilter by platform user IDs (the same dimension group_by=user_id reports)[
"user_123",
"user_456"
]
externalUserIdsoperations.GetConversationsUsageQueryParamExternalUserIdsFilter by delegated end-user IDs (externalUserId, i.e. X-On-Behalf-Of subs)[
"sub_123"
]
allOrgsstringN/A
orgIdsoperations.GetConversationsUsageQueryParamOrgIdsFilter by organization IDs (cluster admins only, implies cluster scope)[
"org_123"
]
groupByoperations.GetConversationsUsageQueryParamGroupByGroup by specified fields[
"user_id"
]
xOnBehalfOfstringOptional external end-user identifier forwarded by the API gateway.