Skip to main content
GET
/
ai-overviews
/
visibility
Get AI overview visibility
curl --request GET \
  --url https://api.beeze.io/v1/ai-overviews/visibility \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "date": "<string>",
      "totalChats": 123,
      "brands": [
        {
          "competitorId": "<string>",
          "name": "<string>",
          "displayName": "<string>",
          "domain": "<string>",
          "mentions": 123,
          "percentage": 123,
          "color": "<string>"
        }
      ]
    }
  ]
}

Authorizations

​
x-api-key
string
header
required

API key for external Beeze API access

Query Parameters

​
project
string
required

Project identifier. Accepts project ID, slug, or name within the active workspace. If the project name is ambiguous in that workspace, use the project slug or project ID. Public project-scoped routes also require globally unique project names across workspaces.

Minimum string length: 1
​
from
string<date>

Start date in YYYY-MM-DD format

​
to
string<date>

End date in YYYY-MM-DD format

​
topBrands
integer
default:5
Required range: 1 <= x <= 20
​
provider
string
​
promptId
string<uuid>

Response

Brand visibility timeline

​
data
object[]
required