Competitors

Compare visibility for your brand and its competitors.

GET /api/v1/reporting/teams/{team_id}/competitors

curl --fail-with-body "https://api.brandvisibility.ai/api/v1/reporting/teams/$TEAM_ID/competitors" \
  -H "Authorization: Bearer $BRANDVISIBILITY_API_KEY"

Parameters

Parameter	Location	Required	Description
team_id	path	Yes	{"format": "uuid"}
scope	query	No	Row filter; rates don’t change with it {"enum": ["all", "verified", "top"], "default": "all"}
search	query	No	Brand-name substring
sort	query	No	{"enum": ["visibility_rate", "name"], "default": "visibility_rate"}
direction	query	No	{"enum": ["asc", "desc"], "default": "desc"}
provider_id	query	No	Restrict to one AI provider
limit	query	No	Page size, 1-200 {"maximum": 200, "minimum": 1, "default": 50}
cursor	query	No	next_cursor from the previous page
start_date	query	No	Inclusive, YYYY-MM-DD. Default: 29 days before end_date.
end_date	query	No	Inclusive, YYYY-MM-DD. Default: today (UTC).

Response fields

These fields appear in data (one object or a list, depending on the endpoint). The OpenAPI document defines exact types, nullable values and response envelopes.

Field	Meaning
brand_id	See the downloadable schema for the complete type and nullability.
brand_name	See the downloadable schema for the complete type and nullability.
is_own_brand	See the downloadable schema for the complete type and nullability.
is_verified	See the downloadable schema for the complete type and nullability.
is_pinned	See the downloadable schema for the complete type and nullability.
visibility_rate	See the downloadable schema for the complete type and nullability.
previous_visibility_rate	See the downloadable schema for the complete type and nullability.
visibility_rate_by_provider	See the downloadable schema for the complete type and nullability.
previous_visibility_rate_by_provider	See the downloadable schema for the complete type and nullability.
merged_brand_names	See the downloadable schema for the complete type and nullability.

Requires read-only reporting access. Team-scoped requests return 404 if the credential cannot access that team. See authentication, pagination and dates, and errors and rate limits.