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

# Top recipient domains by send volume



## OpenAPI

````yaml /api-reference/specs/email.yaml get /v1/deliverability/top-recipients
openapi: 3.0.3
info:
  title: Basaltic Email API
  version: 1.0.0
  description: >
    Customer-facing email sending API — regional. Covers sender-identity

    management + DNS-based verification (ownership + DKIM), the send API,

    suppression lists, templates, configuration sets, and IP pools.


    Each region is independent: an identity verified in `dev` is not verified

    in `sa-saopaulo-1` — the DKIM key + verification token are per-region, and
    the

    customer must re-verify in each region they want to send from.


    Verification flow:
      1. POST /v1/identities {name: example.com}
         → stamps a pending row, provisions a per-identity DKIM signing key,
           and returns the DNS records the customer must publish.
      2. Customer publishes the records at their DNS provider.
      3. POST /v1/identities/{id}/verify
         → server resolves the records, flips status=verified on a match.
           Only verified identities may send.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://email.{region}.basaltic.sh
    description: Regional API endpoint
    variables:
      region:
        default: sa-saopaulo-1
        description: Region code
security:
  - SignatureAuth: []
tags:
  - name: Email
    description: Customer-facing email sending (regional).
paths:
  /v1/deliverability/top-recipients:
    get:
      tags:
        - Email
      summary: Top recipient domains by send volume
      operationId: getDeliverabilityTopRecipients
      parameters:
        - name: identity_id
          in: query
          schema:
            type: string
            format: uuid
        - name: window_hours
          in: query
          schema:
            type: integer
            default: 24
        - name: limit
          in: query
          description: |
            How many domains to return. A top-N summary rather than a page, so
            it defaults lower than the list endpoints and takes no cursor.
          schema:
            type: integer
            default: 25
            minimum: 1
            maximum: 200
      responses:
        '200':
          description: Top recipient domains.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TopRecipientsResponse'
        '400':
          description: Invalid `identity_id` or non-positive `window`.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    TopRecipientsResponse:
      type: object
      required:
        - top_recipients
      properties:
        top_recipients:
          $ref: '#/components/schemas/TopRecipients'
    TopRecipients:
      type: object
      required:
        - window_hours
        - generated_at
        - domains
      properties:
        identity_id:
          type: string
          format: uuid
          nullable: true
        window_hours:
          type: integer
        generated_at:
          type: string
          format: date-time
        domains:
          type: array
          items:
            $ref: '#/components/schemas/TopRecipientDomain'
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Error code identifying the type of error
              example: INVALID_INPUT
            message:
              type: string
              description: Human-readable error message
              example: Invalid request parameters
            request_id:
              type: string
              format: uuid
              description: Request ID for debugging
              example: 550e8400-e29b-41d4-a716-446655440000
    TopRecipientDomain:
      type: object
      required:
        - domain
        - send_count
        - bounce_count
        - complaint_count
        - bounce_rate
        - complaint_rate
      properties:
        domain:
          type: string
        send_count:
          type: integer
          format: int64
        bounce_count:
          type: integer
          format: int64
        complaint_count:
          type: integer
          format: int64
        bounce_rate:
          type: number
        complaint_rate:
          type: number
  responses:
    Unauthorized:
      description: Authentication required or token invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ACCESS_DENIED
              message: You don't have permission to perform this action
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    SignatureAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >
        Request signing with an access key issued to a service account. An

        HMAC-SHA256 over a canonical form of the request, close to AWS SigV4.

        The `basaltic` CLI signs for you.


        Send `Authorization`, `X-Date` (UTC, `YYYYMMDDTHHMMSSZ`) and `X-Nonce`

        (random per request); add `X-Content-Sha256` to bind a body, and

        `X-Amz-Security-Token` when using temporary credentials.


        ```

        Authorization: BASALTIC-HMAC-SHA256
        Credential=<access_key_id>/<date>/<region>/basaltic/basaltic_request,
        SignedHeaders=host;x-date;x-nonce, Signature=<hex>

        ```


        `<region>` is the region code you are calling, or `global` for the
        global

        services. A signature is valid for 5 minutes from `X-Date`, and mutating

        requests are replay-guarded on the nonce.


        **Full signing procedure, including a working implementation:**

        https://docs.basaltic.sh/authentication


        ## Rate limits

        There is no global request budget. A limit applies only where an

        operation documents a `429`, and that operation says what it counts.

        Those responses carry `X-RateLimit-Limit`, `X-RateLimit-Remaining`,

        `X-RateLimit-Reset` and, on a `429`, `Retry-After` — read them rather

        than hard-coding a number. Retrying before `Retry-After` is refused and

        extends the window. Everything else is bounded by quota, not by request

        rate.

````