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

# Get Health

> Global health (AI crawlers allowed, llms.txt, sitemap) + improvement suggestions.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/public/health
openapi: 3.1.0
info:
  title: Hikoo REST API
  description: >-
    Programmatic access to your Hikoo data: citations, prompts, competitors,
    audits, health and more. Authenticate with a personal API key
    (`Authorization: Bearer <key>`) created from the dashboard settings.
  version: 1.0.0
servers:
  - url: https://api.tryhikoo.com
security:
  - apiKey: []
paths:
  /api/v1/public/health:
    get:
      tags:
        - Health
      summary: Get Health
      description: >-
        Global health (AI crawlers allowed, llms.txt, sitemap) + improvement
        suggestions.
      operationId: get_health_api_v1_public_health_get
      parameters:
        - name: include_dismissed
          in: query
          required: false
          schema:
            type: boolean
            default: false
            title: Include Dismissed
        - name: website_id
          in: query
          required: true
          schema:
            type: integer
            description: Target website id
            title: Website Id
          description: Target website id
        - name: authorization
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: Bearer <api_key>
            title: Authorization
          description: Bearer <api_key>
        - name: X-MCP-Secret
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Mcp-Secret
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthOverviewResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HealthOverviewResponse:
      properties:
        global_health:
          $ref: '#/components/schemas/GlobalHealthResponse'
        suggestions:
          items:
            $ref: '#/components/schemas/SuggestionResponse'
          type: array
          title: Suggestions
        improvement_count:
          type: integer
          title: Improvement Count
        creation_count:
          type: integer
          title: Creation Count
        total_pages:
          type: integer
          title: Total Pages
        pages_with_issues:
          type: integer
          title: Pages With Issues
      type: object
      required:
        - global_health
        - suggestions
        - improvement_count
        - creation_count
        - total_pages
        - pages_with_issues
      title: HealthOverviewResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    GlobalHealthResponse:
      properties:
        robots_allows_ai:
          type: boolean
          title: Robots Allows Ai
        llms_txt_exists:
          type: boolean
          title: Llms Txt Exists
        sitemap_exists:
          type: boolean
          title: Sitemap Exists
        last_health_check_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Health Check At
      type: object
      required:
        - robots_allows_ai
        - llms_txt_exists
        - sitemap_exists
        - last_health_check_at
      title: GlobalHealthResponse
    SuggestionResponse:
      properties:
        id:
          type: integer
          title: Id
        suggestion_type:
          type: string
          title: Suggestion Type
        suggestion_category:
          type: string
          title: Suggestion Category
        category:
          anyOf:
            - type: string
            - type: 'null'
          title: Category
        priority:
          type: string
          title: Priority
        affected_pages_count:
          type: integer
          title: Affected Pages Count
        example_urls:
          items:
            type: string
          type: array
          title: Example Urls
        message:
          type: string
          title: Message
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        dismissed_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Dismissed At
      type: object
      required:
        - id
        - suggestion_type
        - suggestion_category
        - category
        - priority
        - affected_pages_count
        - example_urls
        - message
        - description
        - dismissed_at
      title: SuggestionResponse
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: Personal API key created in the dashboard (Settings > API keys).

````