Skip to content

Brand visibility

Read brand visibility for the selected period and compare it with the preceding period.

GET /api/v1/reporting/teams/{team_id}/visibility
Terminal window
curl --fail-with-body "https://api.brandvisibility.ai/api/v1/reporting/teams/$TEAM_ID/visibility" \
-H "Authorization: Bearer $BRANDVISIBILITY_API_KEY"
Parameter Location Required Description
team_id path Yes {"format": "uuid"}
interval query No Bucket size for mentions_by_period {"enum": ["day", "week", "month"], "default": "day"}
provider_id query No Restrict to one AI provider
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).

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_name See the downloadable schema for the complete type and nullability.
visibility_rate Percentage of possible responses mentioning the brand
previous_visibility_rate Same measure over the equal-length preceding period
change Period-over-period change, percentage points
mentions See the downloadable schema for the complete type and nullability.
previous_mentions See the downloadable schema for the complete type and nullability.
query_count See the downloadable schema for the complete type and nullability.
day_count See the downloadable schema for the complete type and nullability.
provider_count See the downloadable schema for the complete type and nullability.
mentions_by_period period start (per interval) -> provider name -> mention count

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.