Reports

Query Sentiment V2

post/v2/reports/sentiment

Request

Base URL
https://api.tryprofound.com
Auth
- API key in header X-API-Key
- or HTTP bearer
TypeScript
https://skmtc.dev/cooper-square-technologies/apis/external-api/docs/v2/reports/sentiment/post.ts
A function with typed inputs. Its response is checked against the schema.

category_idstring required

assetstring required

The brand name to analyze (sentiment is extracted on name, not id).

start_datestring required

YYYY-MM-DD, ET, inclusive

end_datestring required

YYYY-MM-DD, ET, inclusive

comparison_start_datestring nullable

YYYY-MM-DD, ET, inclusive (with end).

comparison_end_datestring nullable

YYYY-MM-DD, ET, inclusive (with start).

group_bystring[]

metricsstring[] nullable

interval'day' | 'week' | 'month'

include_cited_websitesboolean

Return cited websites per row (only when grouping by theme/claim).

limitinteger nullable

Page size; default 10, max 50.

max_resultsinteger nullable

Stream endpoint only: cap the number of streamed rows (default: all).

cursorstring nullable

Successful Response

object required