/v1/usageRecords/getWorkspaceSummedUsage
—
post
Path Parameters
Request Headers
HttpEndpointRequestHeaders_AuthRequired_JsonContentType

FieldTypeRequiredDescription
AuthorizationstringYes

Access token

Example: Bearer <token>

Content-TypestringYes

HTTP JSON request content type

Example: application/json

Request Query
Request Body
GetWorkspaceSummedUsageEndpointParams

Parameters for retrieving workspace usage records

{
workspaceId?: string
page?: number
pageSize?: number
query?: SummedUsageQuery
}
SummedUsageQuery

Query parameters for filtering usage records

{
category?: string | Array<string>
fromDate?: number
toDate?: number
fulfillmentStatus?: string | Array<string>
}
200 — Response Headers
HttpEndpointResponseHeaders_ContentType_ContentLength

FieldTypeRequiredDescription
Content-TypestringYes

HTTP JSON response content type

Example: application/json

Content-LengthstringYes

HTTP response content length in bytes

Example: 1024

200 — Response Body
GetWorkspaceSummedUsageEndpointResult

Response containing workspace usage records and pagination info

{
records: Array<UsageRecord>
page: number
}
UsageRecord

A workspace usage record containing usage metrics and costs

{
resourceId: string
createdBy: Agent
createdAt: number
lastUpdatedBy: Agent
lastUpdatedAt: number
isDeleted: boolean
deletedAt?: number
deletedBy?: Agent
workspaceId: string
category: string
usage: number
usageCost: number
status: string
month: number
year: number
}
Agent

Represents a user or system entity that performed an action (e.g., created or updated a resource)

{
agentId: string
agentType: string
}
4XX or 5XX — Response Headers
HttpEndpointResponseHeaders_ContentType_ContentLength

FieldTypeRequiredDescription
Content-TypestringYes

HTTP JSON response content type

Example: application/json

Content-LengthstringYes

HTTP response content length in bytes

4XX or 5XX — Response Body
EndpointErrorResult

Endpoint error result

{
errors?: Array<ExternalError>
}
ExternalError

{
message: string
}