Skip to main content
POST
Brand Report

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Report parameters

brand_id
integer
required

ID of the brand to report on

Example:

1

date
object

Optional date range filter.

ai_agent
string[]

Filter by AI agent(s). Omit to include all agents.

Example:

Response

Brand report

success
boolean
Example:

true

brand
string
Example:

"MentionPilot"

total_responses
integer

Total number of AI responses analyzed

Example:

120

visibility
integer

Average visibility across all prompts (0–100)

Example:

72

sentiment
integer

Average sentiment score across all prompts (0–100)

Example:

80

position
number

Average brand position across all prompts

Example:

2.5