Skip to content
BrandVisibility.ai

Rankings

Read rankings and sentiment by query, brand and model.

GET /api/v1/reporting/teams/{team_id}/rankings
Terminal window
curl --fail-with-body "https://api.brandvisibility.ai/api/v1/reporting/teams/$TEAM_ID/rankings" \
  -H "Authorization: Bearer $BRANDVISIBILITY_API_KEY"

Parameters

Section titled “Parameters”
Parameter Location Required Description
team_id path Yes {"format": "uuid"}
brand_id query No
provider_id query No Restrict to one AI provider
tag_ids query No
sort query No {"enum": ["prompt", "brand_name", "model", "current_rank", "current_sentiment", "response_count", "latest_date"], "default": "prompt"}
direction query No {"enum": ["asc", "desc"], "default": "asc"}
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

Section titled “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
prompt See the downloadable schema for the complete type and nullability.
model See the downloadable schema for the complete type and nullability.
brand_name See the downloadable schema for the complete type and nullability.
brand_id See the downloadable schema for the complete type and nullability.
query_id See the downloadable schema for the complete type and nullability.
current_rank See the downloadable schema for the complete type and nullability.
current_sentiment See the downloadable schema for the complete type and nullability.
previous_rank See the downloadable schema for the complete type and nullability.
previous_sentiment See the downloadable schema for the complete type and nullability.
rank_change See the downloadable schema for the complete type and nullability.
sentiment_change See the downloadable schema for the complete type and nullability.
response_count See the downloadable schema for the complete type and nullability.
days_with_responses See the downloadable schema for the complete type and nullability.
percentage_days_with_responses See the downloadable schema for the complete type and nullability.
latest_date See the downloadable schema for the complete type and nullability.
tags 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.