Async Analytics Request (Deprecated)

Request analytics for a Book to be computed behind the scenes. You'll be notified when they're ready.


🚧

We have a better version!

This product was deprecated in December 2023 and has been superseded by our new Analytics 2.0 offering, which we recommend for all new work.

You can retrieve the results when they're ready by registering a webhook that listens for the ANALYTICS_COMPLETED event. You can also poll the Async Analytics Result endpoint regularly if you don't mind exchanging precision for simplicity.

📘

Multiple endpoints, one object

The asynchronous results endpoint and the synchronous version return analytics objects in the same format. The XLSX endpoint logically returns most of the same information, but does not use the same schema since JSON schemas don't apply to Excel files. You can find a detailed reference of the returned analytics object here.

📘

Multiple endpoints, one object

The asynchronous results endpoint and the synchronous version return analytics objects in the same format. The XLSX endpoint logically returns most of the same information, but does not use the same schema since JSON schemas don't apply to Excel files. You can find a detailed reference of the returned analytics object here.

Body Params
uint64
required

The PK of the Book that contains the bank statements you'd like to have analyzed.

extra_fields
array of strings
deprecated

A list of extra analytics fields to include in the result. See here for a full list. These fields are also listed in this documentation.

Future revisions of this endpoint will include these fields by default. This will not constitute a breaking change, so we may not give advance notice.

Responses

Language
Credentials
OAuth2
Response
Choose an example:
application/json