Reports

Query Sentiment V2

Changed on Jun 30, 2026

post/v1/reports/sentiment-v2

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/v1/reports/sentiment-v2/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

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.

Example request

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

Response

Successful Response

Changes

Jun 30, 2026f580e4223148 Revision changes
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
- info
  added the optional property //// to the response with the status
Jun 30, 2026b2c40a0644c3 Revision changes
- breaking
  the request property became required
- breaking
  request property list-of-types was narrowed by removing types null from media type application/json
- breaking
  the / request property format changed from no format to date-time
- breaking
  the / request property format changed from no format to date-time
- breaking
  the request property format changed from no format to date-time
- breaking
  the request property format changed from no format to date-time
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- warning
  removed the request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the new optional request property

Operation history (3 revisions)