Report batches
A report batch is one run of reports: the reports AdviceCloud makes for a set of your firm's households, over one date range, with one set of report options. The console lists report batches on its Reports tab.
After you create a report batch, AdviceCloud makes its reports in the background. The report batch starts with the status pending, and changes to complete when its reports are ready, or to failed. To check it, call Get a report batch.
To save a set of report options for later runs, call Create a report template.
List report batches
Returns your firm's report batches, in ascending order of `id`. To see the reports of a report batch, call **Get a report batch**.
Create a report batch
Creates a report batch and starts making reports for the households in `householdIds`, or for every active household of your firm when `householdIds` is empty. IDs of households that are not your firm's are ignored. A household with no performance data gets no report.
Get a report batch
Returns the report batch with the given ID and its reports that are ready. If your firm has no report batch with that ID, the response is `404`.
Delete a report batch
Deletes the report batch with the given ID and its reports. Returns `deleted: true`. If your firm has no report batch with that ID, the response is `404`.