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

# Get domains deliverability



## OpenAPI

````yaml /openapi.json get /domains/{id}/deliverability
openapi: 3.1.1
info:
  title: Anima API
  version: 0.1.0
  description: >-
    The Anima API provides programmatic access to unified infrastructure for AI
    agents: create and manage agents; send and receive email; place phone calls
    and send/receive SMS and voice; store and retrieve vault credentials; manage
    agent identity; and configure webhooks for real-time events. Authenticate
    using a Bearer token or an API key passed via the X-API-Key header.
  contact:
    name: Anima Labs
    url: https://useanima.sh
    email: support@useanima.sh
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
servers:
  - url: https://api.useanima.sh/v1
    description: Production
security:
  - BearerAuth: []
  - ApiKeyAuth: []
paths:
  /domains/{id}/deliverability:
    get:
      operationId: domain.deliverability
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            pattern: ^[cC][^\s-]{8,}$
            description: Unique domain identifier
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  domain:
                    type: string
                    description: Domain these statistics apply to
                  sent:
                    type: integer
                    minimum: 0
                    description: Total number of emails sent
                  delivered:
                    type: integer
                    minimum: 0
                    description: Number of emails successfully delivered
                  bounced:
                    type: integer
                    minimum: 0
                    description: Number of emails that bounced
                  complained:
                    type: integer
                    minimum: 0
                    description: Number of emails marked as spam by recipients
                  bounceRate:
                    type: number
                    minimum: 0
                    description: Bounce rate as a decimal (e.g. 0.02 for 2%)
                  complaintRate:
                    type: number
                    minimum: 0
                    description: Complaint rate as a decimal (e.g. 0.001 for 0.1%)
                  isHealthy:
                    type: boolean
                    description: >-
                      Whether deliverability metrics are within acceptable
                      thresholds
                  dmarc:
                    type: object
                    properties:
                      reportCount:
                        type: integer
                        minimum: 0
                        description: >-
                          Number of DMARC aggregate reports received in the
                          window
                      messages:
                        type: integer
                        minimum: 0
                        description: >-
                          Total messages covered by those reports, as counted by
                          the reporting providers
                      passed:
                        type: integer
                        minimum: 0
                        description: >-
                          Messages that passed DMARC — DKIM or SPF authenticated
                          AND aligned with the From domain
                      failed:
                        type: integer
                        minimum: 0
                        description: >-
                          Messages that failed DMARC — neither DKIM nor SPF
                          aligned. Spoofing, or a legitimate sender you have not
                          authorized
                      passRate:
                        type: number
                        minimum: 0
                        description: >-
                          Fraction of reported messages that passed DMARC (0-1).
                          0 when no messages were reported
                      quarantined:
                        type: integer
                        minimum: 0
                        description: >-
                          Messages the receiving provider quarantined under your
                          published policy
                      rejected:
                        type: integer
                        minimum: 0
                        description: >-
                          Messages the receiving provider rejected under your
                          published policy
                      reporters:
                        type: array
                        items:
                          type: string
                        description: >-
                          Providers that sent reports in the window (e.g.
                          google.com, outlook.com)
                      topSources:
                        type: array
                        items:
                          type: object
                          properties:
                            sourceIp:
                              type: string
                              description: >-
                                IP address that sent mail claiming to be from
                                this domain
                            messages:
                              type: integer
                              minimum: 0
                              description: Messages seen from this source in the window
                            passed:
                              type: integer
                              minimum: 0
                              description: >-
                                Messages from this source that passed DMARC
                                (DKIM or SPF aligned)
                            failed:
                              type: integer
                              minimum: 0
                              description: >-
                                Messages from this source that failed DMARC
                                (neither DKIM nor SPF aligned)
                          required:
                            - sourceIp
                            - messages
                            - passed
                            - failed
                          description: One sending source seen in DMARC aggregate reports
                        description: >-
                          Busiest sending sources in the window, most messages
                          first
                      topFailingSources:
                        type: array
                        items:
                          type: object
                          properties:
                            sourceIp:
                              type: string
                              description: >-
                                IP address that sent mail claiming to be from
                                this domain
                            messages:
                              type: integer
                              minimum: 0
                              description: Messages seen from this source in the window
                            passed:
                              type: integer
                              minimum: 0
                              description: >-
                                Messages from this source that passed DMARC
                                (DKIM or SPF aligned)
                            failed:
                              type: integer
                              minimum: 0
                              description: >-
                                Messages from this source that failed DMARC
                                (neither DKIM nor SPF aligned)
                          required:
                            - sourceIp
                            - messages
                            - passed
                            - failed
                          description: One sending source seen in DMARC aggregate reports
                        description: >-
                          Sources with the most DMARC failures, most failures
                          first — where to look for spoofing or an unauthorized
                          sender
                      lastReportAt:
                        anyOf:
                          - type: string
                            format: date-time
                          - type: 'null'
                        description: >-
                          End of the most recent reporting period, or null if no
                          reports have been received
                      windowDays:
                        type: integer
                        minimum: 0
                        description: >-
                          Length of the reporting window these figures cover, in
                          days
                    required:
                      - reportCount
                      - messages
                      - passed
                      - failed
                      - passRate
                      - quarantined
                      - rejected
                      - reporters
                      - topSources
                      - topFailingSources
                      - lastReportAt
                      - windowDays
                    description: >-
                      DMARC aggregate reports received for this domain,
                      summarizing how receiving mail providers authenticated
                      mail claiming to be from it
                required:
                  - domain
                  - sent
                  - delivered
                  - bounced
                  - complained
                  - bounceRate
                  - complaintRate
                  - isHealthy
                  - dmarc
                description: Email deliverability statistics for a domain
components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Bearer token obtained from authentication. Pass as: Authorization:
        Bearer <token>
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: 'API key for programmatic access. Pass as: X-API-Key: <your-key>'

````

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