Skip to main content
GET
Get funding heatmap

Authorizations

Authorization
string
header
required

OAuth2 client-credentials flow against the Dealroom Auth0 tenant. Use the client_id / client_secret from a Programmatic API key. Tokens are valid for 1h — Swagger UI will reuse the same token across operations. Revoking or deactivating a key rejects it on the next request (within a ≤5-minute server-side cache window), not at token expiry.

Scopes

read:funding-analytics
oauth2

Grant the read:funding-analytics permission

read:funding-analytics
bearerAuth

Headers

API-Version
string<date>

Pin a Stripe-style date-based API version (YYYY-MM-DD). Omit to use the latest version (2026-10-22). A pinned version is supported for 30 days after it is superseded, after which it returns 400.

Example:

"2026-10-22"

Query Parameters

x
enum<string>
required

X-axis dimension

Available options:
round_year,
round_quarter,
round_type,
standardized_round,
country,
continent,
city,
region,
sector,
technology,
industry_tags,
business_model,
income_stream,
client_focus,
investor_type,
investor_country,
investor_continent
Example:

"round_year"

y
enum<string>
required

Y-axis dimension

Available options:
round_year,
round_quarter,
round_type,
standardized_round,
country,
continent,
city,
region,
sector,
technology,
industry_tags,
business_model,
income_stream,
client_focus,
investor_type,
investor_country,
investor_continent
Example:

"sector"

metric
enum<string>
default:count

Metric to compute per cell

Available options:
count,
company_count,
total_amount,
avg_amount,
median_amount
Example:

"count"

top_n_x
string

Max categories on X axis (1-50, default 15)

Example:

"15"

top_n_y
string

Max categories on Y axis (1-50, default 15)

Example:

"15"

filter
string

Filter expression: and(key[op]:value,...). Same syntax as /analytics/aggregate/:source

Example:

"year[gte]:2020"

currency
string

ISO 4217 currency code for monetary field conversion. Defaults to USD.

Example:

"EUR"

Response

Heatmap matrix data

x_labels
string[]
required
y_labels
string[]
required
cells
tuple[]
required
x_totals
number[]
required
y_totals
number[]
required
grand_total
number
required
query_info
object
required
currency
string
required

ISO 4217 code of the currency amounts and amount filters are in.

Example:

"USD"