Sign in

v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB
Cash Flow Analytics

Cash flow benchmarking (CFB)

Retrieve benchmarking percentiles for an SMB <glossary: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.

🚧 Early access! This feature is available through early access. To enable either feature for your organization, contact your Account Manager.

📘 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.

get/v2/analytics/book/{book_uuid}/benchmark

Path parameters

book_uuidstring required

The unique identifier of the <glossary:Book>.

Query parameters

time_window_days30 | 60 | 90 | 180 | 270 | 365

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.

geography_type'national' | 'state' | 'msa'

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

geography_code'ALL' | 'AL' | 'AK' | 'AZ' | 'AR' | 'CA' | 'CO' | 'CT' | 'DE' | 'DC' | 'FL' | 'GA' | 'GU' | 'HI' | 'ID' | 'IL' | 'IN' | 'IA' | 'KS' | 'KY' | 'LA' | 'ME' | 'MD' | 'MA' | 'MI' | 'MN' | 'MS' | 'MO' | 'MT' | 'NE' | 'NV' | 'NH' | 'NJ' | 'NM' | 'NY' | 'NC' | 'ND' | 'MP' | 'OH' | 'OK' | 'OR' | 'PA' | 'PR' | 'RI' | 'SC' | 'SD' | 'TN' | 'TX' | 'TU' | 'TV' | 'UT' | 'VA' | 'VI' | 'WA' | 'WV' | 'WI' | 'WY'

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'naics2' | 'naics4' | 'naics6'

<glossary:NAICS> granularity used to build the peer group.

industry_codestring

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

Response

Success

book_uuidstring

The Book for which benchmarking ran.

book_created_tsstring date-time

ISO 8601 timestamp of the Book's creation. The time_window_days window is measured back from this point.