Reports

Query Fanouts

post/v1/reports/query-fanouts

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

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

dimensionsstring[]

Dimensions to group the report by.

metricsstring[] required

order_byobject

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

category_idstring uuid required

start_datestring date-time required

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

end_datestring date-time required

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

{
  "order_by": {
    "fanouts_per_execution": "desc"
  }
}

Successful Response

Jun 30, 202689ce8e6b341b Revision changes
- info
  added the new query_variations enum value to the request property /
- info
  added the new query_variations enum value to the request property /
Jun 30, 202656d428ca479f Revision changes
- breaking
  removed subschema #1 subschema #2 from the /// request property anyOf list
- info
  added subschema #1 subschema #2 to the /// request property anyOf list