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

# Get usage

> Calls, billed units, misses, errors and spend for each UTC day of the range, by product, and for each route. A key with full access reads the whole organization's usage, or one key's with `apiKeyId`; any other key reads only its own. Free.



## OpenAPI

````yaml /openapi.json get /v1/usage
openapi: 3.1.0
info:
  title: outbound.dev API
  version: v1
  description: Find people and companies, and see what every call costs, with one API key.
servers:
  - url: https://api.outbound.dev
security: []
tags:
  - name: People
    description: >-
      Search people with filters, a saved search or a plain-language query,
      count matches and look up filter values.
  - name: Companies
    description: >-
      Search companies, count matches, name one company by its name, domain or
      LinkedIn page, and list its people.
  - name: Saved searches
    description: Keep a search under a title and run it again, for people or for companies.
  - name: Jobs
    description: >-
      Long tasks a call started: their progress, what they produced and what
      they were charged.
  - name: Account
    description: >-
      The calling key and its organization, its rate limits, and revoking the
      key.
  - name: Billing
    description: The balance, the ledger of every change to it, and the price list.
  - name: Usage and requests
    description: >-
      Calls and spend by day, and the record of every request of the last 30
      days.
paths:
  /v1/usage:
    get:
      tags:
        - Usage and requests
      summary: Get usage
      description: >-
        Calls, billed units, misses, errors and spend for each UTC day of the
        range, by product, and for each route. A key with full access reads the
        whole organization's usage, or one key's with `apiKeyId`; any other key
        reads only its own. Free.
      operationId: getUsage
      parameters:
        - name: from
          in: query
          required: false
          description: >-
            The first UTC day, as `YYYY-MM-DD`. Without `from` and `to`, the
            last 30 days, today included.
          schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
          example: '2026-11-01'
        - name: to
          in: query
          required: false
          description: The last UTC day, as `YYYY-MM-DD`. A range covers at most 90 days.
          schema:
            type: string
            pattern: ^\d{4}-\d{2}-\d{2}$
          example: '2026-11-14'
        - name: apiKeyId
          in: query
          required: false
          description: Only this key's usage. A key without full access reads only its own.
          schema:
            type: string
            minLength: 24
            maxLength: 24
            pattern: ^[0-9a-fA-F]+$
      responses:
        '200':
          description: Calls and spend for each UTC day in the range, and for each route.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/RequestId'
            X-Charged-Usd:
              $ref: '#/components/headers/ChargedUsd'
            X-Balance-Usd:
              $ref: '#/components/headers/BalanceUsd'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
          content:
            application/json:
              schema:
                type: object
                required:
                  - days
                  - endpoints
                properties:
                  days:
                    type: array
                    items:
                      type: object
                      properties:
                        day:
                          type: string
                          description: The UTC day, as `YYYY-MM-DD`.
                        calls:
                          type: integer
                        billedUnits:
                          type: integer
                          description: >-
                            What the calls were billed for, such as records
                            returned.
                        misses:
                          type: integer
                          description: Calls that found nothing and cost nothing.
                        errors4xx:
                          type: integer
                        errors5xx:
                          type: integer
                        costUsd:
                          type: string
                          description: What the calls cost, in US dollars.
                        rateLimited:
                          type: integer
                          description: Calls answered 429, also counted in `errors4xx`.
                        byProduct:
                          type: array
                          items:
                            type: object
                            properties:
                              product:
                                type: string
                                enum:
                                  - search
                                  - enrichment
                                  - lists
                                  - campaigns
                                  - connections
                                  - account
                              calls:
                                type: integer
                              costUsd:
                                type: string
                                description: US dollars as an exact six-decimal string.
                  endpoints:
                    type: array
                    items:
                      type: object
                      properties:
                        endpoint:
                          type: string
                          description: The route, such as `/v1/people/search`.
                        product:
                          type: string
                          enum:
                            - search
                            - enrichment
                            - lists
                            - campaigns
                            - connections
                            - account
                        calls:
                          type: integer
                        billedUnits:
                          type: integer
                          description: >-
                            What the calls were billed for, such as records
                            returned.
                        misses:
                          type: integer
                          description: Calls that found nothing and cost nothing.
                        errors4xx:
                          type: integer
                        errors5xx:
                          type: integer
                        costUsd:
                          type: string
                          description: What the calls cost, in US dollars.
                        p95LatencyMs:
                          type: integer
                          description: >-
                            The 95th percentile answer time. Absent with no
                            calls.
              example:
                days:
                  - day: '2026-11-14'
                    calls: 12
                    billedUnits: 18
                    misses: 1
                    errors4xx: 1
                    errors5xx: 0
                    rateLimited: 0
                    costUsd: '0.001800'
                    byProduct:
                      - product: search
                        calls: 9
                        costUsd: '0.001800'
                      - product: account
                        calls: 3
                        costUsd: '0.000000'
                endpoints:
                  - endpoint: /v1/people/search
                    product: search
                    calls: 4
                    billedUnits: 10
                    misses: 1
                    errors4xx: 1
                    errors5xx: 0
                    costUsd: '0.001000'
                    p95LatencyMs: 5300
        '429':
          $ref: '#/components/responses/RateLimited'
        4XX:
          $ref: '#/components/responses/Error'
        5XX:
          $ref: '#/components/responses/ServerError'
      security:
        - apiKey: []
components:
  headers:
    RequestId:
      description: The request's id. Quote it when you write to support.
      schema:
        type: string
        example: req_6a1f0c2b9d4e8a7f3c5b2e10
    ChargedUsd:
      description: What this call cost, in US dollars as an exact six-decimal string.
      schema:
        type: string
        example: '0.000500'
    BalanceUsd:
      description: >-
        The organization's balance after this call, in US dollars as an exact
        six-decimal string.
      schema:
        type: string
        example: '9.999500'
    RateLimitLimit:
      description: >-
        The calls allowed in the window of the route's limit with the fewest
        calls left.
      schema:
        type: integer
        example: 20
    RateLimitRemaining:
      description: The calls left in that window.
      schema:
        type: integer
        example: 19
    RateLimitReset:
      description: Seconds until that window resets.
      schema:
        type: integer
        example: 42
    RetryAfter:
      description: Seconds to wait before calling again.
      schema:
        type: integer
        example: 42
  responses:
    RateLimited:
      description: >-
        Too many calls. Wait the seconds in Retry-After, then call again. The
        body is empty.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
    Error:
      description: The request was refused. The body names the reason in `error.code`.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    ServerError:
      description: >-
        Something failed on our side and nothing was charged. Retry with
        backoff; quote X-Request-Id if it persists. The body is empty.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/RequestId'
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - doc_url
          properties:
            code:
              type: string
              description: >-
                Stable and machine-readable: branch on it. It never changes
                meaning.
            message:
              type: string
              description: >-
                A human-readable explanation for logs. It may be reworded at any
                time.
            param:
              type: string
              description: The request field the error is about, when there is one.
            doc_url:
              type: string
              description: The code's entry in the errors reference.
            request_id:
              type: string
              description: >-
                The request's id, as in the X-Request-Id header. Quote it to
                support.
      example:
        error:
          code: insufficient_balance
          message: Your balance cannot cover this call. Add funds and try again.
          doc_url: https://outbound.dev/docs/errors#insufficient_balance
          request_id: req_6a1f0c2b9d4e8a7f3c5b2e10
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        An API key from the console, starting `ob_live_`, sent as
        `Authorization: Bearer <key>`.

````

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