> ## 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.

# Pages a technical audit check flagged, most important first, with each page's fix



## OpenAPI

````yaml /api-reference/openapi.json get /api/v2/brands/{brand_id}/technical_audit/checks/{check_key}/pages
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/checks/{check_key}/pages:
    parameters:
      - name: brand_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: check_key
        in: path
        example: site.titles.unique
        required: true
        schema:
          type: string
    get:
      tags:
        - Technical audit
      summary: >-
        Pages a technical audit check flagged, most important first, with each
        page's fix
      operationId: list_brand_technical_audit_check_pages
      parameters:
        - name: filter[domain_id]
          in: query
          required: false
          schema:
            type: string
            format: uuid
        - name: filter[dismissed]
          in: query
          required: false
          description: >-
            true = only dismissed pages, false = only not dismissed; default
            all, not dismissed first:
             * `true` 
             * `false` 
             
          schema:
            enum:
              - 'true'
              - 'false'
            type: string
        - name: page
          in: query
          required: false
          schema:
            type: integer
        - name: page_size
          in: query
          required: false
          description: Default 25, max 100
          schema:
            type: integer
      responses:
        '200':
          description: paginated affected pages
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/technical_audit_check_page'
                  meta:
                    $ref: '#/components/schemas/pagination_meta'
                required:
                  - data
                  - meta
        '400':
          description: filter[dismissed] isn't true or false
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '403':
          description: >-
            organization access revoked (ORGANIZATION_ACCESS_REVOKED): the
            access token's organization is no longer one of the user's
            memberships (they left, were removed, or the organization was
            deleted). The session itself is still valid: drop the organization's
            client state and refresh the session, which moves it to another
            organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
        '404':
          description: unknown check
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
components:
  schemas:
    technical_audit_check_page:
      description: >-
        One page a check lists. `detail` is typed per check family, chosen by
        `check_key`.
      oneOf:
        - $ref: '#/components/schemas/technical_audit_check_page_for_schema_suggested'
        - $ref: '#/components/schemas/technical_audit_check_page_for_schema_valid'
        - $ref: >-
            #/components/schemas/technical_audit_check_page_for_schema_type_mismatch
        - $ref: >-
            #/components/schemas/technical_audit_check_page_for_schema_recommended
        - $ref: '#/components/schemas/technical_audit_check_page_for_link_target'
        - $ref: '#/components/schemas/technical_audit_check_page_for_redirect_chain'
        - $ref: '#/components/schemas/technical_audit_check_page_for_bot_protection'
        - $ref: '#/components/schemas/technical_audit_check_page_for_snippets'
        - $ref: '#/components/schemas/technical_audit_check_page_for_noindex'
        - $ref: '#/components/schemas/technical_audit_check_page_for_canonical'
        - $ref: '#/components/schemas/technical_audit_check_page_for_sitemap_mismatch'
        - $ref: '#/components/schemas/technical_audit_check_page_for_single_h1'
        - $ref: '#/components/schemas/technical_audit_check_page_for_h1_descriptive'
        - $ref: '#/components/schemas/technical_audit_check_page_for_hierarchy'
        - $ref: '#/components/schemas/technical_audit_check_page_for_title_unique'
        - $ref: '#/components/schemas/technical_audit_check_page_for_title_length'
        - $ref: '#/components/schemas/technical_audit_check_page_for_title_relevant'
        - $ref: >-
            #/components/schemas/technical_audit_check_page_for_description_relevant
        - $ref: '#/components/schemas/technical_audit_check_page_for_images_alt'
        - $ref: >-
            #/components/schemas/technical_audit_check_page_for_images_alt_descriptive
        - $ref: >-
            #/components/schemas/technical_audit_check_page_for_content_substantive
        - $ref: '#/components/schemas/technical_audit_check_page_for_content_outdated'
        - $ref: '#/components/schemas/technical_audit_check_page_for_finding_only'
      discriminator:
        propertyName: check_key
        mapping:
          site.schema.article: '#/components/schemas/technical_audit_check_page_for_schema_suggested'
          site.schema.faq: '#/components/schemas/technical_audit_check_page_for_schema_suggested'
          site.schema.organization_homepage: '#/components/schemas/technical_audit_check_page_for_schema_suggested'
          site.schema.website_homepage: '#/components/schemas/technical_audit_check_page_for_schema_suggested'
          site.schema.same_as: '#/components/schemas/technical_audit_check_page_for_schema_suggested'
          site.schema.valid: '#/components/schemas/technical_audit_check_page_for_schema_valid'
          site.schema.type_mismatch: >-
            #/components/schemas/technical_audit_check_page_for_schema_type_mismatch
          site.schema.recommended: >-
            #/components/schemas/technical_audit_check_page_for_schema_recommended
          site.pages.errors: '#/components/schemas/technical_audit_check_page_for_link_target'
          site.links.broken_internal: '#/components/schemas/technical_audit_check_page_for_link_target'
          site.redirects.chains: '#/components/schemas/technical_audit_check_page_for_redirect_chain'
          site.access.bot_protection: '#/components/schemas/technical_audit_check_page_for_bot_protection'
          site.snippets.blocked: '#/components/schemas/technical_audit_check_page_for_snippets'
          site.indexing.noindex: '#/components/schemas/technical_audit_check_page_for_noindex'
          site.canonical.issues: '#/components/schemas/technical_audit_check_page_for_canonical'
          site.sitemap.mismatch: '#/components/schemas/technical_audit_check_page_for_sitemap_mismatch'
          site.headings.single_h1: '#/components/schemas/technical_audit_check_page_for_single_h1'
          site.headings.h1_descriptive: '#/components/schemas/technical_audit_check_page_for_h1_descriptive'
          site.headings.hierarchy: '#/components/schemas/technical_audit_check_page_for_hierarchy'
          site.titles.unique: '#/components/schemas/technical_audit_check_page_for_title_unique'
          site.titles.length: '#/components/schemas/technical_audit_check_page_for_title_length'
          site.titles.relevant: '#/components/schemas/technical_audit_check_page_for_title_relevant'
          site.meta_description.relevant: >-
            #/components/schemas/technical_audit_check_page_for_description_relevant
          site.images.alt: '#/components/schemas/technical_audit_check_page_for_images_alt'
          site.images.alt_descriptive: >-
            #/components/schemas/technical_audit_check_page_for_images_alt_descriptive
          site.content.substantive: >-
            #/components/schemas/technical_audit_check_page_for_content_substantive
          site.content.outdated: '#/components/schemas/technical_audit_check_page_for_content_outdated'
          access.ai_bot.oai_searchbot: '#/components/schemas/technical_audit_check_page_for_finding_only'
          access.ai_bot.chatgpt_user: '#/components/schemas/technical_audit_check_page_for_finding_only'
          access.ai_bot.gptbot: '#/components/schemas/technical_audit_check_page_for_finding_only'
          access.ai_bot.claude_searchbot: '#/components/schemas/technical_audit_check_page_for_finding_only'
          access.ai_bot.claude_user: '#/components/schemas/technical_audit_check_page_for_finding_only'
          access.ai_bot.claudebot: '#/components/schemas/technical_audit_check_page_for_finding_only'
          access.ai_bot.perplexitybot: '#/components/schemas/technical_audit_check_page_for_finding_only'
          access.ai_bot.perplexity_user: '#/components/schemas/technical_audit_check_page_for_finding_only'
          access.ai_bot.googlebot: '#/components/schemas/technical_audit_check_page_for_finding_only'
          access.ai_bot.google_extended: '#/components/schemas/technical_audit_check_page_for_finding_only'
          access.ai_bot.bingbot: '#/components/schemas/technical_audit_check_page_for_finding_only'
          access.ai_bot.applebot: '#/components/schemas/technical_audit_check_page_for_finding_only'
          access.ai_bot.applebot_extended: '#/components/schemas/technical_audit_check_page_for_finding_only'
          access.ai_bot.meta_externalagent: '#/components/schemas/technical_audit_check_page_for_finding_only'
          access.ai_bot.ccbot: '#/components/schemas/technical_audit_check_page_for_finding_only'
          access.ai_bot.amazonbot: '#/components/schemas/technical_audit_check_page_for_finding_only'
          access.ai_bot.duckassistbot: '#/components/schemas/technical_audit_check_page_for_finding_only'
          access.robots.reachable: '#/components/schemas/technical_audit_check_page_for_finding_only'
          access.server: '#/components/schemas/technical_audit_check_page_for_finding_only'
          access.homepage.https: '#/components/schemas/technical_audit_check_page_for_finding_only'
          access.homepage.http_redirect: '#/components/schemas/technical_audit_check_page_for_finding_only'
          access.homepage.reachable: '#/components/schemas/technical_audit_check_page_for_finding_only'
          access.homepage.indexable: '#/components/schemas/technical_audit_check_page_for_finding_only'
          access.sitemap.declared: '#/components/schemas/technical_audit_check_page_for_finding_only'
          access.sitemap.valid: '#/components/schemas/technical_audit_check_page_for_finding_only'
          site.social.open_graph: '#/components/schemas/technical_audit_check_page_for_finding_only'
          site.meta_description.present: '#/components/schemas/technical_audit_check_page_for_finding_only'
          site.articles.dates: '#/components/schemas/technical_audit_check_page_for_finding_only'
          site.articles.author: '#/components/schemas/technical_audit_check_page_for_finding_only'
    pagination_meta:
      type: object
      properties:
        page:
          type: integer
        page_size:
          type: integer
        total_items:
          type: integer
        total_pages:
          type: integer
        counts:
          type: object
          additionalProperties:
            type: integer
        filter:
          type: object
          properties:
            topics:
              type: array
              items:
                $ref: '#/components/schemas/topic_facet'
      required:
        - page
        - page_size
        - total_items
        - total_pages
    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
    technical_audit_check_page_for_schema_suggested:
      allOf:
        - $ref: '#/components/schemas/technical_audit_check_page_base'
        - type: object
          properties:
            check_key:
              type: string
              enum:
                - site.schema.article
                - site.schema.faq
                - site.schema.organization_homepage
                - site.schema.website_homepage
                - site.schema.same_as
            detail:
              $ref: '#/components/schemas/technical_audit_detail_schema_suggested'
          required:
            - check_key
            - detail
    technical_audit_check_page_for_schema_valid:
      allOf:
        - $ref: '#/components/schemas/technical_audit_check_page_base'
        - type: object
          properties:
            check_key:
              type: string
              enum:
                - site.schema.valid
            detail:
              $ref: '#/components/schemas/technical_audit_detail_schema_valid'
          required:
            - check_key
            - detail
    technical_audit_check_page_for_schema_type_mismatch:
      allOf:
        - $ref: '#/components/schemas/technical_audit_check_page_base'
        - type: object
          properties:
            check_key:
              type: string
              enum:
                - site.schema.type_mismatch
            detail:
              $ref: '#/components/schemas/technical_audit_detail_schema_type_mismatch'
          required:
            - check_key
            - detail
    technical_audit_check_page_for_schema_recommended:
      allOf:
        - $ref: '#/components/schemas/technical_audit_check_page_base'
        - type: object
          properties:
            check_key:
              type: string
              enum:
                - site.schema.recommended
            detail:
              $ref: '#/components/schemas/technical_audit_detail_schema_recommended'
          required:
            - check_key
            - detail
    technical_audit_check_page_for_link_target:
      allOf:
        - $ref: '#/components/schemas/technical_audit_check_page_base'
        - type: object
          properties:
            check_key:
              type: string
              enum:
                - site.pages.errors
                - site.links.broken_internal
            detail:
              $ref: '#/components/schemas/technical_audit_detail_link_target'
          required:
            - check_key
            - detail
    technical_audit_check_page_for_redirect_chain:
      allOf:
        - $ref: '#/components/schemas/technical_audit_check_page_base'
        - type: object
          properties:
            check_key:
              type: string
              enum:
                - site.redirects.chains
            detail:
              $ref: '#/components/schemas/technical_audit_detail_redirect_chain'
          required:
            - check_key
            - detail
    technical_audit_check_page_for_bot_protection:
      allOf:
        - $ref: '#/components/schemas/technical_audit_check_page_base'
        - type: object
          properties:
            check_key:
              type: string
              enum:
                - site.access.bot_protection
            detail:
              $ref: '#/components/schemas/technical_audit_detail_bot_protection'
          required:
            - check_key
            - detail
    technical_audit_check_page_for_snippets:
      allOf:
        - $ref: '#/components/schemas/technical_audit_check_page_base'
        - type: object
          properties:
            check_key:
              type: string
              enum:
                - site.snippets.blocked
            detail:
              $ref: '#/components/schemas/technical_audit_detail_snippets'
          required:
            - check_key
            - detail
    technical_audit_check_page_for_noindex:
      allOf:
        - $ref: '#/components/schemas/technical_audit_check_page_base'
        - type: object
          properties:
            check_key:
              type: string
              enum:
                - site.indexing.noindex
            detail:
              $ref: '#/components/schemas/technical_audit_detail_noindex'
          required:
            - check_key
            - detail
    technical_audit_check_page_for_canonical:
      allOf:
        - $ref: '#/components/schemas/technical_audit_check_page_base'
        - type: object
          properties:
            check_key:
              type: string
              enum:
                - site.canonical.issues
            detail:
              $ref: '#/components/schemas/technical_audit_detail_canonical'
          required:
            - check_key
            - detail
    technical_audit_check_page_for_sitemap_mismatch:
      allOf:
        - $ref: '#/components/schemas/technical_audit_check_page_base'
        - type: object
          properties:
            check_key:
              type: string
              enum:
                - site.sitemap.mismatch
            detail:
              $ref: '#/components/schemas/technical_audit_detail_sitemap_mismatch'
          required:
            - check_key
            - detail
    technical_audit_check_page_for_single_h1:
      allOf:
        - $ref: '#/components/schemas/technical_audit_check_page_base'
        - type: object
          properties:
            check_key:
              type: string
              enum:
                - site.headings.single_h1
            detail:
              $ref: '#/components/schemas/technical_audit_detail_single_h1'
          required:
            - check_key
            - detail
    technical_audit_check_page_for_h1_descriptive:
      allOf:
        - $ref: '#/components/schemas/technical_audit_check_page_base'
        - type: object
          properties:
            check_key:
              type: string
              enum:
                - site.headings.h1_descriptive
            detail:
              $ref: '#/components/schemas/technical_audit_detail_h1_descriptive'
          required:
            - check_key
            - detail
    technical_audit_check_page_for_hierarchy:
      allOf:
        - $ref: '#/components/schemas/technical_audit_check_page_base'
        - type: object
          properties:
            check_key:
              type: string
              enum:
                - site.headings.hierarchy
            detail:
              $ref: '#/components/schemas/technical_audit_detail_hierarchy'
          required:
            - check_key
            - detail
    technical_audit_check_page_for_title_unique:
      allOf:
        - $ref: '#/components/schemas/technical_audit_check_page_base'
        - type: object
          properties:
            check_key:
              type: string
              enum:
                - site.titles.unique
            detail:
              $ref: '#/components/schemas/technical_audit_detail_title_unique'
          required:
            - check_key
            - detail
    technical_audit_check_page_for_title_length:
      allOf:
        - $ref: '#/components/schemas/technical_audit_check_page_base'
        - type: object
          properties:
            check_key:
              type: string
              enum:
                - site.titles.length
            detail:
              $ref: '#/components/schemas/technical_audit_detail_title_length'
          required:
            - check_key
            - detail
    technical_audit_check_page_for_title_relevant:
      allOf:
        - $ref: '#/components/schemas/technical_audit_check_page_base'
        - type: object
          properties:
            check_key:
              type: string
              enum:
                - site.titles.relevant
            detail:
              $ref: '#/components/schemas/technical_audit_detail_title_relevant'
          required:
            - check_key
            - detail
    technical_audit_check_page_for_description_relevant:
      allOf:
        - $ref: '#/components/schemas/technical_audit_check_page_base'
        - type: object
          properties:
            check_key:
              type: string
              enum:
                - site.meta_description.relevant
            detail:
              $ref: '#/components/schemas/technical_audit_detail_description_relevant'
          required:
            - check_key
            - detail
    technical_audit_check_page_for_images_alt:
      allOf:
        - $ref: '#/components/schemas/technical_audit_check_page_base'
        - type: object
          properties:
            check_key:
              type: string
              enum:
                - site.images.alt
            detail:
              $ref: '#/components/schemas/technical_audit_detail_images_alt'
          required:
            - check_key
            - detail
    technical_audit_check_page_for_images_alt_descriptive:
      allOf:
        - $ref: '#/components/schemas/technical_audit_check_page_base'
        - type: object
          properties:
            check_key:
              type: string
              enum:
                - site.images.alt_descriptive
            detail:
              $ref: >-
                #/components/schemas/technical_audit_detail_images_alt_descriptive
          required:
            - check_key
            - detail
    technical_audit_check_page_for_content_substantive:
      allOf:
        - $ref: '#/components/schemas/technical_audit_check_page_base'
        - type: object
          properties:
            check_key:
              type: string
              enum:
                - site.content.substantive
            detail:
              $ref: '#/components/schemas/technical_audit_detail_content_substantive'
          required:
            - check_key
            - detail
    technical_audit_check_page_for_content_outdated:
      allOf:
        - $ref: '#/components/schemas/technical_audit_check_page_base'
        - type: object
          properties:
            check_key:
              type: string
              enum:
                - site.content.outdated
            detail:
              $ref: '#/components/schemas/technical_audit_detail_content_outdated'
          required:
            - check_key
            - detail
    technical_audit_check_page_for_finding_only:
      allOf:
        - $ref: '#/components/schemas/technical_audit_check_page_base'
        - type: object
          properties:
            check_key:
              type: string
              enum:
                - access.ai_bot.oai_searchbot
                - access.ai_bot.chatgpt_user
                - access.ai_bot.gptbot
                - access.ai_bot.claude_searchbot
                - access.ai_bot.claude_user
                - access.ai_bot.claudebot
                - access.ai_bot.perplexitybot
                - access.ai_bot.perplexity_user
                - access.ai_bot.googlebot
                - access.ai_bot.google_extended
                - access.ai_bot.bingbot
                - access.ai_bot.applebot
                - access.ai_bot.applebot_extended
                - access.ai_bot.meta_externalagent
                - access.ai_bot.ccbot
                - access.ai_bot.amazonbot
                - access.ai_bot.duckassistbot
                - access.robots.reachable
                - access.server
                - access.homepage.https
                - access.homepage.http_redirect
                - access.homepage.reachable
                - access.homepage.indexable
                - access.sitemap.declared
                - access.sitemap.valid
                - site.social.open_graph
                - site.meta_description.present
                - site.articles.dates
                - site.articles.author
            detail:
              $ref: '#/components/schemas/technical_audit_detail_finding_only'
          required:
            - check_key
            - detail
    topic_facet:
      type: object
      description: >-
        A topic as a filter option for one list, not as a resource — `count`
        means "rows in this list", so the same topic reports different numbers
        on the active, inactive and suggestions surfaces.
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        count:
          type: integer
          description: >-
            Rows in THIS list belonging to the topic, under the request's other
            filters. filter[topic_ids] is excluded, so selecting a topic does
            not zero the rest
        is_deleted:
          type: boolean
          description: >-
            Topic is soft-deleted. Only reachable via the prompts facet with
            filter[is_deleted]=true, where its archived prompts still live
      required:
        - id
        - name
        - count
        - is_deleted
    error_detail:
      type: object
      properties:
        field:
          type: string
          nullable: true
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
        - field
    technical_audit_check_page_base:
      type: object
      properties:
        url:
          type: string
        importance:
          type: integer
          nullable: true
        page_type:
          type: string
          nullable: true
        dismissed:
          allOf:
            - $ref: '#/components/schemas/technical_audit_dismissal_marker'
          nullable: true
          description: This page's dismissal, else the whole check's; null when neither
      required:
        - url
        - importance
        - page_type
        - dismissed
    technical_audit_detail_schema_suggested:
      type: object
      properties:
        found:
          type: string
          description: >-
            One plain sentence on what we saw on THIS page, quoting its own
            words in ‘’
        fix:
          type: string
          description: One plain sentence on exactly what to change on this page
        examples:
          type: array
          items:
            type: string
          description: >-
            Short strings backing `found`: the H1s found, image files, linking
            pages…
        suggested:
          type: object
          additionalProperties: true
          nullable: true
          description: The JSON-LD block for this page
    technical_audit_detail_schema_valid:
      type: object
      properties:
        found:
          type: string
          description: >-
            One plain sentence on what we saw on THIS page, quoting its own
            words in ‘’
        fix:
          type: string
          description: One plain sentence on exactly what to change on this page
        examples:
          type: array
          items:
            type: string
          description: >-
            Short strings backing `found`: the H1s found, image files, linking
            pages…
        problems:
          type: array
          items:
            $ref: '#/components/schemas/technical_audit_schema_problem'
    technical_audit_detail_schema_type_mismatch:
      type: object
      properties:
        found:
          type: string
          description: >-
            One plain sentence on what we saw on THIS page, quoting its own
            words in ‘’
        fix:
          type: string
          description: One plain sentence on exactly what to change on this page
        examples:
          type: array
          items:
            type: string
          description: >-
            Short strings backing `found`: the H1s found, image files, linking
            pages…
        current_type:
          type: string
        page_type:
          type: string
          nullable: true
        confidence:
          type: number
          nullable: true
        current:
          type: object
          additionalProperties: true
          nullable: true
          description: >-
            A JSON-LD block (schema.org); <angle-bracketed> values are
            placeholders
        suggested:
          type: object
          additionalProperties: true
          nullable: true
          description: >-
            A JSON-LD block (schema.org); <angle-bracketed> values are
            placeholders
    technical_audit_detail_schema_recommended:
      type: object
      properties:
        found:
          type: string
          description: >-
            One plain sentence on what we saw on THIS page, quoting its own
            words in ‘’
        fix:
          type: string
          description: One plain sentence on exactly what to change on this page
        examples:
          type: array
          items:
            type: string
          description: >-
            Short strings backing `found`: the H1s found, image files, linking
            pages…
        page_type:
          type: string
          nullable: true
        recommended_types:
          type: array
          items:
            type: string
        suggested:
          type: object
          additionalProperties:
            type: object
            additionalProperties: true
          description: schema.org type → the JSON-LD block for this page (up to 3)
    technical_audit_detail_link_target:
      type: object
      properties:
        found:
          type: string
          description: >-
            One plain sentence on what we saw on THIS page, quoting its own
            words in ‘’
        fix:
          type: string
          description: One plain sentence on exactly what to change on this page
        examples:
          type: array
          items:
            type: string
          description: >-
            Short strings backing `found`: the H1s found, image files, linking
            pages…
        status:
          type: integer
          nullable: true
        linked_from:
          type: array
          items:
            type: string
          description: The first pages linking here
        links:
          type: array
          items:
            type: object
            properties:
              page:
                type: string
              text:
                type: string
                nullable: true
            required:
              - page
              - text
        linked_from_count:
          type: integer
    technical_audit_detail_redirect_chain:
      type: object
      properties:
        found:
          type: string
          description: >-
            One plain sentence on what we saw on THIS page, quoting its own
            words in ‘’
        fix:
          type: string
          description: One plain sentence on exactly what to change on this page
        examples:
          type: array
          items:
            type: string
          description: >-
            Short strings backing `found`: the H1s found, image files, linking
            pages…
        hops:
          type: integer
        chain:
          type: array
          items:
            type: string
    technical_audit_detail_bot_protection:
      type: object
      properties:
        found:
          type: string
          description: >-
            One plain sentence on what we saw on THIS page, quoting its own
            words in ‘’
        fix:
          type: string
          description: One plain sentence on exactly what to change on this page
        examples:
          type: array
          items:
            type: string
          description: >-
            Short strings backing `found`: the H1s found, image files, linking
            pages…
        reason:
          type: string
          nullable: true
    technical_audit_detail_snippets:
      type: object
      properties:
        found:
          type: string
          description: >-
            One plain sentence on what we saw on THIS page, quoting its own
            words in ‘’
        fix:
          type: string
          description: One plain sentence on exactly what to change on this page
        examples:
          type: array
          items:
            type: string
          description: >-
            Short strings backing `found`: the H1s found, image files, linking
            pages…
        sources:
          type: array
          items:
            type: object
            properties:
              source:
                type: string
              value:
                type: string
                nullable: true
            required:
              - source
    technical_audit_detail_noindex:
      type: object
      properties:
        found:
          type: string
          description: >-
            One plain sentence on what we saw on THIS page, quoting its own
            words in ‘’
        fix:
          type: string
          description: One plain sentence on exactly what to change on this page
        examples:
          type: array
          items:
            type: string
          description: >-
            Short strings backing `found`: the H1s found, image files, linking
            pages…
        meta_robots:
          type: string
          nullable: true
        x_robots_tag:
          type: string
          nullable: true
    technical_audit_detail_canonical:
      type: object
      properties:
        found:
          type: string
          description: >-
            One plain sentence on what we saw on THIS page, quoting its own
            words in ‘’
        fix:
          type: string
          description: One plain sentence on exactly what to change on this page
        examples:
          type: array
          items:
            type: string
          description: >-
            Short strings backing `found`: the H1s found, image files, linking
            pages…
        problem:
          type: string
          enum:
            - invalid
            - points_elsewhere
        canonical:
          type: string
        reason:
          type: string
          enum:
            - target_error
            - target_noindex
            - different_page
    technical_audit_detail_sitemap_mismatch:
      type: object
      properties:
        found:
          type: string
          description: >-
            One plain sentence on what we saw on THIS page, quoting its own
            words in ‘’
        fix:
          type: string
          description: One plain sentence on exactly what to change on this page
        examples:
          type: array
          items:
            type: string
          description: >-
            Short strings backing `found`: the H1s found, image files, linking
            pages…
        problem:
          type: string
          enum:
            - missing_from_sitemap
            - sitemap_entry_errors
            - sitemap_entry_redirects
        status:
          type: integer
          nullable: true
        redirects_to:
          type: string
    technical_audit_detail_single_h1:
      type: object
      properties:
        found:
          type: string
          description: >-
            One plain sentence on what we saw on THIS page, quoting its own
            words in ‘’
        fix:
          type: string
          description: One plain sentence on exactly what to change on this page
        examples:
          type: array
          items:
            type: string
          description: >-
            Short strings backing `found`: the H1s found, image files, linking
            pages…
        h1_count:
          type: integer
    technical_audit_detail_h1_descriptive:
      type: object
      properties:
        found:
          type: string
          description: >-
            One plain sentence on what we saw on THIS page, quoting its own
            words in ‘’
        fix:
          type: string
          description: One plain sentence on exactly what to change on this page
        examples:
          type: array
          items:
            type: string
          description: >-
            Short strings backing `found`: the H1s found, image files, linking
            pages…
        h1:
          type: string
          nullable: true
        title:
          type: string
          nullable: true
    technical_audit_detail_hierarchy:
      type: object
      properties:
        found:
          type: string
          description: >-
            One plain sentence on what we saw on THIS page, quoting its own
            words in ‘’
        fix:
          type: string
          description: One plain sentence on exactly what to change on this page
        examples:
          type: array
          items:
            type: string
          description: >-
            Short strings backing `found`: the H1s found, image files, linking
            pages…
        skipped:
          type: string
    technical_audit_detail_title_unique:
      type: object
      properties:
        found:
          type: string
          description: >-
            One plain sentence on what we saw on THIS page, quoting its own
            words in ‘’
        fix:
          type: string
          description: One plain sentence on exactly what to change on this page
        examples:
          type: array
          items:
            type: string
          description: >-
            Short strings backing `found`: the H1s found, image files, linking
            pages…
        title:
          type: string
          nullable: true
        shared_with:
          type: integer
    technical_audit_detail_title_length:
      type: object
      properties:
        found:
          type: string
          description: >-
            One plain sentence on what we saw on THIS page, quoting its own
            words in ‘’
        fix:
          type: string
          description: One plain sentence on exactly what to change on this page
        examples:
          type: array
          items:
            type: string
          description: >-
            Short strings backing `found`: the H1s found, image files, linking
            pages…
        length:
          type: integer
        title:
          type: string
          nullable: true
    technical_audit_detail_title_relevant:
      type: object
      properties:
        found:
          type: string
          description: >-
            One plain sentence on what we saw on THIS page, quoting its own
            words in ‘’
        fix:
          type: string
          description: One plain sentence on exactly what to change on this page
        examples:
          type: array
          items:
            type: string
          description: >-
            Short strings backing `found`: the H1s found, image files, linking
            pages…
        title:
          type: string
          nullable: true
        h1:
          type: string
          nullable: true
        excerpt:
          type: string
          nullable: true
        score:
          type: number
          nullable: true
    technical_audit_detail_description_relevant:
      type: object
      properties:
        found:
          type: string
          description: >-
            One plain sentence on what we saw on THIS page, quoting its own
            words in ‘’
        fix:
          type: string
          description: One plain sentence on exactly what to change on this page
        examples:
          type: array
          items:
            type: string
          description: >-
            Short strings backing `found`: the H1s found, image files, linking
            pages…
        meta_description:
          type: string
          nullable: true
        h1:
          type: string
          nullable: true
        excerpt:
          type: string
          nullable: true
        score:
          type: number
          nullable: true
    technical_audit_detail_images_alt:
      type: object
      properties:
        found:
          type: string
          description: >-
            One plain sentence on what we saw on THIS page, quoting its own
            words in ‘’
        fix:
          type: string
          description: One plain sentence on exactly what to change on this page
        examples:
          type: array
          items:
            type: string
          description: >-
            Short strings backing `found`: the H1s found, image files, linking
            pages…
        missing:
          type: integer
          description: Images without alt text
    technical_audit_detail_images_alt_descriptive:
      type: object
      properties:
        found:
          type: string
          description: >-
            One plain sentence on what we saw on THIS page, quoting its own
            words in ‘’
        fix:
          type: string
          description: One plain sentence on exactly what to change on this page
        examples:
          type: array
          items:
            type: string
          description: >-
            Short strings backing `found`: the H1s found, image files, linking
            pages…
        images:
          type: array
          items:
            type: object
            properties:
              src:
                type: string
              alt:
                type: string
                nullable: true
            required:
              - src
              - alt
    technical_audit_detail_content_substantive:
      type: object
      properties:
        found:
          type: string
          description: >-
            One plain sentence on what we saw on THIS page, quoting its own
            words in ‘’
        fix:
          type: string
          description: One plain sentence on exactly what to change on this page
        examples:
          type: array
          items:
            type: string
          description: >-
            Short strings backing `found`: the H1s found, image files, linking
            pages…
        score:
          type: number
          nullable: true
        confidence:
          type: number
          nullable: true
        page_type:
          type: string
          nullable: true
        reasons:
          type: array
          items:
            type: string
          description: Reason keys; copy is reason_labels on GET /technical_audit/checks
        excerpt:
          type: string
          nullable: true
        signals:
          type: object
          properties:
            word_count:
              type: integer
            sections:
              type: integer
            specific_sentences:
              type: integer
            links_per_100_words:
              type: number
    technical_audit_detail_content_outdated:
      type: object
      properties:
        found:
          type: string
          description: >-
            One plain sentence on what we saw on THIS page, quoting its own
            words in ‘’
        fix:
          type: string
          description: One plain sentence on exactly what to change on this page
        examples:
          type: array
          items:
            type: string
          description: >-
            Short strings backing `found`: the H1s found, image files, linking
            pages…
        probability:
          type: number
          nullable: true
        page_type:
          type: string
          nullable: true
        reasons:
          type: array
          items:
            type: string
          description: Reason keys; copy is reason_labels on GET /technical_audit/checks
        excerpt:
          type: string
          nullable: true
        old_years:
          type: array
          items:
            type: integer
    technical_audit_detail_finding_only:
      type: object
      properties:
        found:
          type: string
          description: >-
            One plain sentence on what we saw on THIS page, quoting its own
            words in ‘’
        fix:
          type: string
          description: One plain sentence on exactly what to change on this page
        examples:
          type: array
          items:
            type: string
          description: >-
            Short strings backing `found`: the H1s found, image files, linking
            pages…
    technical_audit_dismissal_marker:
      type: object
      description: >-
        Set when the team dismissed this finding: who, when and why. A dismissed
        finding is still shown, but no longer counts as a problem.
      properties:
        id:
          type: string
          format: uuid
          description: Pass to DELETE /technical_audit/dismissals/{dismissal_id} to undo
        by:
          type: string
          nullable: true
          description: Name (or email) of whoever dismissed it, when known
        at:
          type: string
          format: date-time
        reason:
          type: string
          nullable: true
      required:
        - id
        - by
        - at
        - reason
    technical_audit_schema_problem:
      type: object
      description: >-
        A structured-data problem on one page and its fix. `suggested` is always
        the block to paste in place of `current` (or of the unparseable script):
        the page's own node with the missing fields filled from the page, or
        (unparseable) a full block of the type that fits the page.
        <angle-bracketed> values are placeholders for the customer to replace.
      properties:
        type:
          type: string
          description: schema.org type of the problem node (absent for unparseable)
        missing:
          type: array
          items:
            type: string
          description: Required fields the node lacks
        error:
          type: string
          enum:
            - unparseable
        count:
          type: integer
          description: Unparseable ld+json scripts on the page
        current:
          type: object
          additionalProperties: true
          description: The node as found on the page
        suggested:
          type: object
          additionalProperties: true
          description: The corrected JSON-LD block
      required:
        - suggested
  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.