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

# Get Data Usage

> Returns data usage summary for the team.



## OpenAPI

````yaml openapi_v5.yaml get /dataplans/data-usage/v2
openapi: 3.0.0
info:
  title: ''
  version: 1.0.0
servers:
  - url: https://api.coralogix.com/mgmt/openapi/5
  - url: https://api.eu2.coralogix.com/mgmt/openapi/5
  - url: https://api.coralogix.us/mgmt/openapi/5
  - url: https://api.cx498.coralogix.com/mgmt/openapi/5
  - url: https://api.coralogix.in/mgmt/openapi/5
  - url: https://api.coralogixsg.com/mgmt/openapi/5
  - url: https://api.ap3.coralogix.com/mgmt/openapi/5
security:
  - apiKeyAuth: []
tags:
  - name: AI Applications Service
    description: Manage the catalog of AI applications discovered from spans.
    externalDocs:
      url: ''
  - name: AI Evaluations Service
    description: >-
      Manage AI evaluations and the custom evaluation catalog for AI
      applications.
    externalDocs:
      url: ''
  - name: API Keys Admin Service
    description: Administrative operations for API Keys management.
    externalDocs:
      url: ''
  - name: API Keys Service
    description: Manage your API Keys.
    externalDocs:
      url: ''
  - name: Actions Service
    description: View and manage your Actions.
    externalDocs:
      url: ''
  - name: Alert Scheduler Rule service
    description: Manage your alert scheduler rules.
    externalDocs:
      url: ''
  - name: Alert definitions service
    description: >-
      View and manage your alerts using alert definitions - data structures that
      contain the configuration required to create an alert.
    externalDocs:
      description: Learn more about alerts in our documentation
      url: https://coralogix.com/docs/user-guides/alerting/introduction-to-alerts/
  - name: Alert events service
    description: >-
      Get information regarding your alert events - instances of alerts being
      triggered.
    externalDocs:
      description: Learn more about alert events and incidents in our documentation.
      url: https://coralogix.com/docs/user-guides/alerting/incidents/
  - name: Case Events service
    description: Manage case events, comments, and external thread synchronization.
    externalDocs:
      url: ''
  - name: Case Settings service
    description: Manage case settings team configurations.
    externalDocs:
      url: ''
  - name: Cases notification service
    description: Track notification adjacent data for cases.
    externalDocs:
      url: ''
  - name: Cases service
    description: >-
      Manage cases throughout their lifecycle. Create, view, assign,
      acknowledge, unacknowledge, resolve, and close cases to streamline
      investigations and follow-ups.
    externalDocs:
      description: Learn more about Cases in our documentation
      url: https://coralogix.com/docs/user-guides/cases/
  - name: Connector Schema service
    description: Retrieve connector schemas for notification center integrations
    externalDocs:
      description: Learn more about connectors in our documentation
      url: >-
        https://coralogix.com/docs/user-guides/notification-center/connectors/introduction/
  - name: Connectors service
    description: >-
      View and manage your connectors - integration instances for notification
      destinations
    externalDocs:
      description: Lean more about connectors in our documentation
      url: >-
        https://coralogix.com/docs/user-guides/notification-center/connectors/introduction/
  - name: Contextual data integration service
    description: Query for contextual data integration information.
    externalDocs:
      url: ''
  - name: Custom Enrichments Service
    description: Manage your enrichments.
    externalDocs:
      url: ''
  - name: Dashboard folders service
    description: Manage your dashboard folders.
    externalDocs:
      url: ''
  - name: Dashboard service
    description: Get information about the Coralogix Dashboard catalog.
    externalDocs:
      url: ''
  - name: Data Usage Query service
    description: >-
      Query billable data usage through the public Coralogix API using daily or
      hourly bucketed aggregations over supported labels.
    externalDocs:
      url: ''
  - name: Data Usage Service
    description: A service to manage data usage metrics.
    externalDocs:
      url: ''
  - name: Enrichments Service
    description: Manage your enrichments.
    externalDocs:
      url: ''
  - name: Entities service
    description: Query information about registered entities in the notification center
    externalDocs:
      description: Lean more about the notification center in our documentation
      url: https://coralogix.com/docs/user-guides/notification-center/introduction/
  - name: Events Service
    description: A service for querying events.
    externalDocs:
      description: Learn more about alerts in our documentation
      url: https://coralogix.com/docs/user-guides/alerting/introduction-to-alerts/
  - name: Events2Metrics Service
    description: Manage your events2metrics.
    externalDocs:
      url: ''
  - name: Extension deployment service
    description: A service that enables querying for extension deployment information.
    externalDocs:
      description: Find out more about extensions in our documentation.
      url: https://coralogix.com/docs/integrations/extensions/
  - name: Extension service
    description: A service that enables querying for extension information.
    externalDocs:
      description: Learn more about extensions in our documentation.
      url: https://coralogix.com/docs/integrations/extensions/
  - name: Folders for views service
    description: Create and manage view folders.
    externalDocs:
      url: ''
  - name: Global routers service
    description: >-
      View and manage your global routers - entities that direct notifications
      to configured destinations based on conditions
    externalDocs:
      description: Lean more about global routers in our documentation
      url: >-
        https://coralogix.com/docs/user-guides/notification-center/routing/introduction/
  - name: IP access service
    description: >-
      IP access service provides the API for managing company IP access
      settings.
    externalDocs:
      url: ''
  - name: Incidents service
    description: >-
      Handle all operations related to incident management within Coralogix.
      Identify, manage, and resolve incidents efficiently through automated
      workflows and team collaboration.
    externalDocs:
      description: Find out more about incident management in our documentation
      url: https://coralogix.com/docs/user-guides/alerting/incidents/
  - name: Integration service
    description: A service that enables querying for integration information.
    externalDocs:
      description: Find out more about integrations in our documentation.
      url: https://coralogix.com/docs/integrations/getting-started/
  - name: Metrics Data Archive Service
    description: View and manage your storage targets for metrics.
    externalDocs:
      description: Find out more about archives
      url: >-
        https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/
  - name: Notifications testing service
    description: >-
      Test your notification center configurations including connectors,
      presets, and templates
    externalDocs:
      description: Lean more about the notification center in our documentation
      url: https://coralogix.com/docs/user-guides/notification-center/introduction/
  - name: Outgoing webhooks service
    externalDocs:
      description: Find out more about outbound webhooks in our documentation.
      url: >-
        https://coralogix.com/docs/user-guides/alerting/outbound-webhooks/generic-outbound-webhooks-alert-webhooks/
  - name: Policies Service
    description: View and manage your TCO policies
    externalDocs:
      url: ''
  - name: Presets service
    description: >-
      View and manage your presets - pre-configured templates for notification
      content rendering
    externalDocs:
      description: Lean more about presets in our documentation
      url: >-
        https://coralogix.com/docs/user-guides/notification-center/presets/introduction/
  - name: Quota Allocation Rule Set service
    description: Manage quota allocation rules for different entity types.
    externalDocs:
      url: ''
  - name: Recording Rules Service
    description: A service to manage recording rules.
    externalDocs:
      url: ''
  - name: Retentions Service
    description: View and manage retentions
    externalDocs:
      url: ''
  - name: Role Management Service
    description: Service for managing system and custom roles.
    externalDocs:
      url: ''
  - name: Rule Groups Service
    description: A service to manage rule groups.
    externalDocs:
      url: ''
  - name: SAML Configuration Service
    description: Manage your SAML configuration
    externalDocs:
      url: ''
  - name: Scopes Service
    description: A service to manage scopes
    externalDocs:
      url: ''
  - name: Slos Service
    description: A service for managing Service Level Objectives (SLOs).
    externalDocs:
      url: ''
  - name: Target Service
    description: View and manage your storage targets for logs.
    externalDocs:
      description: Find out more about archives
      url: >-
        https://coralogix.com/docs/user-guides/data-flow/s3-archive/connect-s3-archive/
  - name: Team Groups Management Service
    description: Manage Team Groups.
    externalDocs:
      url: ''
  - name: Users Management Service
    description: >-
      Manage team members (users) including creation, updates, search, and
      status management.
    externalDocs:
      url: ''
  - name: Views service
    description: Create and manage views.
    externalDocs:
      url: ''
