Skip to main content
GET
Get per-prompt sentiment analytics for a product

Authorizations

x-api-key
string
header
required

Organization-scoped API key. Available scopes:

  • content:read: Read site pages, markdown content, and llms.txt files
  • content:write: Create, update, and delete site pages and content
  • prompts:read: Read prompts, topics, and prompt analysis results
  • prompts:write: Create, update, archive prompts
  • simulations:read: Read agent-simulation tasks, runs, environments, and analytics
  • simulations:write: Create and trigger simulation runs
  • logs:read: Read AI-traffic logs and request-level audit events
  • analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV)
  • analytics:write: Write events to analytics
  • products:read: Read product metadata and competitor data
  • products:write: Update product settings and competitor lists

Query Parameters

productId
string
required

Product ID to use as the primary sentiment scope.

Minimum string length: 1
by
enum<string>
default:prompt
Available options:
prompt
viewId
string

View ID to scope results to prompts assigned to the view.

Minimum string length: 1
promptId
string

Prompt ID. Returns a daily sentiment time series for one prompt.

Minimum string length: 1
topicId
string

Topic ID to filter per-prompt sentiment rows.

Minimum string length: 1
start
string

Start of date window, formatted as YYYY-MM-DD.

end
string

End of date window, formatted as YYYY-MM-DD.

wow
enum<string>
Available options:
true,
false

Response

Successful response

ok
enum<boolean>
required
Available options:
true
data
object
required