Search calculator results
POST/api/v2/bulk/calculators/search
This request is queued, not processed while you wait. The response carries a correlation id — poll the bulk task until it reports a terminal state. See How asynchronous processing works.
Queued, not immediate — the response carries a correlation id to poll on GET /api/v2/bulk/tasks/{correlationId}. The finished task lists one entry per result page: gzipped JSON files of at most pageSize companies (default 5000), each a complete document on its own, with calculator-variable and custom-property names declared once at the top and referenced by id. Requires the id of a group your profile owns and one or more calculator type ids; several types export in one task. period.years selects reporting years — omitting the period exports the current year, never everything — and period.months narrows to monthly calculators with those reporting months. Headline output figures for each requested type come back by default; name output ids to change that, and input ids to see the values the figures were calculated from. Custom properties are returned only for the ids listed in customPropertyIds; omitting it returns no fields.
Request
Responses
- 200
- 400
- 403
Queued. The correlation id means the search has started, not that a result file exists yet.
Returned when the group id is missing, a calculator type id is unknown, an array is empty, or the page size is outside 100–10000.
Group-ownership denials are not returned here: the search is queued before the group check runs, and a request naming a group your profile doesn't own completes with that denial in the finished task's errors.