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

# Totals of the answers read in a period and the one before it

> `answers` counts the answers that were read; `named` those that name your brand; `searched` those with at least one page in the source list; `citations` the inline citations across them (divide by `answers` for the average).

`current` covers `period`, `previous` the same number of days right before it (`previousPeriod`). `brandId` and `domain` narrow both to the answers that name that brand or read, cite or link that domain, as the answers list does.



## OpenAPI

````yaml https://api.seomator.com/openapi.json post /v1/projects/{id}/reports/answers
openapi: 3.1.0
info:
  title: SEOmator API
  version: 0.1.0
servers:
  - url: https://api.seomator.com
security: []
paths:
  /v1/projects/{id}/reports/answers:
    post:
      tags:
        - ai visibility
      summary: Totals of the answers read in a period and the one before it
      description: >-
        `answers` counts the answers that were read; `named` those that name
        your brand; `searched` those with at least one page in the source list;
        `citations` the inline citations across them (divide by `answers` for
        the average).


        `current` covers `period`, `previous` the same number of days right
        before it (`previousPeriod`). `brandId` and `domain` narrow both to the
        answers that name that brand or read, cite or link that domain, as the
        answers list does.
      parameters:
        - schema:
            type: string
            description: Project id (proj_…) or slug (the domain with dots as dashes).
          required: true
          description: Project id (proj_…) or slug (the domain with dots as dashes).
          name: id
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                startDate:
                  type: string
                  format: date
                endDate:
                  type: string
                  format: date
                filters:
                  type: object
                  properties:
                    assistants:
                      type: array
                      items:
                        type: string
                        enum:
                          - chatgpt
                          - ai_mode
                          - gemini
                    topicIds:
                      type: array
                      items:
                        type: string
                        maxLength: 64
                      maxItems: 50
                    promptIds:
                      type: array
                      items:
                        type: string
                        maxLength: 64
                      maxItems: 200
                    intents:
                      type: array
                      items:
                        type: string
                        enum:
                          - informational
                          - commercial
                          - transactional
                    branded:
                      type: string
                      enum:
                        - non_branded
                        - branded
                        - all
                      default: non_branded
                  default:
                    branded: non_branded
                brandId:
                  type: string
                  maxLength: 64
                  description: Only answers that name this brand (brd_…)
                domain:
                  type: string
                  maxLength: 2048
                  description: >-
                    Only answers that read, cite or link a page of this domain
                    (example.com)
                url:
                  type: string
                  maxLength: 2048
                  description: >-
                    Only answers that read, cite or link this page (its full
                    URL)
      responses:
        '200':
          description: Report
          content:
            application/json:
              schema:
                type: object
                properties:
                  period:
                    type: object
                    properties:
                      start:
                        type: string
                      end:
                        type: string
                    required:
                      - start
                      - end
                    additionalProperties: {}
                  previousPeriod:
                    type: object
                    properties:
                      start:
                        type: string
                      end:
                        type: string
                    required:
                      - start
                      - end
                    additionalProperties: {}
                  current:
                    type: object
                    properties:
                      answers:
                        type: number
                        description: Answers read in the period
                      named:
                        type: number
                        description: Answers that name your brand (verified mentions only)
                      searched:
                        type: number
                        description: Answers with at least one page in the source list
                      citations:
                        type: number
                        description: Inline citations across these answers
                    required:
                      - answers
                      - named
                      - searched
                      - citations
                    additionalProperties: {}
                  previous:
                    type: object
                    properties:
                      answers:
                        type: number
                        description: Answers read in the period
                      named:
                        type: number
                        description: Answers that name your brand (verified mentions only)
                      searched:
                        type: number
                        description: Answers with at least one page in the source list
                      citations:
                        type: number
                        description: Inline citations across these answers
                    required:
                      - answers
                      - named
                      - searched
                      - citations
                    additionalProperties: {}
                required:
                  - period
                  - previousPeriod
                  - current
                  - previous
                additionalProperties: {}
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - bad_request
                - unauthorized
                - insufficient_credits
                - plan_limit
                - forbidden
                - not_found
                - conflict
                - rate_limit_exceeded
                - internal_server_error
                - service_unavailable
            message:
              type: string
            requestId:
              type: string
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key

````

## Related topics

- [Metrics: visibility, share of voice and citations](https://docs.seomator.com/reports/metrics.md)
- [Fan-out: what ChatGPT searches before answering](https://docs.seomator.com/reports/fanout.md)
- [Answers: read what each AI assistant said](https://docs.seomator.com/reports/answers.md)


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