v84

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-0985248447.1 KB

Reports

Query Sentiment V2

post/v1/reports/sentiment-v2

category_idstring uuid required

asset_namestring required

start_datestring date-time required

Start date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full ISO timestamp.

end_datestring date-time required

End date for the report. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:MM, or full ISO timestamp.

comparison_start_datestring date-time nullable

Start of the previous period for delta computation.

comparison_end_datestring date-time nullable

End of the previous period for delta computation.

Date interval for the report. Only used when dimensions includes date.

dimensionsstring[]

Dimensions to group the report by.

metricsstring[] required

order_byobject

Custom ordering of report results. Dimension keys must also be present in dimensions. The sentiment metric orders by positive_sentiment.

{
  "order_by": {
    "occurrence": "desc"
  }
}

Successful Response