POST
/
v1
/
reports
/
sentiment
Query Sentiment
curl --request POST \
  --url https://api.tryprofound.com/v1/reports/sentiment \
  --header 'Content-Type: application/json' \
  --data '{
  "date_interval": "day",
  "dimensions": [],
  "metrics": [
    "positive"
  ],
  "filters": [],
  "order_by": {
    "date": "asc"
  },
  "pagination": {
    "limit": 10000,
    "offset": 0
  },
  "category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z"
}'
{
  "info": {
    "total_rows": 123,
    "query": {}
  },
  "data": [
    {
      "metrics": [
        123
      ],
      "dimensions": [
        "<string>"
      ]
    }
  ]
}

Authorizations

​
api_key
string
query
required

Body

application/json
​
metrics
enum<string>[]
required
​
category_id
string<uuid>
required
​
start_date
string<date-time>
required

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

​
end_date
string<date-time>
required

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

​
date_interval
enum<string>
default:day

Date interval for the report. (only used with date dimension)

Available options:
day,
week,
month,
year
​
dimensions
enum<string>[]

Dimensions to group the report by.

​
filters
Filter[Literal['asset_name', 'theme', 'region', 'topic', 'model', 'tag']] · object[]

List of filters to apply to the report. Each filter has an operator, field, and value.

​
order_by
object

Custom ordering of the report results.

The order is a record of key-value pairs where:

  • key is the field to order by, which can be a metric or dimension
  • value is the direction of the order, either 'asc' for ascending or 'desc' for descending.

When not specified, the default order is the first metric in the query descending.

Examples:
{ "date": "asc" }
​
pagination
object

Pagination settings for the report results.

Response

Successful Response

Base response model for reports.

​
info
object
required

Base model for report information.

​
data
Result · object[]
required