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

# Get API Usage

> Daily API request counts per endpoint for your account over a datetime window.

Defaults to the last 30 days ending now. Maximum window is 90 days.
Counts are near real-time and bucketed by calendar day in the requested
timezone, matching the usage graph in the dashboard.



## OpenAPI

````yaml get /v1/reporting/usage
openapi: 3.1.0
info:
  title: Channel3 API
  version: 0.1.0
servers:
  - url: https://api.trychannel3.com
    description: Production
security: []
paths:
  /v1/reporting/usage:
    get:
      tags:
        - v1
      summary: Get API Usage
      description: >-
        Daily API request counts per endpoint for your account over a datetime
        window.


        Defaults to the last 30 days ending now. Maximum window is 90 days.

        Counts are near real-time and bucketed by calendar day in the requested

        timezone, matching the usage graph in the dashboard.
      operationId: get_usage_v1_reporting_usage_get
      parameters:
        - name: start_date
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date-time
              - type: 'null'
            description: >-
              Inclusive start of the window (ISO 8601 datetime with optional
              offset, e.g. 2026-08-01T00:00:00-04:00). Offset-aware values are
              converted to UTC; naive values are treated as UTC.
            title: Start Date
          description: >-
            Inclusive start of the window (ISO 8601 datetime with optional
            offset, e.g. 2026-08-01T00:00:00-04:00). Offset-aware values are
            converted to UTC; naive values are treated as UTC.
        - name: end_date
          in: query
          required: false
          schema:
            anyOf:
              - type: string
                format: date-time
              - type: 'null'
            description: >-
              Inclusive end of the window (ISO 8601 datetime with optional
              offset, e.g. 2026-08-01T23:59:59-04:00). Offset-aware values are
              converted to UTC; naive values are treated as UTC.
            title: End Date
          description: >-
            Inclusive end of the window (ISO 8601 datetime with optional offset,
            e.g. 2026-08-01T23:59:59-04:00). Offset-aware values are converted
            to UTC; naive values are treated as UTC.
        - name: timezone
          in: query
          required: false
          schema:
            type: string
            description: >-
              IANA timezone used to bucket requests into calendar days (e.g.
              America/New_York). Defaults to UTC.
            default: UTC
            title: Timezone
          description: >-
            IANA timezone used to bucket requests into calendar days (e.g.
            America/New_York). Defaults to UTC.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UsageResponse'
        '400':
          description: Invalid date range or timezone
          content:
            application/json:
              example:
                detail: Date range cannot exceed 90 days
              schema:
                $ref: '#/components/schemas/app__routers__utils__ErrorResponse'
        '401':
          description: Unauthorized - Invalid or missing authentication
          content:
            application/json:
              examples:
                missing_key:
                  summary: Missing API Key
                  value:
                    detail: >-
                      Unauthorized. Missing authentication key. Make sure to
                      attach an x-api-key with your request. Need help? Reach
                      out to support@trychannel3.com.
                invalid_key:
                  summary: Invalid API Key
                  value:
                    detail: >-
                      API key was provided but is invalid. Need help? Reach out
                      to support@trychannel3.com.
              schema:
                $ref: '#/components/schemas/app__routers__utils__ErrorResponse'
        '402':
          description: Payment required
          content:
            application/json:
              examples:
                credits_exhausted:
                  summary: API key out of credits
                  value:
                    detail: >-
                      You have used all of your free credits. Add a payment
                      method to continue.
                mpp_challenge:
                  summary: MPP Tempo payment required
                  value:
                    detail: >-
                      Payment required. Satisfy the MPP Tempo challenge in
                      WWW-Authenticate.
              schema:
                $ref: '#/components/schemas/app__routers__utils__ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/app__routers__utils__ErrorResponse'
              example:
                detail:
                  - loc:
                      - body
                      - query
                    msg: field required
                    type: value_error.missing
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/app__routers__utils__ErrorResponse'
              example:
                detail: Internal Server Error
      security:
        - APIKeyHeader: []
components:
  schemas:
    UsageResponse:
      properties:
        endpoints:
          items:
            type: string
          type: array
          title: Endpoints
          description: Distinct endpoint names present in the range, sorted.
        days:
          items:
            $ref: '#/components/schemas/UsageDay'
          type: array
          title: Days
          description: One entry per day with at least one request, oldest first.
        total_requests:
          type: integer
          title: Total Requests
          description: All API requests in the date range.
        start_date:
          type: string
          format: date-time
          title: Start Date
          description: Inclusive start of the resolved query window.
        end_date:
          type: string
          format: date-time
          title: End Date
          description: Inclusive end of the resolved query window.
        timezone:
          type: string
          title: Timezone
          description: IANA timezone used to bucket days.
      type: object
      required:
        - endpoints
        - days
        - total_requests
        - start_date
        - end_date
        - timezone
      title: UsageResponse
      description: Daily API request counts per endpoint for a vendor over a date range.
    app__routers__utils__ErrorResponse:
      properties:
        detail:
          anyOf:
            - type: string
            - items:
                additionalProperties: true
                type: object
              type: array
          title: Detail
      type: object
      required:
        - detail
      title: ErrorResponse
    UsageDay:
      properties:
        date:
          type: string
          title: Date
          description: Calendar day (YYYY-MM-DD) in the requested timezone.
        total_requests:
          type: integer
          title: Total Requests
          description: All API requests made on this day.
        counts:
          additionalProperties:
            type: integer
          type: object
          title: Counts
          description: Request count per endpoint for this day, keyed by endpoint name.
      type: object
      required:
        - date
        - total_requests
        - counts
      title: UsageDay
      description: API request counts for one calendar day, split by endpoint.
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: x-api-key

````

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