Analytics

Get site summary 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.

get/monitoring

Request

Base URL
https://integrations.wellows.com/api/v1
Auth
API key in header X-API-Key

Query parameters

start_datestring date

Example:2024-01-01

Start date for date range filter (YYYY-MM-DD)

end_datestring date

Example:2024-01-31

End date for date range filter (YYYY-MM-DD)

regionstring

Example:US

Filter by region code

providerstring

Example:openai

Filter by LLM provider

Headers

X-Project-IDinteger

Project ID (required for USER-level keys, optional for PROJECT-level keys)

Response

Monitoring data retrieved successfully

successboolean

messagestring

codeinteger

errorsobject

meta_dataobject

Example response

{
  "success": true,
  "message": "Monitoring data retrieved successfully for 30 dates",
  "code": 200,
  "data": {
    "visibility_score": {
      "current": 75.5,
      "history": [
        {
          "date": "2024-01-01",
          "score": 70.2
        }
      ]
    },
    "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
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.