Reports
get_sentiment_report
Retrieve a report on sentiment in brand mentions.
Operation: Read-only. The authenticated hosted connection determines the workspace.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
scope | string | No | Report scope type. project / brand / topic / prompt |
scope_id | string | No | Report scope ID. |
metrics | string[] | No | Metric names to retrieve. |
dimensions | string[] | No | Dimension names. |
date_range | object | No | Relative period or explicit start and end dates. |
date_range.period | string | No | Relative period, such as 7d, 30d, or 90d. |
date_range.start | string | No | Inclusive start timestamp or date. |
date_range.end | string | No | Inclusive end timestamp or date. |
granularity | string | No | Time-series granularity. day / week / month |
filters | object | No | Filters supported by the selected report. |
cursor | string | No | Next-page cursor from the previous response. |
limit | integer | No | Maximum number of results. Minimum: 1; Maximum: 500 |
Metrics, dimensions, and filters depend on the report. Check the report reference before choosing values. Results include columns, rows, and rowCount when report rows are available.
If the response includes a next-page cursor, pass it in the next request to continue.
Sample prompt
Compare sentiment for the selected brand over the last seven days and the previous seven days.