Skip to main content
POST
/
v1
/
reports
/
query-fanouts
Query Fanouts
curl --request POST \
  --url https://api.tryprofound.com/v1/reports/query-fanouts \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "metrics": [
    "fanouts_per_execution"
  ],
  "category_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "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": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}
'
{
  "info": {
    "total_rows": 123,
    "query": {}
  },
  "data": [
    {
      "metrics": [
        123
      ],
      "dimensions": [
        "<string>"
      ]
    }
  ]
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
metrics
enum<string>[]
required
Available options:
fanouts_per_execution,
total_fanouts,
share
​
category_id
string<uuid>
required
​
start_date
string<date-time>
required

Start date. Accepts YYYY-MM-DD, YYYY-MM-DD HH:MM, or ISO timestamp.

​
end_date
string<date-time>
required

End date. Accepts YYYY-MM-DD, YYYY-MM-DD HH:MM, or 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:
prompt,
query,
model,
region,
date
​
order_by
Order By · object

Custom ordering. Keys must be a requested metric or the date dimension. Values are asc or desc. Defaults to first metric descending.

Example:
{ "fanouts_per_execution": "desc" }
​
pagination
Pagination · object

Pagination settings for the report results.

​
filters
(RegionIdFilter · object | ModelIdFilter · object | TopicIdFilter · object | TagIdFilter · object | PromptIdFilter · object | PersonaIdFilter · object | PromptTypeFilter · object)[]

Filters to apply to the query fanout report.

Filter by region UUID.

Response

Successful Response

Base response model for reports.

​
info
Info · object
required

Base model for report information.

​
data
Result · object[]
required