Create a report batch
POST/v1/reports/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.
Send the startDate and endDate of the period the reports cover.
Returns the report batch with the status pending. AdviceCloud makes the reports in the background: call Get a report batch to see when the status is complete.
Request
Responses
- 201
- 400
- 401
- 403
- 429
The report batch you created.
The request body is invalid, for example householdIds is missing or startDate does not start with a YYYY-MM-DD date.
The access token is missing, invalid, or expired.
The access token does not have the write:report scope.
Too many requests. Wait the number of seconds in the Retry-After-per-person header (script-audience tokens) or the Retry-After header (other requests) before you retry. See Rate limit.