DMARC Examiner Reports API

openapi: 3.2.0
info:
  title: Dmarc Examiner Com Reports API
  version: 1.0.0
  contact:
    email: support@dmarc-examiner.com
    url: https://dmarc-examiner.com
  license:
    name: Proprietary
  description: 'Operations tagged Reports across 2 of this provider''s published API definitions: dmarc-examiner-com-openapi.yaml, openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.dmarc-examiner.com
  description: Production
security:
- ApiKeyAuth: []
tags:
- name: Reports
  description: Access DMARC aggregate reports and statistics
paths:
  /api/v1/reports:
    get:
      operationId: listReports
      summary: List reports
      description: Returns DMARC aggregate reports with optional filtering and pagination.
      tags:
      - Reports
      parameters:
      - name: domain_id
        in: query
        description: Filter reports by domain UUID.
        required: false
        schema:
          type: string
          format: uuid
      - name: date_from
        in: query
        description: Filter reports with `date_range_begin` >= this value. Unix timestamp.
        required: false
        schema:
          type: integer
          example: 1711152000
      - name: date_to
        in: query
        description: Filter reports with `date_range_end` <= this value. Unix timestamp.
        required: false
        schema:
          type: integer
          example: 1711238400
      - name: page
        in: query
        description: Page number (minimum 1).
        required: false
        schema:
          type: integer
          default: 1
          minimum: 1
      - name: limit
        in: query
        description: Results per page (1–100).
        required: false
        schema:
          type: integer
          default: 20
          minimum: 1
          maximum: 100
      responses:
        '200':
          description: Paginated list of reports
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                - pagination
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Report'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/FeatureNotAvailable'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://api.dmarc-examiner.com
      description: Production
  /api/v1/reports/{id}:
    get:
      operationId: getReport
      summary: Get report details
      description: Returns a single report with all individual records and geolocation data.
      tags:
      - Reports
      parameters:
      - name: id
        in: path
        required: true
        description: Report UUID.
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Report with records
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Report'
                - type: object
                  required:
                  - records
                  properties:
                    records:
                      type: array
                      items:
                        $ref: '#/components/schemas/ReportRecord'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/FeatureNotAvailable'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://api.dmarc-examiner.com
      description: Production
  /api/v1/reports/{id}/statistics:
    get:
      operationId: getReportStatistics
      summary: Get report statistics
      description: Returns aggregated statistics for a report, grouped by country, ASN, and authentication result.
      tags:
      - Reports
      parameters:
      - name: id
        in: path
        required: true
        description: Report UUID.
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Report statistics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReportStatistics'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/FeatureNotAvailable'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://api.dmarc-examiner.com
      description: Production
  /api/v1/reports/{id}/export/csv:
    get:
      operationId: exportReportCsv
      summary: Export report as CSV
      description: 'Downloads the report records as a CSV file. Columns: Source IP, Count, Disposition, DKIM Result, SPF Result, Header From, Envelope From, DKIM Domain, SPF Domain, Country, ASN Org.'
      tags:
      - Reports
      parameters:
      - name: id
        in: path
        required: true
        description: Report UUID.
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: CSV file download
          headers:
            Content-Disposition:
              description: 'Attachment filename in the format

                `dmarc-report-{policy_domain}-{external_report_id}.csv`. Note the

                `external_report_id` is the report identifier assigned by the

                reporter (Google, Yahoo, etc.) — NOT the path parameter `{id}`,

                which is the internal UUID. Example:

                `dmarc-report-example.com-10911794730707458577.csv`.

                '
              schema:
                type: string
          content:
            text/csv:
              schema:
                type: string
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/FeatureNotAvailable'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
    servers:
    - url: https://api.dmarc-examiner.com
      description: Production