paths:
  /dataplans/data-usage/v2:
    get:
      tags:
        - Data Usage Service
      summary: Get Data Usage
      description: Returns data usage summary for the team.
      operationId: DataUsageService_GetDataUsage
      parameters:
        - description: Date interval to query data usage over.
          in: query
          name: date_range
          required: false
          schema:
            title: Date Range
            type: object
            properties:
              fromDate:
                minLength: 0
                type: string
                description: The from date.
                format: date-time
                example: '2021-01-01T00:00:00.000Z'
              toDate:
                minLength: 0
                type: string
                description: The to date.
                format: date-time
                example: '2021-01-01T00:00:00.000Z'
            description: This data structure represents a date range.
            externalDocs:
              description: Find out more about data usage.
              url: >-
                https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/
        - description: >-
            Aggregation resolution. Minimum supported value is 1h. Must be
            between 1 hour and the date_range interval.
          in: query
          name: resolution
          required: false
          schema:
            minLength: 0
            type: string
            description: >-
              Aggregation resolution. Minimum supported value is 1h. Must be
              between 1 hour and the date_range interval.
        - description: >-
            List of fields to aggregate results by (for example pillar and
            priority).
          in: query
          name: aggregate
          required: false
          schema:
            minItems: 0
            type: array
            items:
              $ref: '#/components/schemas/AggregateBy'
            description: >-
              List of fields to aggregate results by (for example pillar and
              priority).
        - description: >-
            Dimensions to filter results by; only entries that contain all
            listed dimensions are returned.
          in: query
          name: dimension_filters
          required: false
          schema:
            description: >-
              Dimensions to filter results by; only entries that contain all
              listed dimensions are returned.
            items:
              oneOf:
                - required:
                    - pillar
                  type: object
                - required:
                    - genericDimension
                  type: object
                - required:
                    - tier
                  type: object
                - required:
                    - severity
                  type: object
                - required:
                    - priority
                  type: object
                - type: object
                  not:
                    anyOf:
                      - required:
                          - pillar
                        type: object
                      - required:
                          - genericDimension
                        type: object
                      - required:
                          - tier
                        type: object
                      - required:
                          - severity
                        type: object
                      - required:
                          - priority
                        type: object
              properties:
                genericDimension:
                  title: Generic Dimension
                  type: object
                  properties:
                    key:
                      minLength: 0
                      type: string
                      description: The key.
                      example: key
                    value:
                      minLength: 0
                      type: string
                      description: The value.
                      example: value
                  description: This data structure represents a generic dimension.
                  externalDocs:
                    description: Find out more about data usage.
                    url: >-
                      https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/
                pillar:
                  $ref: '#/components/schemas/v2.Pillar'
                priority:
                  $ref: '#/components/schemas/v2.Priority'
                severity:
                  $ref: '#/components/schemas/datausage.v2.Severity'
                tier:
                  $ref: '#/components/schemas/v2.TcoTier'
              type: object
            minItems: 0
            type: array
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDataUsageResponse'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Bad Request
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized request
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Internal server error
      externalDocs:
        url: ''
