Skip to main content
GET
/
overview
Get site summary overview
curl --request GET \
  --url https://integrations.wellows.com/api/v1/overview \
  --header 'X-API-Key: <api-key>'
{
  "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
    },
    "brands_by_topics": {
      "topic1": [
        "brand1",
        "brand2"
      ],
      "topic2": [
        "brand3"
      ]
    },
    "brands_by_providers": {
      "openai": [
        "brand1"
      ],
      "anthropic": [
        "brand2"
      ]
    },
    "visibility_score": {
      "current": 75.5,
      "previous": 70.2,
      "trend": "up"
    },
    "sentiment_analysis": {
      "positive": 0.7,
      "neutral": 0.2,
      "negative": 0.1
    }
  },
  "errors": {},
  "meta_data": {}
}

Authorizations

​
X-API-Key
string
header
required

Your API key from the API Keys page

Headers

​
X-Project-ID
integer

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

Query Parameters

​
start_date
string<date>

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

Example:

"2024-01-01"

​
end_date
string<date>

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

Example:

"2024-01-31"

​
region
string

Filter by region code

Example:

"US"

​
provider
string

Filter by LLM provider

Example:

"openai"

Response

Overview data retrieved successfully

​
success
boolean
Example:

true

​
message
string
Example:

"Overview data retrieved successfully for 30 dates"

​
code
integer
Example:

200

​
data
object

Overview analytics data

​
errors
object
​
meta_data
object