> ## Documentation Index
> Fetch the complete documentation index at: https://docs.convocore.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Workspace Usage

> Retrieves usage statistics and analytics for a workspace, this route must use the new V3 [endpoints](/api-reference/v3/intro).

## Example Request

```json theme={null}
{
  "range": {
    "start": 1700000000000,
    "end": 1700086400000
  },
  "logsPage": 1
}
```

<Note>
  Timestamps should be in Unix milliseconds format. Use `range` to specify custom date ranges.
</Note>

<Tip>
  Monitor your workspace usage to track costs, message volumes, and API consumption over time.
</Tip>


## OpenAPI

````yaml POST /workspaces/{uid}/usage
openapi: 3.0.3
info:
  title: Convocore OpenAPI
  description: Full API reference for Convocore
  version: 1.0.4
servers:
  - url: https://eu-gcp-api.vg-stuff.com/v3
security: []
paths:
  /workspaces/{uid}/usage:
    post:
      tags:
        - Workspaces
      summary: Get a workspace usage
      operationId: getUsage
      parameters:
        - name: uid
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                uiTimeRange: {}
                range:
                  type: object
                  properties:
                    start:
                      type: number
                    end:
                      type: number
                  required:
                    - start
                    - end
                  additionalProperties: false
                logsPage:
                  type: number
              additionalProperties: false
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  keyMetrics:
                    type: object
                    properties:
                      creditsCharged:
                        type: number
                      creditsConsumed:
                        type: number
                      llms:
                        $ref: '#/components/schemas/array_fd8c22fa'
                      agentsUsage:
                        type: array
                        items:
                          type: object
                          properties:
                            agentId:
                              type: string
                            creditsConsumed:
                              type: number
                            llmsUsage:
                              $ref: '#/components/schemas/array_fd8c22fa'
                          required:
                            - agentId
                            - creditsConsumed
                            - llmsUsage
                          additionalProperties: false
                    additionalProperties: false
                  logs:
                    type: array
                    items:
                      type: object
                      properties:
                        amount:
                          type: number
                        amount_string:
                          type: string
                        direction:
                          type: string
                          enum:
                            - increase
                            - decrease
                        causedBy:
                          type: string
                        reasonCode:
                          type: string
                        reasonText:
                          type: string
                        agentId:
                          type: string
                        featureKey:
                          type: string
                          enum:
                            - tools
                            - custom-branding
                            - ui-engine
                            - api-accesss
                            - crawler
                            - v2v
                            - handoff
                            - channels
                            - mini-whitelabel
                            - whitelabel-new
                            - chat-export-api
                        logMessage:
                          type: string
                        schemaVersion:
                          type: number
                        vgSpecific:
                          type: object
                          properties:
                            inputTokens:
                              type: number
                            outputTokens:
                              type: number
                            modelId:
                              type: string
                          additionalProperties: false
                        ts:
                          type: number
                        providers: {}
                        orgId:
                          type: string
                        orgName:
                          type: string
                        consumedFromOrg:
                          type: boolean
                      required:
                        - amount
                        - ts
                      additionalProperties: false
                  charts:
                    type: array
                    items:
                      type: object
                      properties:
                        key:
                          type: string
                          enum:
                            - usage-across-features
                            - usage-across-agents
                            - credits-usage-global
                            - llm-tokens-usage
                            - credits-usage-agents
                        type:
                          type: string
                          enum:
                            - pie
                            - line
                            - bar
                        data: {}
                      required:
                        - key
                        - type
                      additionalProperties: false
                additionalProperties: true
        default:
          $ref: '#/components/responses/error'
      security:
        - Authorization: []
components:
  schemas:
    array_fd8c22fa:
      type: array
      items:
        $ref: '#/components/schemas/modelId_inputTokens_outputTokens_aa48b3'
    modelId_inputTokens_outputTokens_aa48b3:
      type: object
      properties:
        modelId:
          type: string
        inputTokens:
          type: number
        outputTokens:
          type: number
      required:
        - modelId
        - inputTokens
        - outputTokens
      additionalProperties: false
    message_11569e:
      type: object
      properties:
        message:
          type: string
      required:
        - message
      additionalProperties: false
  responses:
    error:
      description: Error response
      content:
        application/json:
          schema:
            type: object
            properties:
              message:
                type: string
              code:
                type: string
              issues:
                type: array
                items:
                  $ref: '#/components/schemas/message_11569e'
            required:
              - message
              - code
            additionalProperties: false
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````