Skip to main content
POST
/
v1
/
prompt-volumes
/
volume
Get Volume
curl --request POST \
  --url https://api.tryprofound.com/v1/prompt-volumes/volume \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "metrics": [
    "volume"
  ],
  "start_date": "2023-11-07T05:31:56Z",
  "end_date": "2023-11-07T05:31:56Z",
  "date_interval": "day",
  "dimensions": [],
  "order_by": {},
  "pagination": {
    "limit": 10000,
    "offset": 0
  },
  "filters": [
    {
      "field": "<string>",
      "operator": "is",
      "value": "<string>"
    }
  ]
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
metrics
enum<string>[]
required
Available options:
volume,
change
​
start_date
string<date-time>
required

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

​
end_date
string<date-time>
required

End date for the query. 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:
hour,
day,
week,
month,
year,
relative_week
​
dimensions
enum<string>[]

Dimensions to group the report by.

Available options:
keyword,
date,
platform,
country_code,
matching_type,
frequency
​
order_by
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.

Example:
{ "date": "asc" }
​
pagination
Pagination · object

Pagination settings for the report results.

​
filters
(CountryCodeFilter · object | FrequencyFilter · object | KeywordFilter · object | MatchingTypeFilter · object | PlatformFilter · object)[]

Filters to apply to the query

Filter by country code

Response

Successful Response