Skip to main content
GET
/
api
/
funding-analytics
/
heatmap
Funding heatmap — 2D cross-tabulation
curl --request GET \
  --url https://api.example.com/api/funding-analytics/heatmap \
  --header 'Authorization: Bearer <token>'
{
  "x_labels": [
    "<string>"
  ],
  "y_labels": [
    "<string>"
  ],
  "cells": [
    [
      123,
      123,
      123
    ]
  ],
  "x_totals": [
    123
  ],
  "y_totals": [
    123
  ],
  "grand_total": 123,
  "query_info": {
    "metric": "<string>",
    "x_dimension": "<string>",
    "y_dimension": "<string>",
    "total_rows": 123
  }
}

Authorizations

​
Authorization
string
header
required

Auth0 JWT access token

Query Parameters

​
x
enum<string>
required

X-axis dimension

Available options:
round_year,
round_quarter,
round_type,
standardized_round,
stage,
country,
continent,
city,
region,
sector,
standardized_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,
stage,
country,
continent,
city,
region,
sector,
standardized_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 /api/aggregate/:source

Example:

"year[gte]:2020"

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