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

# Get Monitoring

> Get site summary monitoring analytics with historical trends.

Returns:
- Brands by topics
- Visibility score with history
- Historical comparison with trends

**Note**: For USER-level keys, the `X-Project-ID` header is required.



## OpenAPI

````yaml GET /monitoring
openapi: 3.0.3
info:
  title: Wellows Public API
  description: >-
    ## Overview


    The Wellows Public API allows you to programmatically access your SEO
    analytics and AI-powered insights.


    ## Authentication


    All API requests require an API key passed in the `X-API-Key` header:


    ```

    X-API-Key: your_api_key_here

    ```


    ### API Key Types


    - **USER-level keys**: Access all projects owned by your account. Requires
    `X-Project-ID` header for project-specific endpoints.

    - **PROJECT-level keys**: Scoped to a single project. No `X-Project-ID`
    header needed.


    ## Response Format


    All responses follow a standard format:


    ```json

    {
      "success": true,
      "message": "Success message",
      "code": 200,
      "data": { ... },
      "errors": {},
      "meta_data": {}
    }

    ```
  version: 1.0.0
  contact:
    name: Wellows Digital Force
    url: https://wellows.com
servers:
  - url: https://integrations.wellows.com/api/v1/
    description: API for Wellows.com
security:
  - ApiKeyAuth: []
tags:
  - name: Authentication
    description: Validate API keys
  - name: Projects
    description: List and access project information
  - name: Analytics
    description: Retrieve SEO and AI analytics data
paths:
  /monitoring:
    get:
      tags:
        - Analytics
      summary: Get site summary monitoring
      description: |-
        Get site summary monitoring analytics with historical trends.

        Returns:
        - Brands by topics
        - Visibility score with history
        - Historical comparison with trends

        **Note**: For USER-level keys, the `X-Project-ID` header is required.
      operationId: getMonitoring
      parameters:
        - name: X-Project-ID
          in: header
          description: >-
            Project ID (required for USER-level keys, optional for PROJECT-level
            keys)
          required: false
          schema:
            type: integer
        - name: start_date
          in: query
          description: Start date for date range filter (YYYY-MM-DD)
          required: false
          schema:
            type: string
            format: date
            example: '2024-01-01'
        - name: end_date
          in: query
          description: End date for date range filter (YYYY-MM-DD)
          required: false
          schema:
            type: string
            format: date
            example: '2024-01-31'
        - name: region
          in: query
          description: Filter by region code
          required: false
          schema:
            type: string
            example: US
        - name: provider
          in: query
          description: Filter by LLM provider
          required: false
          schema:
            type: string
            example: openai
      responses:
        '200':
          description: Monitoring data retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MonitoringResponse'
              example:
                success: true
                message: Monitoring data retrieved successfully for 30 dates
                code: 200
                data:
                  brands_by_topics:
                    topic1:
                      - brand1
                      - brand2
                    topic2:
                      - brand3
                  visibility_score:
                    current: 75.5
                    history:
                      - date: '2024-01-01'
                        score: 70.2
                      - date: '2024-01-15'
                        score: 72.8
                      - date: '2024-01-30'
                        score: 75.5
                  historical_comparison:
                    current_period:
                      start: '2024-01-01'
                      end: '2024-01-31'
                      visibility_score: 75.5
                    previous_period:
                      start: '2023-12-01'
                      end: '2023-12-31'
                      visibility_score: 70.2
                    trend: up
                    change_percentage: 7.5
                errors: {}
                meta_data: {}
        '400':
          description: Bad Request - X-Project-ID required for USER-level keys
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden - No access to the specified project
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                success: false
                message: Failed to retrieve monitoring data
                code: 500
                data: {}
                errors: {}
                meta_data: {}
components:
  schemas:
    MonitoringResponse:
      type: object
      properties:
        success:
          type: boolean
          example: true
        message:
          type: string
          example: Monitoring data retrieved successfully for 30 dates
        code:
          type: integer
          example: 200
        data:
          type: object
          description: Monitoring analytics data with historical trends
          properties:
            brands_by_topics:
              type: object
              description: Brands mentioned organized by topic
              additionalProperties:
                type: array
                items:
                  type: string
            visibility_score:
              type: object
              description: Visibility score with historical data
              properties:
                current:
                  type: number
                  example: 75.5
                history:
                  type: array
                  items:
                    type: object
                    properties:
                      date:
                        type: string
                        format: date
                        example: '2024-01-01'
                      score:
                        type: number
                        example: 70.2
            historical_comparison:
              type: object
              description: Comparison between current and previous periods
              properties:
                current_period:
                  type: object
                  properties:
                    start:
                      type: string
                      format: date
                      example: '2024-01-01'
                    end:
                      type: string
                      format: date
                      example: '2024-01-31'
                    visibility_score:
                      type: number
                      example: 75.5
                previous_period:
                  type: object
                  properties:
                    start:
                      type: string
                      format: date
                      example: '2023-12-01'
                    end:
                      type: string
                      format: date
                      example: '2023-12-31'
                    visibility_score:
                      type: number
                      example: 70.2
                trend:
                  type: string
                  enum:
                    - up
                    - down
                    - stable
                  example: up
                change_percentage:
                  type: number
                  example: 7.5
        errors:
          type: object
        meta_data:
          type: object
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          example: Error description
        code:
          type: integer
          example: 400
        data:
          type: object
        errors:
          type: object
          properties:
            error:
              type: string
            detail:
              type: string
        meta_data:
          type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your API key from the API Keys page

````