Brands
Visibility overview rollup for a brand
A single rollup of a brand's stored snapshots for a dashboard overview: coverage, average position, share of voice, sentiment split, a per-engine breakdown, and the most-mentioned competitors. Free.
GET
/v1/brands/{id}/overviewAuthorization
accessKey x-access-key<token>
In: header
Path Parameters
id*string
Query Parameters
engine?string
Value in
"chatgpt" | "claude" | "gemini" | "perplexity"from?string
to?string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/brands/string/overview"{
"success": true,
"data": {
"brandId": "string",
"checks": 0,
"mentioned": 0,
"coverage_pct": 0,
"avg_position": null,
"share_of_voice": null,
"sentiment": {
"positive": 0,
"neutral": 0,
"negative": 0,
"overall": null
},
"by_engine": [
{
"engine": "string",
"checks": 0,
"mentioned": 0,
"mention_rate": 0,
"avg_position": null
}
],
"top_competitors": [
{
"name": "string",
"count": 0
}
],
"first_checked_at": null,
"last_checked_at": null
}
}{
"success": false,
"message": "string"
}{
"success": false,
"message": "string"
}{
"success": false,
"message": "string"
}