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

# Get usage statistics

> Aggregate usage for the current period. Free.

This is a summary and takes no parameters — it does not paginate. For the individual calls, use `GET /account/history`.



## OpenAPI

````yaml /openapi.json get /account/usage
openapi: 3.1.0
info:
  title: BounceWatch API
  version: 1.0.0
  description: >-
    Company enrichment and buying-signal data.


    Every endpoint below is live — put your API key in the panel above and press
    **Send**.


    Account endpoints are free. Enrichment spends credits, and a domain enriched
    within the last 24 hours comes back instantly at no cost.
  contact:
    name: BounceWatch Support
    email: sedat@bouncewatch.com
    url: https://docs.bouncewatch.com
servers:
  - url: https://api.bouncewatch.com/api/v1
    description: Production
security:
  - apiKey: []
tags:
  - name: Company
    description: Enrich a company by domain.
  - name: Enrichment
    description: Track an enrichment batch while it runs, and collect the results.
  - name: Account
    description: >-
      Plan, credits, usage and webhook configuration. None of these consume
      credits.
  - name: Status
    description: Liveness. No key, no credits — point your uptime monitor here.
paths:
  /account/usage:
    get:
      tags:
        - Account
      summary: Get usage statistics
      description: >-
        Aggregate usage for the current period. Free.


        This is a summary and takes no parameters — it does not paginate. For
        the individual calls, use `GET /account/history`.
      operationId: getUsage
      responses:
        '200':
          description: Usage summary.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Usage'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    Usage:
      type: object
      properties:
        success:
          type: boolean
          examples:
            - true
        data:
          type: object
          properties:
            current_limits:
              type: object
              description: Live counters behind your rate limits.
              properties:
                requests_today:
                  type: integer
                  examples:
                    - 45
                requests_this_minute:
                  type: integer
                  examples:
                    - 2
                last_request:
                  type:
                    - string
                    - 'null'
                  format: date-time
            monthly_usage:
              type: object
              description: Totals for the current calendar month.
              properties:
                requests:
                  type: integer
                  examples:
                    - 1250
                credits_consumed:
                  type: integer
                  examples:
                    - 3200
                period:
                  type: object
                  properties:
                    start:
                      type: string
                      format: date-time
                    end:
                      type: string
                      format: date-time
            top_endpoints:
              type: array
              description: Your ten busiest endpoints this month.
              items:
                type: object
                properties:
                  endpoint:
                    type: string
                    examples:
                      - /api/v1/company/stripe.com
                  requests:
                    type: integer
                    examples:
                      - 42
                  credits_used:
                    type: integer
                    examples:
                      - 520
                  avg_credits_per_request:
                    type: number
                    examples:
                      - 12.38
            recent_requests:
              type: array
              description: >-
                Your last 20 requests. For more, page through
                `/account/history`.
              items:
                $ref: '#/components/schemas/RequestLogEntry'
    RequestLogEntry:
      type: object
      properties:
        id:
          type: integer
          examples:
            - 90211
        endpoint:
          type: string
          examples:
            - /api/v1/company/stripe.com
        method:
          type: string
          examples:
            - GET
        credits_consumed:
          type: integer
          examples:
            - 26
        response_status:
          type: integer
          examples:
            - 202
        response_time:
          type: number
          description: Seconds.
          examples:
            - 0.184
        requested_at:
          type: string
          format: date-time
    Error:
      type: object
      description: >-
        Every failure carries a machine-readable `error` code. Branch on that,
        never on `message` — the wording changes, the code does not.
      properties:
        success:
          type: boolean
          examples:
            - false
        error:
          type: string
          description: Stable machine-readable code.
          examples:
            - webhook_required
        message:
          type: string
          description: Human-readable explanation. Not stable — do not parse it.
          examples:
            - Webhook URL is required for enrichment requests
        hint:
          type: string
        documentation:
          type: string
      required:
        - success
        - error
  responses:
    Unauthorized:
      description: >-
        `missing_api_key` — no key was sent. `invalid_api_key` — the key is not
        valid. `api_key_disabled`, `ip_not_allowed` and `subscription_required`
        also land here.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            missing_api_key:
              value:
                success: false
                error: missing_api_key
                message: >-
                  Please provide your API key in X-API-Key header or api_key
                  parameter
    RateLimited:
      description: >-
        `rate_limit_exceeded` — too many requests. `concurrent_limit_reached` —
        too many enrichments running at once. `Retry-After` says how long to
        wait.
      headers:
        Retry-After:
          description: Seconds to wait before retrying.
          schema:
            type: integer
            examples:
              - 45
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            rate_limit_exceeded:
              value:
                success: false
                error: rate_limit_exceeded
                message: Rate limit exceeded. Please retry after 45 seconds.
                retry_after: 45
                limits:
                  per_minute: 150
                  per_day: 5000
                  current_minute: 150
                  current_day: 3204
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Your API key, from the [API
        Panel](https://bouncewatch.com/api-panel/api-keys).

````