---
title: "Async Analytics Request (Deprecated)"
method: POST
path: "/v1/book/analytics/async/request"
tags: ["Legacy Cash Flow Analytics (Deprecated)"]
deprecated: true
---

# Async Analytics Request (Deprecated)

`POST /v1/book/analytics/async/request`

## Request

- Base URL: `https://api.ocrolus.com`
- URL: `https://api.ocrolus.com/v1/book/analytics/async/request`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://auth.ocrolus.com/oauth/token`

> **Deprecated.**

Request analytics for a <<glossary: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](ref:book-summary), which we recommend for all new work.

You can retrieve the results when they're ready by [registering a webhook](doc:registering-webhook-endpoint) that listens for the `ANALYTICS_COMPLETED` event. You can also poll the [Async Analytics Result endpoint](ref:async-analytics-result) regularly if you don't mind exchanging precision for simplicity.

> 📘 Multiple endpoints, one object
> The [asynchronous results endpoint](ref:async-analytics-result) and [the synchronous version](ref:analytics) return analytics objects in the same format. The [XLSX endpoint](ref:analytics-excel) 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](doc:analytics-type).

## Request body

- object
  - `pk` integer, required: The <<glossary:PK>> of the <<glossary:Book>> that contains the bank statements you'd like to have analyzed.
  - `extra_fields` string[]: A list of extra analytics fields to include in the result. See [here](doc:extra-fields) 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](doc:breaking-change-policy), so we may not give advance notice.

## Response `200`

Success

- object
  - `status` integer: Numerical code indicating the status of this request.
  - `message` string: A textual description that indicates details about this response's status.
  - `response` object
    - `analytics_request_id` string, uuid: A unique identifier for this analytics request. Provide it to the [Result](ref:async-analytics-result) endpoint to retrieve the results.

## Other responses

- `400`: Client Errors

---

[API](https://skmtc.dev/ocrolus/apis/analyze.md) - [All operations](https://skmtc.dev/ocrolus/apis/analyze/llms.txt) - [OpenAPI document](https://skmtc.dev/ocrolus/apis/analyze/revisions/4ef40f224ab5?raw)