components:
  schemas:
    AggregateBy:
      enum:
        - AGGREGATE_BY_UNSPECIFIED
        - AGGREGATE_BY_APPLICATION
        - AGGREGATE_BY_SUBSYSTEM
        - AGGREGATE_BY_PILLAR
        - AGGREGATE_BY_PRIORITY
        - AGGREGATE_BY_POLICY_NAME
        - AGGREGATE_BY_SEVERITY
      type: string
    v2.Pillar:
      enum:
        - PILLAR_UNSPECIFIED
        - PILLAR_METRICS
        - PILLAR_LOGS
        - PILLAR_SPANS
        - PILLAR_BINARY
        - PILLAR_PROFILES
      type: string
      description: Pillar.
    v2.Priority:
      enum:
        - PRIORITY_UNSPECIFIED
        - PRIORITY_LOW
        - PRIORITY_MEDIUM
        - PRIORITY_HIGH
        - PRIORITY_BLOCKED
      type: string
      description: Priority.
    datausage.v2.Severity:
      enum:
        - SEVERITY_UNSPECIFIED
        - SEVERITY_DEBUG
        - SEVERITY_VERBOSE
        - SEVERITY_INFO
        - SEVERITY_WARNING
        - SEVERITY_ERROR
        - SEVERITY_CRITICAL
      type: string
      description: Severity.
    v2.TcoTier:
      enum:
        - TCO_TIER_UNSPECIFIED
        - TCO_TIER_LOW
        - TCO_TIER_MEDIUM
        - TCO_TIER_HIGH
        - TCO_TIER_BLOCKED
      type: string
      description: Deprecated TCO tier classification.
    GetDataUsageResponse:
      title: Get Data Usage Response
      type: object
      properties:
        entries:
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/DataUsageEntry'
          description: List of entries.
      description: This data structure is used to return data usage.
      externalDocs:
        description: Find out more about data usage.
        url: >-
          https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/
    Error:
      type: object
      properties:
        code:
          maximum: 599
          minimum: 100
          type: integer
          description: HTTP status code of the error (for example 400, 404, 500).
          format: int32
        message:
          maxLength: 4096
          minLength: 0
          pattern: ^[\s\S]*$
          type: string
          description: Human-readable description of the error.
      description: Standard error response body returned for a failed request.
    DataUsageEntry:
      title: Data Usage Entry
      type: object
      properties:
        dimensions:
          minItems: 0
          type: array
          items:
            $ref: '#/components/schemas/Dimension'
          description: The dimensions.
        sizeGb:
          type: number
          description: The size gb.
          format: float
        timestamp:
          minLength: 0
          type: string
          description: Timestamp.
          format: date-time
        units:
          type: number
          description: The units.
          format: float
      description: This data structure represents a data usage entry.
      externalDocs:
        description: Find out more about data usage.
        url: >-
          https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/
    Dimension:
      type: object
      oneOf:
        - required:
            - pillar
          type: object
        - required:
            - genericDimension
          type: object
        - required:
            - tier
          type: object
        - required:
            - severity
          type: object
        - required:
            - priority
          type: object
        - type: object
          not:
            anyOf:
              - required:
                  - pillar
                type: object
              - required:
                  - genericDimension
                type: object
              - required:
                  - tier
                type: object
              - required:
                  - severity
                type: object
              - required:
                  - priority
                type: object
      properties:
        genericDimension:
          $ref: '#/components/schemas/GenericDimension'
        pillar:
          $ref: '#/components/schemas/v2.Pillar'
        priority:
          $ref: '#/components/schemas/v2.Priority'
        severity:
          $ref: '#/components/schemas/datausage.v2.Severity'
        tier:
          $ref: '#/components/schemas/v2.TcoTier'
    GenericDimension:
      title: Generic Dimension
      type: object
      properties:
        key:
          minLength: 0
          type: string
          description: The key.
          example: key
        value:
          minLength: 0
          type: string
          description: The value.
          example: value
      description: This data structure represents a generic dimension.
      externalDocs:
        description: Find out more about data usage.
        url: >-
          https://coralogix.com/docs/user-guides/account-management/payment-and-billing/data-usage/
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: API key authentication

````