Cash Flow Benchmarking (CFB)

get

https://api.ocrolus.com/v2/analytics/book/{book_uuid}/benchmark

Retrieve benchmarking percentiles for an SMB Book. The endpoint ranks the Book against anonymized peers across four metrics: revenue, expenses, fintech inflows, and fintech outflows. Use optional query parameters to shape the peer group by time window, geography, and industry granularity.

📘
Peer-group validity
Results are returned only when the peer group contains 30 or more Books. Opted-out organizations are excluded before computation. The same inputs return identical results across the API and the Dashboard.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

book_uuid

string

required

The unique identifier of the Book.

Query Params

time_window_days

integer

enum

Defaults to 90

Rolling window, in days, measured back from the Book's creation date. Sets the period over which the Book's metrics and the peer distribution are computed.

Allowed:

geography_type

string

enum

Defaults to national

Geographic scope of the peer group. msa uses metropolitan statistical area codes.

Allowed:

geography_code

string

enum

Defaults to ALL

Geographic identifier for the peer group: a state abbreviation (e.g., NY), an MSA code, or ALL. Must not be ALL when geography_type is state or msa.

industry_level

string

enum

Defaults to naics4

NAICS granularity used to build the peer group.

Allowed:

industry_code

string

NAICS code matching industry_level. Required as a 6-digit code when industry_level is naics6. Otherwise derived from the Book's NAICS data.

Responses

Language

Credentials

OAuth2

Loading…

Response

Choose an example:

application/json

200Success

400Invalid request. Returned for an invalid book_uuid, invalid parameter value or combination, or a peer group fewer than 30 books.

401Permission Error

500Internal server error