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

# List workspace usage

> List workspace task, DAG, and operator activity metrics synced from the org's Sigma cost breakdown export, aggregated by day, week, or month. Enterprise+ tier only.



## OpenAPI

````yaml /astro/api/v-1-labs/openapi.yaml get /organizations/{organizationId}/billing/aggregate/workspace-usage
openapi: 3.0.3
info:
  contact: {}
  description: Astro Labs API - Experimental endpoints for preview features
  title: Astro Labs API
  version: v1
servers:
  - url: https://api.astronomer.io/labs/v1
security:
  - JWT: []
tags:
  - description: >-
      Canned-data placeholder used to exercise the labs epoch versioning
      surface. Real labs endpoints register their own tags.
    name: Example
  - name: allowed-ip-address-range
    x-group: Allowed IP Address Range
paths:
  /organizations/{organizationId}/billing/aggregate/workspace-usage:
    get:
      tags:
        - Billing
      summary: List workspace usage
      description: >-
        List workspace task, DAG, and operator activity metrics synced from the
        org's Sigma cost breakdown export, aggregated by day, week, or month.
        Enterprise+ tier only.
      operationId: LabsListWorkspaceUsage
      parameters:
        - description: The ID of the Organization to retrieve usage data for.
          in: path
          name: organizationId
          required: true
          schema:
            type: string
        - description: Start of the date range (YYYY-MM-DD).
          in: query
          name: startDate
          required: true
          schema:
            type: string
        - description: >-
            End of the date range
            (YYYY-MM-DD).                                       
            Range                    must  not  exceed  12  months.
          in: query
          name: endDate
          required: true
          schema:
            type: string
        - description: The granularity to aggregate by.
          in: query
          name: timeGrain
          schema:
            default: day
            enum:
              - day
              - week
              - month
            type: string
        - description: Filter by workspace ID. At most 1000.
          in: query
          name: workspaceId
          schema:
            items:
              type: string
            type: array
        - description: The number of results to skip before returning values.
          in: query
          name: offset
          schema:
            default: 0
            minimum: 0
            type: integer
        - description: The maximum number of results to return.
          in: query
          name: limit
          schema:
            default: 20
            maximum: 1000
            minimum: 1
            type: integer
        - description: >-
            Fields to sort by, formatted as `<fieldName>:asc` or
            `<fieldName>:desc`.
          in: query
          name: sorts
          schema:
            items:
              type: string
            type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceUsagesPaginated'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Forbidden
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Too Many Requests
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Internal Server Error
      security:
        - JWT: []
components:
  schemas:
    WorkspaceUsagesPaginated:
      properties:
        items:
          description: The list of workspace usage rows in the current page.
          items:
            $ref: '#/components/schemas/WorkspaceUsage'
          type: array
        limit:
          description: The maximum number of results in one page.
          example: 20
          type: integer
        offset:
          description: The offset of the current page of results.
          example: 0
          type: integer
        totalCount:
          description: The total number of workspace usage rows matching the query.
          example: 5139
          type: integer
      required:
        - items
        - limit
        - offset
        - totalCount
      type: object
    Error:
      properties:
        fieldErrors:
          description: >-
            FieldErrors carries one entry per failed request-validation
            constraint.

            Only present on 400 responses caused by request binding/validation.
          items:
            $ref: '#/components/schemas/FieldValidationError'
          type: array
        message:
          type: string
        requestId:
          type: string
        statusCode:
          maximum: 600
          minimum: 400
          type: integer
      required:
        - message
        - requestId
        - statusCode
      type: object
    WorkspaceUsage:
      properties:
        accountId:
          description: The Salesforce account ID.
          type: string
        accountName:
          description: The Salesforce account name.
          type: string
        dagOnlyDeployCount:
          description: Count of DAG-only style deployments in the workspace.
          type: integer
        date:
          description: The period start date (YYYY-MM-DD).
          type: string
        daysInPeriod:
          description: The number of days included in the period.
          type: integer
        deploymentCount:
          description: Total number of deployments in the workspace.
          type: integer
        distinctDagCount:
          description: Number of unique DAGs executed in the period.
          type: integer
        distinctOperatorCount:
          description: Number of unique Airflow operators used in the period.
          type: integer
        distinctOperatorList:
          description: The distinct Airflow operator names used in the period.
          items:
            type: string
          type: array
        isCurrentPeriod:
          description: Whether this row belongs to the current period.
          type: boolean
        isLastPeriod:
          description: Whether this row belongs to the previous period.
          type: boolean
        organizationId:
          description: The ID of the organization.
          type: string
        organizationName:
          description: The display name of the organization.
          type: string
        periodsAgo:
          description: Number of periods prior to the current one.
          type: integer
        taskFailureCount:
          description: Count of failed task attempts in the period.
          type: integer
        taskSuccessCount:
          description: Count of successfully completed tasks in the period.
          type: integer
        taskTotalCount:
          description: Sum of all task attempts in the period.
          type: integer
        timeGrain:
          description: 'The granularity of the period: day, week, or month.'
          type: string
        workspaceDescription:
          description: The workspace's description.
          type: string
        workspaceId:
          description: The ID of the workspace.
          type: string
        workspaceName:
          description: The display name of the workspace.
          type: string
      required:
        - dagOnlyDeployCount
        - date
        - daysInPeriod
        - deploymentCount
        - distinctDagCount
        - distinctOperatorCount
        - isCurrentPeriod
        - isLastPeriod
        - organizationId
        - periodsAgo
        - taskFailureCount
        - taskSuccessCount
        - taskTotalCount
        - timeGrain
        - workspaceId
      type: object
    FieldValidationError:
      properties:
        code:
          type: string
        field:
          type: string
        message:
          type: string
      required:
        - code
        - field
        - message
      type: object
  securitySchemes:
    JWT:
      scheme: bearer
      type: http

````