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

# GET /api/insights/usage



## OpenAPI

````yaml /api/worksong.openapi.json get /api/insights/usage
openapi: 3.1.0
info:
  title: Worksong API
  version: 042e65d5f227
  description: >-
    The HTTP API behind the Worksong apps, generated from the code at the commit
    below. Request and response shapes come from the shared zod contract; an
    operation marked `x-gaps` has a part the generator could not resolve.
  x-source: worksong-ai/worksong@042e65d5f2275493f60f879c7970dcfdeceb7e0e
servers:
  - url: https://app.worksong.ai
security:
  - bearerAuth: []
tags:
  - name: Approvals
  - name: Audit
  - name: Avatar generator
  - name: Bootstrap
  - name: Bot compute limit
  - name: Bot mcp servers
  - name: Bots
  - name: Calls
  - name: Connections
  - name: Contacts
  - name: Conversations
  - name: Coupons
  - name: Day grants
  - name: Desktop
  - name: Entity files
  - name: Files
  - name: Github
  - name: Insights
  - name: Login
  - name: Mcp servers
  - name: Me
  - name: Me bot messaging
  - name: Me chat header
  - name: Me daily limit
  - name: Me time zone
  - name: Memory
  - name: Message delete
  - name: Messages
  - name: Notifications
  - name: Optimize prompt
  - name: Phone
  - name: Places
  - name: Projects
  - name: Public file links
  - name: Push
  - name: Queue
  - name: Reactions
  - name: Register
  - name: Rooms
  - name: Routes
  - name: Routines
  - name: Runs
  - name: Skills
  - name: Tasks
  - name: Transcribe
  - name: Tts
  - name: Webhooks
  - name: Whats new
  - name: Whatsapp
  - name: Workspace files
paths:
  /api/insights/usage:
    get:
      tags:
        - Insights
      summary: GET /api/insights/usage
      operationId: get_api_insights_usage
      parameters:
        - name: range
          in: query
          required: false
          schema:
            default: 7d
            type: string
            enum:
              - 24h
              - 7d
              - 30d
              - custom
        - name: from
          in: query
          required: false
          schema:
            type: string
        - name: to
          in: query
          required: false
          schema:
            type: string
        - name: measure
          in: query
          required: false
          schema:
            default: tokens
            type: string
            enum:
              - tokens
              - actions
              - runs
              - turns
        - name: timeZone
          in: query
          required: false
          schema:
            default: UTC
            type: string
            minLength: 1
            maxLength: 64
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  range:
                    type: string
                    enum:
                      - 24h
                      - 7d
                      - 30d
                      - custom
                  measure:
                    type: string
                    enum:
                      - tokens
                      - actions
                      - runs
                      - turns
                  timeZone:
                    type: string
                  bucket:
                    type: string
                    enum:
                      - hour
                      - day
                      - week
                  from:
                    type: string
                    format: date-time
                  to:
                    type: string
                    format: date-time
                  previousFrom:
                    type: string
                    format: date-time
                  previousTo:
                    type: string
                    format: date-time
                  buckets:
                    type: array
                    items:
                      type: string
                      format: date-time
                  agents:
                    type: array
                    items:
                      type: object
                      properties:
                        agentId:
                          type: string
                          format: uuid
                        series:
                          type: array
                          items:
                            type: integer
                            minimum: 0
                            maximum: 9007199254740991
                        totals:
                          type: object
                          properties:
                            tokens:
                              type: integer
                              minimum: 0
                              maximum: 9007199254740991
                            actions:
                              type: integer
                              minimum: 0
                              maximum: 9007199254740991
                            runs:
                              type: integer
                              minimum: 0
                              maximum: 9007199254740991
                            turns:
                              type: integer
                              minimum: 0
                              maximum: 9007199254740991
                          required:
                            - tokens
                            - actions
                            - runs
                            - turns
                          additionalProperties: false
                        previous:
                          type: object
                          properties:
                            tokens:
                              type: integer
                              minimum: 0
                              maximum: 9007199254740991
                            actions:
                              type: integer
                              minimum: 0
                              maximum: 9007199254740991
                            runs:
                              type: integer
                              minimum: 0
                              maximum: 9007199254740991
                            turns:
                              type: integer
                              minimum: 0
                              maximum: 9007199254740991
                          required:
                            - tokens
                            - actions
                            - runs
                            - turns
                          additionalProperties: false
                      required:
                        - agentId
                        - series
                        - totals
                        - previous
                      additionalProperties: false
                required:
                  - range
                  - measure
                  - timeZone
                  - bucket
                  - from
                  - to
                  - previousFrom
                  - previousTo
                  - buckets
                  - agents
                additionalProperties: false
        4XX:
          description: Error. A problem object with a status and a message.
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.