components:
  responses:
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            type: object
            required:
            - message
            properties:
              message:
                type: string
                example: Report not found
    Unauthorized:
      description: 'Authentication failed. Two shapes are possible depending on cause:

        - **Invalid or revoked key** — body is `{"message": "..."}` only.

        - **Missing `X-API-Key` header** — body adds an `error: "unauthorized"` machine-readable code.

        Clients should treat both as the same outcome and read `message` for display.

        '
      content:
        application/json:
          schema:
            type: object
            required:
            - message
            properties:
              error:
                type: string
                description: Present only when the request had no `X-API-Key` header at all.
                enum:
                - unauthorized
              message:
                type: string
                example: Invalid API key
    RateLimited:
      description: Rate limit exceeded.
      content:
        application/json:
          schema:
            type: object
            required:
            - message
            properties:
              message:
                type: string
                example: Rate limit exceeded. Maximum 100 requests per minute.
    FeatureNotAvailable:
      description: 'The organization''s current plan does not include the feature required by this endpoint

        (e.g. `apiAccess`, `forensicReports`, `advancedAlerts`). Distinct from `PlanLimitExceeded`

        (HTTP 402), which signals a *quota* exhausted on a feature the plan does include.


        If a customer downgrades to Free, all `/api/v1/*` requests will start returning this response.

        '
      content:
        application/json:
          schema:
            type: object
            required:
            - error
            - message
            - feature
            - current_plan
            properties:
              error:
                type: string
                enum:
                - feature_not_available
              message:
                type: string
                example: 'Feature "apiAccess" is not available in your current plan: Free. Please upgrade.'
              feature:
                type: string
                example: apiAccess
              current_plan:
                type: string
                example: free
    BadRequest:
      description: "Request payload, body field, or query parameter is missing, malformed,\noutside documented bounds, or fails type/enum validation.\n\nTwo body shapes can occur:\n- **Body validation errors** (e.g. missing `name`, wrong type) come from\n  the controller and have the form `{\"message\": \"...\"}`.\n- **Query parameter errors** (e.g. `limit` out of range, `auth_failure`\n  off-enum, `domain_id` not a UUID) flow through the API exception\n  subscriber and add an `error: \"bad_request\"` machine-readable code:\n  `{\"error\": \"bad_request\", \"message\": \"Query parameter \\\"limit\\\" must be between 1 and 100, got 999\"}`.\n"
      content:
        application/json:
          schema:
            type: object
            required:
            - message
            properties:
              error:
                type: string
                description: Present on query-parameter validation errors. Absent on body validation errors.
                enum:
                - bad_request
              message:
                type: string
                example: Domain name is required
    ServerError:
      description: Internal server error.
      content:
        application/json:
          schema:
            type: object
            required:
            - message
            properties:
              message:
                type: string
  schemas:
    Report:
      type: object
      required:
      - id
      - domain_id
      - external_report_id
      - reporter_org_name
      - reporter_email
      - date_range_begin
      - date_range_end
      - policy_domain
      - policy_p
      - policy_pct
      - total_records
      - pass_rate
      - received_at
      - created_at
      properties:
        id:
          type: string
          format: uuid
        domain_id:
          type: string
          format: uuid
        domain_name:
          type:
          - string
          - 'null'
          example: example.com
        domain:
          type: object
          required:
          - id
          - name
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
              example: example.com
        external_report_id:
          type: string
          description: Report ID assigned by the reporting organization.
        reporter_org_name:
          type: string
          description: Name of the organization that generated the report.
          example: google.com
        reporter_email:
          type: string
          format: email
          description: Contact email of the reporting organization.
        date_range_begin:
          type: string
          format: date-time
          description: Start of the reporting period (ISO 8601).
        date_range_end:
          type: string
          format: date-time
          description: End of the reporting period (ISO 8601).
        policy_domain:
          type: string
          example: example.com
        policy_p:
          type: string
          enum:
          - none
          - quarantine
          - reject
          description: DMARC policy for the domain.
        policy_sp:
          type:
          - string
          - 'null'
          enum:
          - none
          - quarantine
          - reject
          - null
          description: DMARC policy for subdomains. Falls back to `policy_p` when null.
        policy_adkim:
          type: string
          enum:
          - r
          - s
          description: DKIM alignment mode (r=relaxed, s=strict).
        policy_aspf:
          type: string
          enum:
          - r
          - s
          description: SPF alignment mode (r=relaxed, s=strict).
        policy_pct:
          type: integer
          minimum: 0
          maximum: 100
          description: Percentage of messages to which the policy applies.
        total_records:
          type: integer
          description: Total number of email messages in the report.
        pass_rate:
          type: number
          format: float
          description: Percentage of messages passing both DKIM and SPF (0-100, 1 decimal).
          example: 98.5
        received_at:
          type: string
          format: date-time
        processed_at:
          type:
          - string
          - 'null'
          format: date-time
        created_at:
          type: string
          format: date-time
    ReportStatistics:
      type: object
      required:
      - by_country
      - by_asn
      - by_result
      properties:
        by_country:
          type: array
          description: Records aggregated by country, sorted descending by count.
          items:
            type: object
            required:
            - country_code
            - country
            - count
            - pass
            - fail
            - percentage
            properties:
              country_code:
                type: string
                description: ISO 3166-1 alpha-2. Returns "XX" for unknown.
                example: US
              country:
                type: string
                example: United States
              count:
                type: integer
              pass:
                type: integer
              fail:
                type: integer
              percentage:
                type: number
                format: float
                description: Share of total records this country represents (0–100, 1 decimal).
        by_asn:
          type: array
          description: Records aggregated by ASN, sorted descending by count.
          items:
            type: object
            required:
            - asn
            - org
            - count
            - pass
            - fail
            - percentage
            properties:
              asn:
                type: integer
                example: 15169
              org:
                type: string
                example: Google LLC
              count:
                type: integer
              pass:
                type: integer
              fail:
                type: integer
              percentage:
                type: number
                format: float
        by_result:
          type: object
          required:
          - pass
          - fail
          - total
          - pass_rate
          properties:
            pass:
              type: integer
            fail:
              type: integer
            total:
              type: integer
            pass_rate:
              type: number
              format: float
              description: Percentage of records passing both DKIM and SPF (0–100, 1 decimal).
    ReportRecord:
      type: object
      required:
      - id
      - source_ip
      - count
      - disposition
      - dkim_result
      - spf_result
      - header_from
      - is_passing
      - created_at
      properties:
        id:
          type: string
          format: uuid
        source_ip:
          type: string
          description: IP address of the sending mail server. May be IPv4 or IPv6.
          example: 209.85.220.41
        count:
          type: integer
          description: Number of messages from this source with these results.
        disposition:
          type: string
          enum:
          - none
          - quarantine
          - reject
          description: Action applied to the message.
        dkim_result:
          type: string
          enum:
          - none
          - pass
          - fail
          - policy
          - neutral
          - temperror
          - permerror
          description: DKIM authentication result, as defined in RFC 7601 §2.7.1.
        spf_result:
          type: string
          enum:
          - none
          - neutral
          - pass
          - fail
          - softfail
          - temperror
          - permerror
          description: SPF authentication result, as defined in RFC 7601 §2.7.2.
        header_from:
          type: string
          description: The From header domain.
        envelope_from:
          type:
          - string
          - 'null'
          description: The MAIL FROM domain.
        dkim_domain:
          type:
          - string
          - 'null'
          description: Domain used for DKIM signing.
        spf_domain:
          type:
          - string
          - 'null'
          description: Domain used for SPF check.
        is_passing:
          type: boolean
          description: True if both DKIM and SPF pass.
        geo:
          $ref: '#/components/schemas/GeoLocation'
        created_at:
          type: string
          format: date-time
    Pagination:
      type: object
      required:
      - total
      - page
      - limit
      - total_pages
      properties:
        total:
          type: integer
          description: Total number of results.
        page:
          type: integer
          description: Current page number.
        limit:
          type: integer
          description: Results per page.
        total_pages:
          type: integer
          description: Total number of pages.
    GeoLocation:
      type:
      - object
      - 'null'
      description: Geolocation data for the source IP. Null if lookup failed.
      properties:
        country:
          type: string
          example: United States
        country_code:
          type: string
          example: US
          description: ISO 3166-1 alpha-2 code. Returns "XX" for private IPs.
        org:
          type: string
          example: Google LLC
          description: ISP or organization name.
        asn:
          type:
          - integer
          - 'null'
          example: 15169
        cidr:
          type:
          - string
          - 'null'
          example: 192.0.2.0/24
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key in format `dex_` followed by 32 hex characters. Create keys in Settings > API Keys.
x-refined-from:
- dmarc-examiner-com-openapi.yaml
- openapi.yaml