Analytics

Get site summary overview

Get site summary overview analytics.

Returns LLM presence statistics including:

Current day stats
Brands by topics
Brands by providers
Citation score
Sentiment analysis
Visibility score

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

get/overview

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

Overview data retrieved successfully

successboolean

messagestring

codeinteger

errorsobject

meta_dataobject

Example response

{
  "success": true,
  "message": "Overview data retrieved successfully for 30 dates",
  "code": 200,
  "data": {
    "current_day_stats": {
      "visibility_score": 75.5,
      "citation_score": 82.3,
      "sentiment_score": 0.85
    },
    "visibility_score": {
      "current": 75.5,
      "previous": 70.2,
      "trend": "up"
    },
    "sentiment_analysis": {
      "positive": 0.7,
      "neutral": 0.2,
      "negative": 0.1
    }
  }
}

Changes

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