{
"error": {
"code": "FORBIDDEN",
"message": "You do not have permission to perform this action.",
"details": null
}
}
{
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded — retry after the delay in the `Retry-After` header.",
"details": null
}
}
{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "The service is temporarily unavailable.",
"details": null
}
}
Funding Analytics
Get funding heatmap
Returns a 2D matrix of funding data grouped by two configurable dimensions.
Response format:
x_labels/y_labels: Ordered category labels for each axis
cells: Sparse array of [x_index, y_index, value] tuples
x_totals/y_totals: Marginal totals per axis value
grand_total: Sum of all cells
Metrics:count (rounds), company_count (distinct entities), total_amount, avg_amount, median_amount. Amount metrics are returned in currency, in whole units.
Dimensions:round_year, round_quarter, sector, country, continent, standardized_round, investor_type, and more.
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.
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.
ISO 4217 code of the currency amounts and amount filters are in.
Example:
"USD"
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Dealroom API","colors":{"primary":"#3662e3","light":"#5a82eb","dark":"#2b51c4"},"logo":{"light":"https://mintcdn.com/dealroomco-prod/zEUZ2Yv9dlQn_HmO/logo/light.svg?fit=max\u0026auto=format\u0026n=zEUZ2Yv9dlQn_HmO\u0026q=85\u0026s=0f85e2db91a5a2c18c140637b2088378","dark":"https://mintcdn.com/dealroomco-prod/zEUZ2Yv9dlQn_HmO/logo/dark.svg?fit=max\u0026auto=format\u0026n=zEUZ2Yv9dlQn_HmO\u0026q=85\u0026s=74b6f42451e5ca6fc9a715a996d51934"},"favicon":"https://mintcdn.com/dealroomco-prod/zEUZ2Yv9dlQn_HmO/favicon.png?fit=max\u0026auto=format\u0026n=zEUZ2Yv9dlQn_HmO\u0026q=85\u0026s=ce7c2581e80766cbfd914ec4510a71f5","api":{},"navbar":{"links":[{"href":"https://dealroom.app","label":"Login"}],"primary":{"type":"button","label":"Get Dealroom Access","href":"https://dealroom.co"}},"seo":{"metatags":{"og:site_name":"Dealroom API Documentation","og:type":"website","og:image":"https://dealroom.co/images/dealroom-og-image.png","twitter:card":"summary_large_image","twitter:image":"https://dealroom.co/images/dealroom-og-image.png","twitter:site":"@dealroomco","robots":"index, follow","theme-color":"#3662e3"},"indexing":"all"},"contextual":{"options":["view","claude","chatgpt"],"display":"toc"},"variables":{"auth0Domain":"accounts.dealroom.co","apiAudience":"https://api.dealroom.app","baseApiUrl":"https://api.dealroom.app","baseAppUrl":"https://dealroom.app","docsUrl":"https://developers.dealroom.co","latestVersionNote":""},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"dealroomco-prod","hasAudioNarration":false,"actualSubdomain":"dealroomco-prod","customDomains":["developers.dealroom.co"],"gitSource":{"type":"github","owner":"dealroom","repo":"dealroom-next-gen","deployBranch":"docs-prod","contentDirectory":"mintlify","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6af2060bbebe6d93c54ff55d","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":100},{"language":"default","tag":"Endpoints","count":89},{"language":"default","tag":"Guides","count":17},{"language":"default","tag":"Companies","count":15},{"language":"default","tag":"Objects","count":11},{"language":"default","tag":"Concepts","count":10},{"language":"default","tag":"Investors","count":9},{"language":"default","tag":"Universities","count":7},{"language":"default","tag":"Government \u0026 NGO","count":6},{"language":"default","tag":"Discovery","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/funding-analytics/get-funding-heatmap","slug":"/api-reference/funding-analytics/get-funding-heatmap","pageMetadata":{"title":"Get funding heatmap","description":"Returns a 2D matrix of funding data grouped by two configurable dimensions.\n\n**Response format:**\n- `x_labels`/`y_labels`: Ordered category labels for each axis\n- `cells`: Sparse array of `[x_index, y_index, value]` tuples\n- `x_totals`/`y_totals`: Marginal totals per axis value\n- `grand_total`: Sum of all cells\n\n**Metrics:** `count` (rounds), `company_count` (distinct entities), `total_amount`, `avg_amount`, `median_amount`. Amount metrics are returned in `currency`, in whole units.\n\n**Dimensions:** `round_year`, `round_quarter`, `sector`, `country`, `continent`, `standardized_round`, `investor_type`, and more.","deprecated":null,"version":null,"openapi":"/openapi.yaml get /analytics/funding-analytics/heatmap","href":"/api-reference/funding-analytics/get-funding-heatmap","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n li: \"li\",\n p: \"p\",\n strong: \"strong\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Returns a 2D matrix of funding data grouped by two configurable dimensions.\"\n }), \"\\n\", _jsx(_components.p, {\n children: _jsx(_components.strong, {\n children: \"Response format:\"\n })\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"x_labels\"\n }), \"/\", _jsx(_components.code, {\n children: \"y_labels\"\n }), \": Ordered category labels for each axis\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"cells\"\n }), \": Sparse array of \", _jsx(_components.code, {\n children: \"[x_index, y_index, value]\"\n }), \" tuples\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"x_totals\"\n }), \"/\", _jsx(_components.code, {\n children: \"y_totals\"\n }), \": Marginal totals per axis value\"]\n }), \"\\n\", _jsxs(_components.li, {\n children: [_jsx(_components.code, {\n children: \"grand_total\"\n }), \": Sum of all cells\"]\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Metrics:\"\n }), \" \", _jsx(_components.code, {\n children: \"count\"\n }), \" (rounds), \", _jsx(_components.code, {\n children: \"company_count\"\n }), \" (distinct entities), \", _jsx(_components.code, {\n children: \"total_amount\"\n }), \", \", _jsx(_components.code, {\n children: \"avg_amount\"\n }), \", \", _jsx(_components.code, {\n children: \"median_amount\"\n }), \". Amount metrics are returned in \", _jsx(_components.code, {\n children: \"currency\"\n }), \", in whole units.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Dimensions:\"\n }), \" \", _jsx(_components.code, {\n children: \"round_year\"\n }), \", \", _jsx(_components.code, {\n children: \"round_quarter\"\n }), \", \", _jsx(_components.code, {\n children: \"sector\"\n }), \", \", _jsx(_components.code, {\n children: \"country\"\n }), \", \", _jsx(_components.code, {\n children: \"continent\"\n }), \", \", _jsx(_components.code, {\n children: \"standardized_round\"\n }), \", \", _jsx(_components.code, {\n children: \"investor_type\"\n }), \", and more.\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get funding heatmap","description":"Returns a 2D matrix of funding data grouped by two configurable dimensions.\n\n**Response format:**\n- `x_labels`/`y_labels`: Ordered category labels for each axis\n- `cells`: Sparse array of `[x_index, y_index, value]` tuples\n- `x_totals`/`y_totals`: Marginal totals per axis value\n- `grand_total`: Sum of all cells\n\n**Metrics:** `count` (rounds), `company_count` (distinct entities), `total_amount`, `avg_amount`, `median_amount`. Amount metrics are returned in `currency`, in whole units.\n\n**Dimensions:** `round_year`, `round_quarter`, `sector`, `country`, `continent`, `standardized_round`, `investor_type`, and more.","deprecated":null,"version":null,"openapi":"/openapi.yaml get /analytics/funding-analytics/heatmap","href":"/api-reference/funding-analytics/get-funding-heatmap","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"heatmap","security":["4330b31d-3b20-4bdd-ab1f-c0f39c0d4a89","de45fcc8-03fe-4d7d-a66f-3e231bb1b32d"],"tags":["Funding Analytics"],"summary":"Get funding heatmap","description":"Returns a 2D matrix of funding data grouped by two configurable dimensions.\n\n**Response format:**\n- `x_labels`/`y_labels`: Ordered category labels for each axis\n- `cells`: Sparse array of `[x_index, y_index, value]` tuples\n- `x_totals`/`y_totals`: Marginal totals per axis value\n- `grand_total`: Sum of all cells\n\n**Metrics:** `count` (rounds), `company_count` (distinct entities), `total_amount`, `avg_amount`, `median_amount`. Amount metrics are returned in `currency`, in whole units.\n\n**Dimensions:** `round_year`, `round_quarter`, `sector`, `country`, `continent`, `standardized_round`, `investor_type`, and more.","parameters":["966689ac-3465-46f0-b2a5-5786516af035","57bee058-5e33-463b-b638-ad871d0c80ef","c8677ffa-c941-4da6-8b51-3c5cd29ebab4","6bd30f31-2ad5-4157-a827-983ed2f211ab","65a5309c-ef86-45d6-a2ca-dc37b8f3a573","acb4fb31-6c0b-4453-88ae-fb925118efb3","24a28313-a35e-4654-a587-8b901663dcfc","b37393de-ea85-4349-bbc3-c24ac214d38e"],"responses":{"200":"5d2f7c43-3387-4492-be00-b47a2ae3c7a4","400":"82f9663d-19ea-4013-8637-c5c113a45be6","401":"467cb4c6-29cf-4827-885e-71751fede693","402":"c759074d-eb85-4b04-a64f-80649d597467","403":"c90b063c-38b5-4cb9-bdaa-85e068f2ed15","429":"2db1fafa-7d16-4360-8b57-23bfa1aee826","503":"56932a5c-2d3a-4b36-8eea-8a540f7f13b5"},"method":"get","type":"path","servers":["d038cdb4-87ef-4aa3-a977-2306495e8d2e"],"path":"/analytics/funding-analytics/heatmap","baseUrlOptions":["https://api.dealroom.app"],"title":"Get funding heatmap","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"966689ac-3465-46f0-b2a5-5786516af035":{"schema":{"type":"string","enum":["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"],"description":"X-axis dimension","example":"round_year","isRequired":true,"uniqueKey":"","typeLabel":"enum\u003cstring>"},"required":true,"description":"X-axis dimension","name":"x","in":"query"},"57bee058-5e33-463b-b638-ad871d0c80ef":{"schema":{"type":"string","enum":["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"],"description":"Y-axis dimension","example":"sector","isRequired":true,"uniqueKey":"","typeLabel":"enum\u003cstring>"},"required":true,"description":"Y-axis dimension","name":"y","in":"query"},"c8677ffa-c941-4da6-8b51-3c5cd29ebab4":{"schema":{"type":"string","enum":["count","company_count","total_amount","avg_amount","median_amount"],"default":"count","description":"Metric to compute per cell","example":"count","isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>"},"required":false,"description":"Metric to compute per cell","name":"metric","in":"query"},"6bd30f31-2ad5-4157-a827-983ed2f211ab":{"schema":{"type":"string","description":"Max categories on X axis (1-50, default 15)","example":"15","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"description":"Max categories on X axis (1-50, default 15)","name":"top_n_x","in":"query"},"65a5309c-ef86-45d6-a2ca-dc37b8f3a573":{"schema":{"type":"string","description":"Max categories on Y axis (1-50, default 15)","example":"15","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"description":"Max categories on Y axis (1-50, default 15)","name":"top_n_y","in":"query"},"acb4fb31-6c0b-4453-88ae-fb925118efb3":{"schema":{"type":"string","description":"Filter expression: and(key[op]:value,...). Same syntax as /analytics/aggregate/:source","example":"year[gte]:2020","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"description":"Filter expression: and(key[op]:value,...). Same syntax as /analytics/aggregate/:source","name":"filter","in":"query"},"24a28313-a35e-4654-a587-8b901663dcfc":{"schema":{"type":"string","description":"ISO 4217 currency code for monetary field conversion. Defaults to USD.","example":"EUR","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"description":"ISO 4217 currency code for monetary field conversion. Defaults to USD.","name":"currency","in":"query"},"b37393de-ea85-4349-bbc3-c24ac214d38e":{"name":"API-Version","in":"header","required":false,"schema":{"type":"string","format":"date","example":"2026-10-22","isRequired":false,"description":"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`.","uniqueKey":"","typeLabel":"string\u003cdate>"},"description":"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`."}},"responses":{"5d2f7c43-3387-4492-be00-b47a2ae3c7a4":{"description":"Heatmap matrix data","content":{"application/json":{"schema":{"type":"object","properties":{"x_labels":{"type":"array","items":{"type":"string","uniqueKey":"x_labels.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"x_labels","typeLabel":"string[]"},"y_labels":{"type":"array","items":{"type":"string","uniqueKey":"y_labels.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"y_labels","typeLabel":"string[]"},"cells":{"type":"array","items":{"type":"object","_tupleOriginal":true,"properties":{"[0]":{"type":"number","uniqueKey":"cells.items.[INDEX].[0]","typeLabel":"number"},"[1]":{"type":"number","uniqueKey":"cells.items.[INDEX].[1]","typeLabel":"number"},"[2]":{"type":"number","uniqueKey":"cells.items.[INDEX].[2]","typeLabel":"number"}},"uniqueKey":"cells.items.[INDEX]","typeLabel":"tuple"},"isRequired":true,"uniqueKey":"cells","typeLabel":"tuple[]"},"x_totals":{"type":"array","items":{"type":"number","uniqueKey":"x_totals.items.[INDEX]","typeLabel":"number"},"isRequired":true,"uniqueKey":"x_totals","typeLabel":"number[]"},"y_totals":{"type":"array","items":{"type":"number","uniqueKey":"y_totals.items.[INDEX]","typeLabel":"number"},"isRequired":true,"uniqueKey":"y_totals","typeLabel":"number[]"},"grand_total":{"type":"number","isRequired":true,"uniqueKey":"grand_total","typeLabel":"number"},"query_info":{"type":"object","properties":{"metric":{"type":"string","isRequired":true,"uniqueKey":"query_info.metric","typeLabel":"string"},"x_dimension":{"type":"string","isRequired":true,"uniqueKey":"query_info.x_dimension","typeLabel":"string"},"y_dimension":{"type":"string","isRequired":true,"uniqueKey":"query_info.y_dimension","typeLabel":"string"},"rows_count":{"type":"number","isRequired":true,"uniqueKey":"query_info.rows_count","typeLabel":"number"}},"required":["metric","x_dimension","y_dimension","rows_count"],"isRequired":true,"uniqueKey":"query_info","typeLabel":"object"},"currency":{"type":"string","description":"ISO 4217 code of the currency amounts and amount filters are in.","example":"USD","isRequired":true,"uniqueKey":"currency","typeLabel":"string"}},"required":["x_labels","y_labels","cells","x_totals","y_totals","grand_total","query_info","currency"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"x_labels":["\u003cstring>"],"y_labels":["\u003cstring>"],"cells":[[123,123,123]],"x_totals":[123],"y_totals":[123],"grand_total":123,"query_info":{"metric":"\u003cstring>","x_dimension":"\u003cstring>","y_dimension":"\u003cstring>","rows_count":123},"currency":"USD"}}},"exampleType":"generated"}},"headers":{"X-Credits-Used":{"description":"Credits this request consumed, under the current credit schedule. Present on every response to an API-key request under `/data`, `/analytics` and `/reference`; `0` on an error response or a free endpoint. Absent when the request was not authenticated with an API key (so never on a `401`), or on unmetered endpoints. During open beta credits are drawn from the team's balance but not billed.","schema":{"type":"integer","minimum":0},"example":25},"Deprecation":{"description":"Present when the request pinned a superseded version: the date that version was deprecated (`YYYY-MM-DD`).","schema":{"type":"string","format":"date"}},"Sunset":{"description":"Present when the request pinned a superseded version: the date the version stops working and requests begin returning `400` (`YYYY-MM-DD`).","schema":{"type":"string","format":"date"}}},"exampleType":"generated"},"82f9663d-19ea-4013-8637-c5c113a45be6":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","NOT_FOUND","UNAUTHORIZED","DATABASE_ERROR","UNKNOWN_FILTER","FILTER_VALIDATION_ERROR","UNSUPPORTED_OPERATOR","FILTER_PARSE_ERROR","QUERY_TIMEOUT","INTERNAL_SERVER_ERROR","INVALID_ENTITY_ID","PAGINATION_DEPTH_EXCEEDED","SCHEMA_ERROR","FORBIDDEN","EXTERNAL_SERVICE_ERROR","ACCOUNT_REQUIRED","PREMIUM_REQUIRED","INSTANCE_ACCESS_REQUIRED","SERVICE_UNAVAILABLE","RATE_LIMITED","CREDITS_EXHAUSTED","SUBSCRIPTION_ENDED","SEAT_REQUIRED","KEY_CREATOR_NOT_ENTITLED","ACTIVE_TEAM_CHANGED","LIST_LOCKED","PATH_RENAMED","ENDPOINT_REMOVED"],"description":"Stable machine-readable error code.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","isRequired":true,"uniqueKey":"error.details.oneOf.0.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.oneOf.0.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"uniqueKey":"error.details.oneOf.0.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details.oneOf.0","typeLabel":"object[]"},{"type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"error.details.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"error.details.oneOf.1.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"error.details.oneOf.1.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"error.details.oneOf.1.additionalProperties","typeLabel":"string | number | boolean"},"isRequired":true,"uniqueKey":"error.details.oneOf.1","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.details.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[] | object | null"}},"required":["code","message","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"VALIDATION_ERROR","message":"The request was malformed or failed validation.","details":null}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"VALIDATION_ERROR","message":"The request was malformed or failed validation.","details":null}}}},"exampleType":"examples"}},"headers":{"X-Credits-Used":{"description":"Credits this request consumed, under the current credit schedule. Present on every response to an API-key request under `/data`, `/analytics` and `/reference`; `0` on an error response or a free endpoint. Absent when the request was not authenticated with an API key (so never on a `401`), or on unmetered endpoints. During open beta credits are drawn from the team's balance but not billed.","schema":{"type":"integer","minimum":0},"example":25},"Deprecation":{"description":"Present when the request pinned a superseded version: the date that version was deprecated (`YYYY-MM-DD`).","schema":{"type":"string","format":"date"}},"Sunset":{"description":"Present when the request pinned a superseded version: the date the version stops working and requests begin returning `400` (`YYYY-MM-DD`).","schema":{"type":"string","format":"date"}}},"exampleType":"examples"},"467cb4c6-29cf-4827-885e-71751fede693":{"description":"Authentication required. The `Authorization` header was missing, the bearer token was malformed, or the token failed signature / expiry validation.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","NOT_FOUND","UNAUTHORIZED","DATABASE_ERROR","UNKNOWN_FILTER","FILTER_VALIDATION_ERROR","UNSUPPORTED_OPERATOR","FILTER_PARSE_ERROR","QUERY_TIMEOUT","INTERNAL_SERVER_ERROR","INVALID_ENTITY_ID","PAGINATION_DEPTH_EXCEEDED","SCHEMA_ERROR","FORBIDDEN","EXTERNAL_SERVICE_ERROR","ACCOUNT_REQUIRED","PREMIUM_REQUIRED","INSTANCE_ACCESS_REQUIRED","SERVICE_UNAVAILABLE","RATE_LIMITED","CREDITS_EXHAUSTED","SUBSCRIPTION_ENDED","SEAT_REQUIRED","KEY_CREATOR_NOT_ENTITLED","ACTIVE_TEAM_CHANGED","LIST_LOCKED","PATH_RENAMED","ENDPOINT_REMOVED"],"description":"Stable machine-readable error code.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","isRequired":true,"uniqueKey":"error.details.oneOf.0.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.oneOf.0.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"uniqueKey":"error.details.oneOf.0.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details.oneOf.0","typeLabel":"object[]"},{"type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"error.details.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"error.details.oneOf.1.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"error.details.oneOf.1.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"error.details.oneOf.1.additionalProperties","typeLabel":"string | number | boolean"},"isRequired":true,"uniqueKey":"error.details.oneOf.1","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.details.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[] | object | null"}},"required":["code","message","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"UNAUTHORIZED","message":"Authentication required — provide a valid bearer token.","details":null}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"UNAUTHORIZED","message":"Authentication required — provide a valid bearer token.","details":null}}}},"exampleType":"examples"}},"headers":{"Deprecation":{"description":"Present when the request pinned a superseded version: the date that version was deprecated (`YYYY-MM-DD`).","schema":{"type":"string","format":"date"}},"Sunset":{"description":"Present when the request pinned a superseded version: the date the version stops working and requests begin returning `400` (`YYYY-MM-DD`).","schema":{"type":"string","format":"date"}}},"exampleType":"examples"},"c759074d-eb85-4b04-a64f-80649d597467":{"description":"`CREDITS_EXHAUSTED` — the caller's team has no credits left, or none granted yet. Only API-key and MCP requests are capped.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","NOT_FOUND","UNAUTHORIZED","DATABASE_ERROR","UNKNOWN_FILTER","FILTER_VALIDATION_ERROR","UNSUPPORTED_OPERATOR","FILTER_PARSE_ERROR","QUERY_TIMEOUT","INTERNAL_SERVER_ERROR","INVALID_ENTITY_ID","PAGINATION_DEPTH_EXCEEDED","SCHEMA_ERROR","FORBIDDEN","EXTERNAL_SERVICE_ERROR","ACCOUNT_REQUIRED","PREMIUM_REQUIRED","INSTANCE_ACCESS_REQUIRED","SERVICE_UNAVAILABLE","RATE_LIMITED","CREDITS_EXHAUSTED","SUBSCRIPTION_ENDED","SEAT_REQUIRED","KEY_CREATOR_NOT_ENTITLED","ACTIVE_TEAM_CHANGED","LIST_LOCKED","PATH_RENAMED","ENDPOINT_REMOVED"],"description":"Stable machine-readable error code.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","isRequired":true,"uniqueKey":"error.details.oneOf.0.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.oneOf.0.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"uniqueKey":"error.details.oneOf.0.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details.oneOf.0","typeLabel":"object[]"},{"type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"error.details.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"error.details.oneOf.1.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"error.details.oneOf.1.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"error.details.oneOf.1.additionalProperties","typeLabel":"string | number | boolean"},"isRequired":true,"uniqueKey":"error.details.oneOf.1","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.details.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[] | object | null"}},"required":["code","message","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"VALIDATION_ERROR","message":"\u003cstring>","details":[{"path":"\u003cstring>","message":"\u003cstring>"}]}}}},"exampleType":"generated"}},"headers":{"X-Credits-Used":{"description":"Credits this request consumed, under the current credit schedule. Present on every response to an API-key request under `/data`, `/analytics` and `/reference`; `0` on an error response or a free endpoint. Absent when the request was not authenticated with an API key (so never on a `401`), or on unmetered endpoints. During open beta credits are drawn from the team's balance but not billed.","schema":{"type":"integer","minimum":0},"example":25}},"exampleType":"generated"},"c90b063c-38b5-4cb9-bdaa-85e068f2ed15":{"description":"Authentication succeeded but the caller's token does not include the permission required for this operation, or (`SUBSCRIPTION_ENDED`) the API key's team subscription has ended, or (`KEY_CREATOR_NOT_ENTITLED`) the API key's creator no longer has a Premium+ seat or an admin role in its team, or (`SEAT_REQUIRED`) the caller needs a Premium+ seat.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","NOT_FOUND","UNAUTHORIZED","DATABASE_ERROR","UNKNOWN_FILTER","FILTER_VALIDATION_ERROR","UNSUPPORTED_OPERATOR","FILTER_PARSE_ERROR","QUERY_TIMEOUT","INTERNAL_SERVER_ERROR","INVALID_ENTITY_ID","PAGINATION_DEPTH_EXCEEDED","SCHEMA_ERROR","FORBIDDEN","EXTERNAL_SERVICE_ERROR","ACCOUNT_REQUIRED","PREMIUM_REQUIRED","INSTANCE_ACCESS_REQUIRED","SERVICE_UNAVAILABLE","RATE_LIMITED","CREDITS_EXHAUSTED","SUBSCRIPTION_ENDED","SEAT_REQUIRED","KEY_CREATOR_NOT_ENTITLED","ACTIVE_TEAM_CHANGED","LIST_LOCKED","PATH_RENAMED","ENDPOINT_REMOVED"],"description":"Stable machine-readable error code.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","isRequired":true,"uniqueKey":"error.details.oneOf.0.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.oneOf.0.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"uniqueKey":"error.details.oneOf.0.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details.oneOf.0","typeLabel":"object[]"},{"type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"error.details.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"error.details.oneOf.1.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"error.details.oneOf.1.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"error.details.oneOf.1.additionalProperties","typeLabel":"string | number | boolean"},"isRequired":true,"uniqueKey":"error.details.oneOf.1","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.details.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[] | object | null"}},"required":["code","message","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"FORBIDDEN","message":"You do not have permission to perform this action.","details":null}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"FORBIDDEN","message":"You do not have permission to perform this action.","details":null}}}},"exampleType":"examples"}},"headers":{"X-Credits-Used":{"description":"Credits this request consumed, under the current credit schedule. Present on every response to an API-key request under `/data`, `/analytics` and `/reference`; `0` on an error response or a free endpoint. Absent when the request was not authenticated with an API key (so never on a `401`), or on unmetered endpoints. During open beta credits are drawn from the team's balance but not billed.","schema":{"type":"integer","minimum":0},"example":25},"Deprecation":{"description":"Present when the request pinned a superseded version: the date that version was deprecated (`YYYY-MM-DD`).","schema":{"type":"string","format":"date"}},"Sunset":{"description":"Present when the request pinned a superseded version: the date the version stops working and requests begin returning `400` (`YYYY-MM-DD`).","schema":{"type":"string","format":"date"}}},"exampleType":"examples"},"2db1fafa-7d16-4360-8b57-23bfa1aee826":{"description":"Rate limit exceeded.","headers":{"X-Credits-Used":{"description":"Credits this request consumed, under the current credit schedule. Present on every response to an API-key request under `/data`, `/analytics` and `/reference`; `0` on an error response or a free endpoint. Absent when the request was not authenticated with an API key (so never on a `401`), or on unmetered endpoints. During open beta credits are drawn from the team's balance but not billed.","schema":{"type":"integer","minimum":0},"example":25},"Deprecation":{"description":"Present when the request pinned a superseded version: the date that version was deprecated (`YYYY-MM-DD`).","schema":{"type":"string","format":"date"}},"Sunset":{"description":"Present when the request pinned a superseded version: the date the version stops working and requests begin returning `400` (`YYYY-MM-DD`).","schema":{"type":"string","format":"date"}},"Retry-After":{"schema":{"type":"string","description":"Seconds to wait before retrying.","example":"1"},"required":true,"description":"Seconds to wait before retrying."}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","NOT_FOUND","UNAUTHORIZED","DATABASE_ERROR","UNKNOWN_FILTER","FILTER_VALIDATION_ERROR","UNSUPPORTED_OPERATOR","FILTER_PARSE_ERROR","QUERY_TIMEOUT","INTERNAL_SERVER_ERROR","INVALID_ENTITY_ID","PAGINATION_DEPTH_EXCEEDED","SCHEMA_ERROR","FORBIDDEN","EXTERNAL_SERVICE_ERROR","ACCOUNT_REQUIRED","PREMIUM_REQUIRED","INSTANCE_ACCESS_REQUIRED","SERVICE_UNAVAILABLE","RATE_LIMITED","CREDITS_EXHAUSTED","SUBSCRIPTION_ENDED","SEAT_REQUIRED","KEY_CREATOR_NOT_ENTITLED","ACTIVE_TEAM_CHANGED","LIST_LOCKED","PATH_RENAMED","ENDPOINT_REMOVED"],"description":"Stable machine-readable error code.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","isRequired":true,"uniqueKey":"error.details.oneOf.0.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.oneOf.0.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"uniqueKey":"error.details.oneOf.0.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details.oneOf.0","typeLabel":"object[]"},{"type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"error.details.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"error.details.oneOf.1.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"error.details.oneOf.1.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"error.details.oneOf.1.additionalProperties","typeLabel":"string | number | boolean"},"isRequired":true,"uniqueKey":"error.details.oneOf.1","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.details.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[] | object | null"}},"required":["code","message","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"RATE_LIMITED","message":"Rate limit exceeded — retry after the delay in the `Retry-After` header.","details":null}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"RATE_LIMITED","message":"Rate limit exceeded — retry after the delay in the `Retry-After` header.","details":null}}}},"exampleType":"examples"}},"exampleType":"examples"},"56932a5c-2d3a-4b36-8eea-8a540f7f13b5":{"description":"`SERVICE_UNAVAILABLE` — the caller's team credits could not be checked. Retry shortly.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","NOT_FOUND","UNAUTHORIZED","DATABASE_ERROR","UNKNOWN_FILTER","FILTER_VALIDATION_ERROR","UNSUPPORTED_OPERATOR","FILTER_PARSE_ERROR","QUERY_TIMEOUT","INTERNAL_SERVER_ERROR","INVALID_ENTITY_ID","PAGINATION_DEPTH_EXCEEDED","SCHEMA_ERROR","FORBIDDEN","EXTERNAL_SERVICE_ERROR","ACCOUNT_REQUIRED","PREMIUM_REQUIRED","INSTANCE_ACCESS_REQUIRED","SERVICE_UNAVAILABLE","RATE_LIMITED","CREDITS_EXHAUSTED","SUBSCRIPTION_ENDED","SEAT_REQUIRED","KEY_CREATOR_NOT_ENTITLED","ACTIVE_TEAM_CHANGED","LIST_LOCKED","PATH_RENAMED","ENDPOINT_REMOVED"],"description":"Stable machine-readable error code.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"path":{"type":"string","isRequired":true,"uniqueKey":"error.details.oneOf.0.items.[INDEX].path","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.details.oneOf.0.items.[INDEX].message","typeLabel":"string"}},"required":["path","message"],"uniqueKey":"error.details.oneOf.0.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"error.details.oneOf.0","typeLabel":"object[]"},{"type":"object","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"error.details.oneOf.1.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"number","uniqueKey":"error.details.oneOf.1.additionalProperties.oneOf.1","typeLabel":"number"},{"type":"boolean","uniqueKey":"error.details.oneOf.1.additionalProperties.oneOf.2","typeLabel":"boolean"}],"uniqueKey":"error.details.oneOf.1.additionalProperties","typeLabel":"string | number | boolean"},"isRequired":true,"uniqueKey":"error.details.oneOf.1","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"error.details.oneOf.2","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.details","typeLabel":"object[] | object | null"}},"required":["code","message","details"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","details":null}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"SERVICE_UNAVAILABLE","message":"The service is temporarily unavailable.","details":null}}}},"exampleType":"examples"}},"headers":{"X-Credits-Used":{"description":"Credits this request consumed, under the current credit schedule. Present on every response to an API-key request under `/data`, `/analytics` and `/reference`; `0` on an error response or a free endpoint. Absent when the request was not authenticated with an API key (so never on a `401`), or on unmetered endpoints. During open beta credits are drawn from the team's balance but not billed.","schema":{"type":"integer","minimum":0},"example":25}},"exampleType":"examples"}},"security":{"4330b31d-3b20-4bdd-ab1f-c0f39c0d4a89":{"oauth2":{"type":"oauth2","description":"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.","flows":{"clientCredentials":{"tokenUrl":"https://accounts.dealroom.co/oauth/token","scopes":{"read:entities":"Grant the read:entities permission","read:transactions":"Grant the read:transactions permission","read:valuations":"Grant the read:valuations permission","read:investors":"Grant the read:investors permission","read:founders":"Grant the read:founders permission","read:dimensions":"Grant the read:dimensions permission","read:timeseries":"Grant the read:timeseries permission","read:aggregate":"Grant the read:aggregate permission","read:funding-analytics":"Grant the read:funding-analytics permission","read:news":"Grant the read:news permission","read:jobs":"Grant the read:jobs permission","read:people":"Grant the read:people permission","read:search":"Grant the read:search permission"}}},"scopes":["read:funding-analytics"],"schemeName":"oauth2"}},"de45fcc8-03fe-4d7d-a66f-3e231bb1b32d":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Auth0 JWT access token. Paste a token obtained from your preferred OAuth2 flow. For machine-to-machine use, the OAuth2 client_credentials scheme below can mint a token directly from your `client_id` / `client_secret` inside the Swagger UI Authorize dialog.","scopes":["read:funding-analytics"],"schemeName":"bearerAuth"}}},"servers":{"d038cdb4-87ef-4aa3-a977-2306495e8d2e":{"url":"https://api.dealroom.app","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"oauth2","description":"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.","flows":{"clientCredentials":{"tokenUrl":"https://accounts.dealroom.co/oauth/token","scopes":{"read:entities":"Grant the read:entities permission","read:transactions":"Grant the read:transactions permission","read:valuations":"Grant the read:valuations permission","read:investors":"Grant the read:investors permission","read:founders":"Grant the read:founders permission","read:dimensions":"Grant the read:dimensions permission","read:timeseries":"Grant the read:timeseries permission","read:aggregate":"Grant the read:aggregate permission","read:funding-analytics":"Grant the read:funding-analytics permission","read:news":"Grant the read:news permission","read:jobs":"Grant the read:jobs permission","read:people":"Grant the read:people permission","read:search":"Grant the read:search permission"}}},"scopes":["read:funding-analytics"],"schemeName":"oauth2"},"schema":{"title":"OAuth2 Auth","type":"string","isRequired":true,"description":"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.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"oauth2","name":"Authorization"}],"title":"oauth2"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Auth0 JWT access token. Paste a token obtained from your preferred OAuth2 flow. For machine-to-machine use, the OAuth2 client_credentials scheme below can mint a token directly from your `client_id` / `client_secret` inside the Swagger UI Authorize dialog.","scopes":["read:funding-analytics"],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Auth0 JWT access token. Paste a token obtained from your preferred OAuth2 flow. For machine-to-machine use, the OAuth2 client_credentials scheme below can mint a token directly from your `client_id` / `client_secret` inside the Swagger UI Authorize dialog.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"dealroomco-prod","siteName":"Dealroom API","title":"Get funding heatmap - Dealroom API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T17:42:55.476Z","originalFileLocation":"api-reference/funding-analytics/get-funding-heatmap.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns a 2D matrix of funding data grouped by two configurable dimensions. Response format: - x_labels/y_labels: Ordered category labels for each axis - cells: Sparse array of [x_index, y_index, value] tuples - x_totals/y_totals: Marginal totals per axis value - grand_total: Sum of all cells Metrics: count (rounds), company_count (distinct entities), total_amount, avg_amount, median_amount. Amount metrics are returned in currency, in whole units. Dimensions: round_year, round_quarter, sector, country, continent, standardized_round, investor_type, and more.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Dealroom API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/dealroomco-prod/oYHTpbikhbb-4yLS/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/dealroomco-prod/oYHTpbikhbb-4yLS/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/dealroomco-prod/oYHTpbikhbb-4yLS/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/dealroomco-prod/oYHTpbikhbb-4yLS/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/dealroomco-prod/oYHTpbikhbb-4yLS/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/dealroomco-prod/oYHTpbikhbb-4yLS/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/dealroomco-prod/oYHTpbikhbb-4yLS/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/dealroomco-prod/oYHTpbikhbb-4yLS/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/dealroomco-prod/oYHTpbikhbb-4yLS/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get funding heatmap - Dealroom API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a 2D matrix of funding data grouped by two configurable dimensions. Response format: - x_labels/y_labels: Ordered category labels for each axis - cells: Sparse array of [x_index, y_index, value] tuples - x_totals/y_totals: Marginal totals per axis value - grand_total: Sum of all cells Metrics: count (rounds), company_count (distinct entities), total_amount, avg_amount, median_amount. Amount metrics are returned in currency, in whole units. Dimensions: round_year, round_quarter, sector, country, continent, standardized_round, investor_type, and more.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Dealroom API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.dealroom.co/api-reference/funding-analytics/get-funding-heatmap\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://dealroom.co/images/dealroom-og-image.png\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get funding heatmap - Dealroom API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a 2D matrix of funding data grouped by two configurable dimensions. Response format: - x_labels/y_labels: Ordered category labels for each axis - cells: Sparse array of [x_index, y_index, value] tuples - x_totals/y_totals: Marginal totals per axis value - grand_total: Sum of all cells Metrics: count (rounds), company_count (distinct entities), total_amount, avg_amount, median_amount. Amount metrics are returned in currency, in whole units. Dimensions: round_year, round_quarter, sector, country, continent, standardized_round, investor_type, and more.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://dealroom.co/images/dealroom-og-image.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/dealroomco-prod/oYHTpbikhbb-4yLS/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Dealroom API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3662e3\">\u003cmeta data-mint-head name=\"theme-color\" content=\"#3662e3\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.dealroom.co/api-reference/funding-analytics/get-funding-heatmap\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/funding-analytics/get-funding-heatmap.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.dealroom.co/#organization\",\"name\":\"Dealroom API\",\"url\":\"https://developers.dealroom.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/dealroomco-prod/zEUZ2Yv9dlQn_HmO/logo/light.svg?fit=max\u0026auto=format\u0026n=zEUZ2Yv9dlQn_HmO\u0026q=85\u0026s=0f85e2db91a5a2c18c140637b2088378\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.dealroom.co#website\",\"name\":\"Dealroom API\",\"url\":\"https://developers.dealroom.co\",\"publisher\":{\"@id\":\"https://developers.dealroom.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.dealroom.co/api-reference/funding-analytics/get-funding-heatmap#webpage\",\"url\":\"https://developers.dealroom.co/api-reference/funding-analytics/get-funding-heatmap\",\"name\":\"Get funding heatmap\",\"description\":\"Returns a 2D matrix of funding data grouped by two configurable dimensions. Response format: - x_labels/y_labels: Ordered category labels for each axis - cells: Sparse array of [x_index, y_index, value] tuples - x_totals/y_totals: Marginal totals per axis value - grand_total: Sum of all cells Metrics: count (rounds), company_count (distinct entities), total_amount, avg_amount, median_amount. Amount metrics are returned in currency, in whole units. Dimensions: round_year, round_quarter, sector, country, continent, standardized_round, investor_type, and more.\",\"dateModified\":\"2026-11-09T17:42:55.476Z\",\"isPartOf\":{\"@id\":\"https://developers.dealroom.co#website\"},\"breadcrumb\":{\"@id\":\"https://developers.dealroom.co/api-reference/funding-analytics/get-funding-heatmap#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.dealroom.co/api-reference/funding-analytics/get-funding-heatmap#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://developers.dealroom.co/endpoint-overviews/discovery\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Funding Analytics\",\"item\":\"https://developers.dealroom.co/endpoint-overviews/funding-analytics\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get funding heatmap\",\"item\":\"https://developers.dealroom.co/api-reference/funding-analytics/get-funding-heatmap\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.dealroom.co/api-reference/funding-analytics/get-funding-heatmap#apireference\",\"headline\":\"Get funding heatmap\",\"name\":\"Get funding heatmap\",\"description\":\"Returns a 2D matrix of funding data grouped by two configurable dimensions. Response format: - x_labels/y_labels: Ordered category labels for each axis - cells: Sparse array of [x_index, y_index, value] tuples - x_totals/y_totals: Marginal totals per axis value - grand_total: Sum of all cells Metrics: count (rounds), company_count (distinct entities), total_amount, avg_amount, median_amount. Amount metrics are returned in currency, in whole units. Dimensions: round_year, round_quarter, sector, country, continent, standardized_round, investor_type, and more.\",\"url\":\"https://developers.dealroom.co/api-reference/funding-analytics/get-funding-heatmap\",\"mainEntityOfPage\":{\"@id\":\"https://developers.dealroom.co/api-reference/funding-analytics/get-funding-heatmap#webpage\"},\"image\":\"https://dealroom.co/images/dealroom-og-image.png\",\"dateModified\":\"2026-11-09T17:42:55.476Z\",\"publisher\":{\"@id\":\"https://developers.dealroom.co/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.dealroom.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Dealroom API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Dealroom API","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","groups":[{"group":"Objects","pages":[{"title":"Company","href":"/objects/company"},{"title":"Person","href":"/objects/person"},{"title":"Investor","href":"/objects/investor"},{"title":"University","href":"/objects/university"},{"title":"Government \u0026 NGO","href":"/objects/gov-ngo"},{"title":"Entity (unified index)","href":"/objects/entity"},{"title":"Fund","href":"/objects/fund"},{"title":"Transaction","href":"/objects/transaction"},{"title":"Valuation","href":"/objects/valuation"},{"title":"News Article","href":"/objects/news-article"},{"title":"Job","href":"/objects/job"}]},{"group":"Endpoints","pages":[{"group":"Discovery","expanded":false,"pages":[{"title":"Discovery","href":"/endpoint-overviews/discovery"},{"title":"API Root Discovery","deprecated":null,"version":null,"openapi":"/openapi.yaml get /","href":"/api-reference/discovery/api-root-discovery"},{"title":"Analytics Namespace Discovery","deprecated":null,"version":null,"openapi":"/openapi.yaml get /analytics","href":"/api-reference/discovery/analytics-namespace-discovery"},{"title":"Data Namespace Discovery","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data","href":"/api-reference/discovery/data-namespace-discovery"},{"title":"Reference Namespace Discovery","deprecated":null,"version":null,"openapi":"/openapi.yaml get /reference","href":"/api-reference/discovery/reference-namespace-discovery"}]},{"group":"Entities","expanded":false,"pages":[{"title":"Entities","href":"/endpoint-overviews/entities"},{"title":"List entities","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/entities","href":"/api-reference/entities/list-entities"},{"title":"List entity geo points","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/entities/geo","href":"/api-reference/entities/list-entity-geo-points"},{"title":"Get single entity","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/entities/{id}","href":"/api-reference/entities/get-single-entity"}]},{"group":"Companies","expanded":false,"pages":[{"title":"Companies","href":"/endpoint-overviews/companies"},{"title":"List companies","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/companies","href":"/api-reference/companies/list-companies"},{"title":"List company map points","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/companies/geo","href":"/api-reference/companies/list-company-map-points"},{"title":"Get single company","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/companies/{id}","href":"/api-reference/companies/get-single-company"},{"title":"Get financials","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/companies/{id}/financials","href":"/api-reference/companies/get-financials"},{"title":"List funding rounds","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/companies/{id}/funding-rounds","href":"/api-reference/companies/list-funding-rounds"},{"title":"Get headcount","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/companies/{id}/headcount","href":"/api-reference/companies/get-headcount"},{"title":"Get headcount breakdown","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/companies/{id}/headcount-breakdown","href":"/api-reference/companies/get-headcount-breakdown"},{"title":"List investors","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/companies/{id}/investors","href":"/api-reference/companies/list-investors"},{"title":"List company patents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/companies/{id}/patents","href":"/api-reference/companies/list-company-patents"},{"title":"List similar companies","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/companies/{id}/similar","href":"/api-reference/companies/list-similar-companies"},{"title":"List company team members","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/companies/{id}/team","href":"/api-reference/companies/list-company-team-members"},{"title":"List valuations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/companies/{id}/valuations","href":"/api-reference/companies/list-valuations"},{"title":"Get web traffic","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/companies/{id}/web-traffic","href":"/api-reference/companies/get-web-traffic"},{"title":"Match companies by website and name","deprecated":null,"version":null,"openapi":"/openapi.yaml post /data/companies/matches","href":"/api-reference/companies/match-companies-by-website-and-name"}]},{"group":"Universities","expanded":false,"pages":[{"title":"Universities","href":"/endpoint-overviews/universities"},{"title":"List universities","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/universities","href":"/api-reference/universities/list-universities"},{"title":"List university map points","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/universities/geo","href":"/api-reference/universities/list-university-map-points"},{"title":"Get single university","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/universities/{id}","href":"/api-reference/universities/get-single-university"},{"title":"List alumni","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/universities/{id}/alumni","href":"/api-reference/universities/list-alumni"},{"title":"List university patents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/universities/{id}/patents","href":"/api-reference/universities/list-university-patents"},{"title":"List university team members","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/universities/{id}/team","href":"/api-reference/universities/list-university-team-members"}]},{"group":"Government \u0026 NGO","expanded":false,"pages":[{"title":"Government \u0026 NGO","href":"/endpoint-overviews/government-and-ngo"},{"title":"List government \u0026 NGO entities","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/gov-ngo","href":"/api-reference/government-\u0026-ngo/list-government-\u0026-ngo-entities"},{"title":"List government \u0026 NGO map points","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/gov-ngo/geo","href":"/api-reference/government-\u0026-ngo/list-government-\u0026-ngo-map-points"},{"title":"Get single government/NGO entity","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/gov-ngo/{id}","href":"/api-reference/government-\u0026-ngo/get-single-governmentngo-entity"},{"title":"List government \u0026 NGO patents","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/gov-ngo/{id}/patents","href":"/api-reference/government-\u0026-ngo/list-government-\u0026-ngo-patents"},{"title":"List government \u0026 NGO team members","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/gov-ngo/{id}/team","href":"/api-reference/government-\u0026-ngo/list-government-\u0026-ngo-team-members"}]},{"group":"Transactions","expanded":false,"pages":[{"title":"Transactions","href":"/endpoint-overviews/transactions"},{"title":"List transactions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/transactions","href":"/api-reference/transactions/list-transactions"},{"title":"Get single transaction","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/transactions/{id}","href":"/api-reference/transactions/get-single-transaction"}]},{"group":"Valuations","expanded":false,"pages":[{"title":"Valuations","href":"/endpoint-overviews/valuations"},{"title":"List valuations","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/valuations","href":"/api-reference/valuations/list-valuations"},{"title":"Get single valuation","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/valuations/{id}","href":"/api-reference/valuations/get-single-valuation"}]},{"group":"Investors","expanded":false,"pages":[{"title":"Investors","href":"/endpoint-overviews/investors"},{"title":"List investors","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/investors","href":"/api-reference/investors/list-investors"},{"title":"List investor map points","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/investors/geo","href":"/api-reference/investors/list-investor-map-points"},{"title":"Get single investor","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/investors/{id}","href":"/api-reference/investors/get-single-investor"},{"title":"List funds","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/investors/{id}/funds","href":"/api-reference/investors/list-funds"},{"title":"List LP fund positions","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/investors/{id}/lp-funds","href":"/api-reference/investors/list-lp-fund-positions"},{"title":"List portfolio companies","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/investors/{id}/portfolio","href":"/api-reference/investors/list-portfolio-companies"},{"title":"List similar investors","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/investors/{id}/similar","href":"/api-reference/investors/list-similar-investors"},{"title":"List investor team members","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/investors/{id}/team","href":"/api-reference/investors/list-investor-team-members"}]},{"group":"Funds","expanded":false,"pages":[{"title":"Funds","href":"/endpoint-overviews/funds"},{"title":"List funds","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/funds","href":"/api-reference/funds/list-funds"},{"title":"Get single fund","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/funds/{id}","href":"/api-reference/funds/get-single-fund"}]},{"group":"People","expanded":false,"pages":[{"title":"People","href":"/endpoint-overviews/people"},{"title":"List people","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/people","href":"/api-reference/people/list-people"},{"title":"Get single person","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/people/{id}","href":"/api-reference/people/get-single-person"},{"title":"List career history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/people/{id}/career","href":"/api-reference/people/list-career-history"},{"title":"List education","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/people/{id}/education","href":"/api-reference/people/list-education"}]},{"group":"Founders","expanded":false,"pages":[{"title":"Founders","href":"/endpoint-overviews/founders"},{"title":"List founders","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/founders","href":"/api-reference/founders/list-founders"},{"title":"Get single founder","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/founders/{id}","href":"/api-reference/founders/get-single-founder"},{"title":"List founded companies","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/founders/{id}/founded-companies","href":"/api-reference/founders/list-founded-companies"}]},{"group":"News","expanded":false,"pages":[{"title":"News","href":"/endpoint-overviews/news"},{"title":"List news articles","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/news","href":"/api-reference/news/list-news-articles"},{"title":"Get single news article","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/news/{id}","href":"/api-reference/news/get-single-news-article"}]},{"group":"Jobs","expanded":false,"pages":[{"title":"Jobs","href":"/endpoint-overviews/jobs"},{"title":"List job openings","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/jobs","href":"/api-reference/jobs/list-job-openings"},{"title":"Get single job opening","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/jobs/{id}","href":"/api-reference/jobs/get-single-job-opening"}]},{"group":"Aggregate","expanded":false,"pages":[{"title":"Aggregate","href":"/endpoint-overviews/aggregate"},{"title":"Aggregate by source","deprecated":null,"version":null,"openapi":"/openapi.yaml get /analytics/aggregate/{source}","href":"/api-reference/aggregate/aggregate-by-source"},{"title":"Multi-metric aggregate","deprecated":null,"version":null,"openapi":"/openapi.yaml get /analytics/aggregate/{source}/multi-metric","href":"/api-reference/aggregate/multi-metric-aggregate"}]},{"group":"Funding Analytics","expanded":false,"pages":[{"title":"Funding Analytics","href":"/endpoint-overviews/funding-analytics"},{"title":"Get funding funnel","description":"Cross-tabulates companies by total capital raised (9 buckets) against a chosen dimension.\n\n**Response format:**\n- `rows`: Array of `{ label, buckets: [count_per_bucket] }` (one per dimension value)\n- `bucket_labels`: Dollar-range labels for the 9 buckets\n- `bucket_group_labels`: Human-friendly stage names (Pre-Seed through Unicorn)\n- `companies_count_per_bucket`: Companies per bucket across all dimensions\n- `companies_count`: Companies across all buckets\n\n**Buckets:** $0-1M, $1-4M, $4-15M, $15-40M, $40-100M, $100-250M, $250M-1B, $1-2B, $2B+. Always in USD, whatever `currency` is; `currency` converts amount filters.","deprecated":null,"version":null,"openapi":"/openapi.yaml get /analytics/funding-analytics/funnel","href":"/api-reference/funding-analytics/get-funding-funnel"},{"title":"Get funding heatmap","deprecated":null,"version":null,"openapi":"/openapi.yaml get /analytics/funding-analytics/heatmap","href":"/api-reference/funding-analytics/get-funding-heatmap"},{"title":"Get round transitions","description":"Analyzes how companies move between funding stages over time.\n\n**Response format:**\n- `transitions`: From→to pairs with count and median days between stages\n- `time_between_rounds`: Per-stage median days to next round\n\n**Label types:**\n- `standardized`: Maps raw round types to standard labels (Seed, Series A, etc.)\n- `self_reported`: Uses raw round_type values as-is","deprecated":null,"version":null,"openapi":"/openapi.yaml get /analytics/funding-analytics/round-transitions","href":"/api-reference/funding-analytics/get-round-transitions"}]},{"group":"Timeseries","expanded":false,"pages":[{"title":"Timeseries","href":"/endpoint-overviews/timeseries"},{"title":"Timeseries","deprecated":null,"version":null,"openapi":"/openapi.yaml get /analytics/timeseries","href":"/api-reference/timeseries/timeseries"}]},{"group":"Matching","expanded":false,"pages":[{"title":"Matching","href":"/endpoint-overviews/matching"},{"title":"Match investors","deprecated":null,"version":null,"openapi":"/openapi.yaml get /analytics/matching/investors","href":"/api-reference/matching/match-investors"}]},{"group":"Filters","expanded":false,"pages":[{"title":"Filters","href":"/endpoint-overviews/filters"},{"title":"List filters","deprecated":null,"version":null,"openapi":"/openapi.yaml get /reference/filters","href":"/api-reference/filters/list-filters"},{"title":"Search filters and values","deprecated":null,"version":null,"openapi":"/openapi.yaml get /reference/filters/search","href":"/api-reference/filters/search-filters-and-values"},{"title":"List filter values","deprecated":null,"version":null,"openapi":"/openapi.yaml get /reference/filters/{key}/values","href":"/api-reference/filters/list-filter-values"}]},{"group":"Health","expanded":false,"pages":[{"title":"Health","href":"/endpoint-overviews/health"},{"title":"Check API health","deprecated":null,"version":null,"openapi":"/openapi.yaml get /health","href":"/api-reference/health/check-api-health"}]},{"group":"Search","expanded":false,"pages":[{"title":"Search","href":"/endpoint-overviews/search"},{"title":"Search entities","deprecated":null,"version":null,"openapi":"/openapi.yaml get /data/search","href":"/api-reference/search/search-entities"}]}]}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Get funding heatmap - Dealroom API","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}