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

# Add a website to audit (any site, e.g. a docs or regional site) without making it a brand domain

> For a docs site, a regional site… Audit-only domains don't change citation attribution. Idempotent: a domain the brand already has (own or audit-only) returns that row with 200. Up to 10 audit-only domains per brand.



## OpenAPI

````yaml /api-reference/openapi.json post /api/v2/brands/{brand_id}/technical_audit/domains
openapi: 3.0.1
info:
  title: Cognizo Public API
  version: v1
  description: >-
    Public REST API for Cognizo. Authenticate with an API key via the
    `X-API-KEY` header.
servers:
  - url: https://core.cognizo.ai
security:
  - apiKey: []
paths:
  /api/v2/brands/{brand_id}/technical_audit/domains:
    parameters:
      - name: brand_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
    post:
      tags:
        - Technical audit
      summary: >-
        Add a website to audit (any site, e.g. a docs or regional site) without
        making it a brand domain
      description: >-
        For a docs site, a regional site… Audit-only domains don't change
        citation attribution. Idempotent: a domain the brand already has (own or
        audit-only) returns that row with 200. Up to 10 audit-only domains per
        brand.
      operationId: create_brand_technical_audit_domain
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                domain:
                  type: string
                  example: docs.acme.com
                  description: >-
                    A host or a URL; stored as the bare lowercase host (scheme,
                    path and port dropped, subdomains kept). IP addresses,
                    localhost, single-label hosts, private-network names
                    (.local, .internal, .localhost…) and hosts that resolve to a
                    private address are rejected.
              required:
                - domain
        required: true
      responses:
        '200':
          description: already one of the brand's domains; that row
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: >-
                          Domain id: pass as filter[domain_id] / domain_id, and
                          to DELETE /technical_audit/domains/{audit_domain_id}
                          when removable
                      domain:
                        type: string
                      source:
                        type: string
                        enum:
                          - brand
                          - audit
                        description: >-
                          brand = one of the brand's own domains (also used for
                          citation attribution); audit = added only to be
                          audited
                      removable:
                        type: boolean
                        description: True only for audit domains
                      status:
                        type: string
                        enum:
                          - not_started
                          - pending
                          - completed
                          - failed
                      outcome:
                        type: string
                        enum:
                          - completed
                          - partially_blocked
                          - blocked
                          - failed
                          - null
                        nullable: true
                      ran_at:
                        type: string
                        format: date-time
                        nullable: true
                      checks_total:
                        type: integer
                      checks_passing:
                        type: integer
                      missing_count:
                        type: integer
                      to_fix_count:
                        type: integer
                        description: >-
                          Checks that need work (not done + partly done),
                          counting the AI crawlers as one check like the table
                          does
                      running:
                        type: boolean
                        description: >-
                          A run is in progress on this domain (the counts are
                          still the last finished run's)
                    required:
                      - id
                      - domain
                      - source
                      - removable
                      - status
                      - outcome
                      - ran_at
                      - checks_total
                      - checks_passing
                      - missing_count
                      - running
                      - to_fix_count
                required:
                  - data
        '201':
          description: added; the new domain row
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                        format: uuid
                        description: >-
                          Domain id: pass as filter[domain_id] / domain_id, and
                          to DELETE /technical_audit/domains/{audit_domain_id}
                          when removable
                      domain:
                        type: string
                      source:
                        type: string
                        enum:
                          - brand
                          - audit
                        description: >-
                          brand = one of the brand's own domains (also used for
                          citation attribution); audit = added only to be
                          audited
                      removable:
                        type: boolean
                        description: True only for audit domains
                      status:
                        type: string
                        enum:
                          - not_started
                          - pending
                          - completed
                          - failed
                      outcome:
                        type: string
                        enum:
                          - completed
                          - partially_blocked
                          - blocked
                          - failed
                          - null
                        nullable: true
                      ran_at:
                        type: string
                        format: date-time
                        nullable: true
                      checks_total:
                        type: integer
                      checks_passing:
                        type: integer
                      missing_count:
                        type: integer
                      to_fix_count:
                        type: integer
                        description: >-
                          Checks that need work (not done + partly done),
                          counting the AI crawlers as one check like the table
                          does
                      running:
                        type: boolean
                        description: >-
                          A run is in progress on this domain (the counts are
                          still the last finished run's)
                    required:
                      - id
                      - domain
                      - source
                      - removable
                      - status
                      - outcome
                      - ran_at
                      - checks_total
                      - checks_passing
                      - missing_count
                      - running
                      - to_fix_count
                required:
                  - data
        '403':
          description: >-
            optimization feature disabled; or ORGANIZATION_ACCESS_REVOKED when
            the access token's organization is no longer one of the user's
            memberships
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: >-
            brand not found (NOT_FOUND): no such brand, or it belongs to another
            organization (the two are indistinguishable by design).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '410':
          description: paused brand
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '422':
          description: >-
            not a valid public host (or it resolves to a private address), or
            the brand already has the maximum of audit-only domains
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
components:
  schemas:
    error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: Stable machine-readable reason; see `error_code`.
            message:
              type: string
            details:
              type: array
              items:
                $ref: '#/components/schemas/error_detail'
          required:
            - code
            - message
      required:
        - error
    error_detail:
      type: object
      properties:
        field:
          type: string
          nullable: true
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
        - field
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-KEY

````

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