This API retrieves analytics encompassing Enriched Transactions, Book Summary, Cash Flow Features for a Book in an Excel format.

The output of this endpoint is intended for manual review, as opposed to automated consumption by your application.

🚧

The response will have a MIME type of application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, hence there is no JSON response schema. See here for an example output.

Async processing

This API supports asynchronous processing. To get the asynchronous result, add async=true in the query parameter to run the request as a background job and receive a job_id immediately instead of waiting for the full response inline. When async=true, the endpoint returns 202 Accepted with a job_id instead of the analytics payload.

Async mode is required for Books with more than 100,000 transactions. Books exceeding 1,000,000 transactions are rejected with 422 (error code 1100). Once submitted, poll
Async job status API to retrieve the result when the job is complete.