---
title: "SMB analytics (Excel)"
method: GET
path: "/v2/book/{book_uuid}/lender_analytics/xlsx"
tags: ["Cash Flow Analytics"]
---

# SMB analytics (Excel)

`GET /v2/book/{book_uuid}/lender_analytics/xlsx`

## Request

- Base URL: `https://api.ocrolus.com`
- URL: `https://api.ocrolus.com/v2/book/{book_uuid}/lender_analytics/xlsx`
- Auth: OAuth 2
  - Client credentials
  - Token URL: `https://auth.ocrolus.com/oauth/token`

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](https://docs.google.com/spreadsheets/d/1RMtnH8StW_5ajcI6-6xgws81qnV4BwDv/edit?usp=sharing&ouid=108945757603422712879&rtpof=true&sd=true) 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](https://docs.ocrolus.com/reference/async-job-status) API to retrieve the result when the job is complete.

## Path parameters

- `book_uuid` string, uuid, required

## Query parameters

- `async` boolean

## Response `200`

Success

## Other responses

- `202`: Accepted
- `400`: Txn Limit Exceeded
- `403`: Permission Error
- `404`: Data Not Found Error
- `425`: Analytics Still Processing

---

[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)