> ## Documentation Index > Fetch the complete documentation index at: https://developers.beta.dealroom.co/llms.txt > Use this file to discover all available pages before exploring further. # Aggregate by source > Query a specific source (founders, investors, companies, funding-rounds, valuations, entities, fundings) with structured filter syntax. **Filter syntax** (`filter` param): - Single filter: `filter=key[op]:value` - AND: `filter=and(key1[op]:val1,key2[op]:val2)` - OR: `filter=or(key1[op]:val1,key2[op]:val2)` - Nested: `filter=and(tag_id[eq]:42,or(hq_location[eq]:81,hq_location[eq]:74))` **Available operators:** `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `in_any`, `nin_any`, `in_all`, `nin_all` `in_all` / `nin_all` are only exposed on repeated related-record filters. **Filter types:** - Direct: `launch_year[gte]:2020`, `total_funding[gt]:1000000`, `is_unicorn[eq]:true` - Location: `hq_location[eq]:81`, `hq_location[in_any]:1234|5678` (also `founding_location`, `office_location`, `founding_or_hq_location`) - Tag: `tag_id[eq]:42`, `tag_id[nin_any]:99` - Region: `region[eq]:123` **Examples:** - Count by country with tag: `?metric=count&group_by=hq_country&filter=tag_id[eq]:42` - Funded startups by year: `?metric=count&group_by=launch_year&filter=and(is_funded[eq]:true,launch_year[gte]:2015)` - Multi-dim: `?metric=sum:amount&group_by=year,hq_country` ## OpenAPI ````yaml /openapi.yaml get /analytics/aggregate/{source} openapi: 3.1.0 info: title: Dealroom API version: '2026-09-01' description: >- REST API for the Dealroom platform — companies, funds, founders, investors, funding rounds, valuations, taxonomy, news, and aggregate analytics across all of them. Authentication uses Auth0 (Bearer JWT or OAuth2 client_credentials). All endpoints are versioned via the `API-Version` header (Stripe-style date-based versioning). contact: name: Dealroom API support email: support@dealroom.co url: https://dealroom.co termsOfService: https://dealroom.co/terms license: name: Proprietary — Dealroom commercial license url: https://dealroom.co/terms servers: - url: https://api.beta.dealroom.app description: Beta security: - bearerAuth: [] - oauth2: [] tags: - name: Discovery description: API root discovery and functional namespaces. - name: Entities description: >- Companies, investors, people, universities, and other organisations. Filter, sort, and paginate the unified entity index. The term `investor` refers to the investment firm; `fund` refers to the capital vehicle it raises. - name: Companies description: >- Company profiles — the `organization_subtype = company` subset of entities (excludes investors, universities, and gov/NGOs). Same response shape as the entity index, scoped to companies. - name: Universities description: >- University profiles — the `organization_subtype = university` subset of entities. The `university` sub-object carries alumni metrics. - name: Government & NGO description: >- Government bodies and NGOs — the `organization_subtype = gov_ngo` subset of entities. - name: Transactions description: >- Funding rounds, equity events, debt, grants, exits, and other company-level financial events. - name: Valuations description: Company valuation history by year and month. - name: Investors description: >- Investor profiles (VCs, corporates, angels, family offices, governments). Subset of entities where `is_investor = true`. An investor is the firm that makes investments; the capital vehicles it raises are funds available via `/investors/{id}/funds`. - name: Funds description: >- Funds — the capital vehicles investor firms raise (e.g. "Fund III", $200M, 2024). Browse/filter by manager, type, size, and vintage; each fund links to its manager (GP). Fund size (`amount`) converts to the requested `?currency=` (default USD); `amount_source` carries the original native-currency amount. - name: People description: >- Person profiles (founders, executives, angels, and others). Subset of entities where `entity_type = 'person'`. Same response shape as founders, with company associations, education, and backgrounds. - name: Founders description: >- Founder profiles with company associations and education history. Subset of entities where `is_founder = true`. - name: News description: Curated news articles about companies, funds, deals, sectors, and events. - name: Jobs description: Active job openings posted by companies, with hiring-trend signals. - name: Aggregate description: >- Composable single- and multi-metric aggregations across companies, funding rounds, valuations, founders, investors, entities, and fundings. - name: Timeseries description: Yearly entity metrics (employees, revenue, valuation). - name: Filters description: >- Filter registry discovery and value lookup. Use `/reference/filters` to discover available filters per scope and `/reference/filters/:key/values` to look up valid values. - name: Health description: Liveness probe (public, unauthenticated). - name: Search description: >- Cross-resource fuzzy search across companies, investors, people, universities, and government & NGO bodies. paths: /analytics/aggregate/{source}: get: tags: - Aggregate summary: Aggregate by source description: >- Query a specific source (founders, investors, companies, funding-rounds, valuations, entities, fundings) with structured filter syntax. **Filter syntax** (`filter` param): - Single filter: `filter=key[op]:value` - AND: `filter=and(key1[op]:val1,key2[op]:val2)` - OR: `filter=or(key1[op]:val1,key2[op]:val2)` - Nested: `filter=and(tag_id[eq]:42,or(hq_location[eq]:81,hq_location[eq]:74))` **Available operators:** `eq`, `neq`, `gt`, `gte`, `lt`, `lte`, `in_any`, `nin_any`, `in_all`, `nin_all` `in_all` / `nin_all` are only exposed on repeated related-record filters. **Filter types:** - Direct: `launch_year[gte]:2020`, `total_funding[gt]:1000000`, `is_unicorn[eq]:true` - Location: `hq_location[eq]:81`, `hq_location[in_any]:1234|5678` (also `founding_location`, `office_location`, `founding_or_hq_location`) - Tag: `tag_id[eq]:42`, `tag_id[nin_any]:99` - Region: `region[eq]:123` **Examples:** - Count by country with tag: `?metric=count&group_by=hq_country&filter=tag_id[eq]:42` - Funded startups by year: `?metric=count&group_by=launch_year&filter=and(is_funded[eq]:true,launch_year[gte]:2015)` - Multi-dim: `?metric=sum:amount&group_by=year,hq_country` operationId: sourceAggregate parameters: - schema: type: string enum: - founders - investors - companies - funding-rounds - valuations - entities - fundings description: >- The source to aggregate (founders, investors, companies, funding-rounds, valuations, entities, fundings) example: founders required: true description: >- The source to aggregate (founders, investors, companies, funding-rounds, valuations, entities, fundings) name: source in: path - schema: type: string description: >- ISO 4217 currency code for monetary field conversion. Defaults to USD. example: EUR required: false description: >- ISO 4217 currency code for monetary field conversion. Defaults to USD. name: currency in: query - schema: type: string minLength: 1 description: >- Metric to compute: count, count_distinct:field, sum:field, avg:field, median:field, p25:field, p75:field example: count required: true description: >- Metric to compute: count, count_distinct:field, sum:field, avg:field, median:field, p25:field, p75:field name: metric in: query - schema: type: string minLength: 1 pattern: ^[a-z][a-z0-9_.]*(?:,[a-z][a-z0-9_.]*)*$ description: >- Dimension(s) to group by. Location dims: hq_country, hq_city, hq_state, hq_continent, macro_region, region. Ecosystem map areas: map_area — the startup-map choropleth dimension (counts per polygon; requires an active ecosystem, else a validation error). Pair it with the per-entity map dots at GET /data/{companies|investors|universities}/geo. Relationship fields: university.name, employer.city. Multi-dim: year,hq_country example: hq_country required: true description: >- Dimension(s) to group by. Location dims: hq_country, hq_city, hq_state, hq_continent, macro_region, region. Ecosystem map areas: map_area — the startup-map choropleth dimension (counts per polygon; requires an active ecosystem, else a validation error). Pair it with the per-entity map dots at GET /data/{companies|investors|universities}/geo. Relationship fields: university.name, employer.city. Multi-dim: year,hq_country name: group_by in: query - schema: type: string description: >- Filter expression using structured syntax: and(key[op]:value,...), or(...). Example: and(tag_id[eq]:42,hq_location[eq]:81) example: and(tag_id[eq]:42,launch_year[gte]:2020) required: false description: >- Filter expression using structured syntax: and(key[op]:value,...), or(...). Example: and(tag_id[eq]:42,hq_location[eq]:81) name: filter in: query - schema: type: string pattern: ^-?[a-z][a-z0-9_]*$ description: Sort by metric key or 'dimension'. Prefix with - for descending example: '-count' required: false description: Sort by metric key or 'dimension'. Prefix with - for descending name: sort in: query - schema: type: string description: Number of results to return (1-500, default 25) example: '25' required: false description: Number of results to return (1-500, default 25) name: limit in: query - $ref: '#/components/parameters/ApiVersion' responses: '200': description: Aggregated results content: application/json: schema: $ref: '#/components/schemas/AggregateResponse' headers: Deprecation: $ref: '#/components/headers/Deprecation' Sunset: $ref: '#/components/headers/Sunset' '401': description: >- Authentication required. The `Authorization` header was missing, the bearer token was malformed, or the token failed signature / expiry validation. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: UNAUTHORIZED message: Authentication required — provide a valid bearer token. headers: Deprecation: $ref: '#/components/headers/Deprecation' Sunset: $ref: '#/components/headers/Sunset' '403': description: >- Authentication succeeded but the caller's token does not include the permission required for this operation. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: FORBIDDEN message: You do not have permission to perform this action. headers: Deprecation: $ref: '#/components/headers/Deprecation' Sunset: $ref: '#/components/headers/Sunset' '422': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: FILTER_PARSE_ERROR message: >- The request could not be processed — check the filter syntax and any identifiers. headers: Deprecation: $ref: '#/components/headers/Deprecation' Sunset: $ref: '#/components/headers/Sunset' '429': description: Rate limit exceeded. headers: Deprecation: $ref: '#/components/headers/Deprecation' Sunset: $ref: '#/components/headers/Sunset' 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: $ref: '#/components/schemas/ErrorResponse' example: error: code: RATE_LIMITED message: >- Rate limit exceeded — retry after the delay in the `Retry-After` header. security: - oauth2: - read:aggregate - bearerAuth: - read:aggregate components: parameters: ApiVersion: name: API-Version in: header required: false schema: type: string format: date example: '2026-09-01' description: >- Pin a Stripe-style date-based API version (`YYYY-MM-DD`). Omit to use the latest version (`2026-09-01`). A pinned version is supported for 30 days after it is superseded, after which it returns `400`. schemas: AggregateResponse: type: object properties: data: type: array items: type: object additionalProperties: anyOf: - type: string - type: number - type: 'null' query_info: type: object properties: source: type: string group_by: type: string metric: type: string total_groups: type: number required: - source - group_by - metric - total_groups currency: type: string required: - data - query_info - currency ErrorResponse: 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 - SERVICE_UNAVAILABLE - RATE_LIMITED - LIST_LOCKED - PATH_RENAMED - ENDPOINT_REMOVED description: Stable machine-readable error code. message: type: string details: anyOf: - type: array items: type: object properties: path: type: string message: type: string required: - path - message - type: object additionalProperties: anyOf: - type: string - type: number - type: boolean required: - code - message required: - error 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 securitySchemes: 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. 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 24h — 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: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 ````