Reports

Stream Visibility V2

post/v2/reports/visibility/stream

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

category_idstring required

start_datestring required

YYYY-MM-DD, ET, inclusive

end_datestring required

YYYY-MM-DD, ET, inclusive

group_bystring[]

metricsstring[] nullable

interval'day' | 'week' | 'month'

scope'owned' | 'all'

limitinteger nullable

Page size; default 10, max 50.

max_resultsinteger nullable

Stream endpoint only: cap the number of streamed rows (default: all).

cursorstring nullable

Successful Response

Jun 30, 2026aa90940badac Revision changes
- breaking
  removed the enum value tag of the request property /
Jun 30, 202689ce8e6b341b Revision changes
- info
  endpoint added