> ## Documentation Index
> Fetch the complete documentation index at: https://developers.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) 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 /mintlify/openapi.yaml get /api/analytics/aggregate/{source}
openapi: 3.1.0
info:
  title: Dealroom API
  version: '2026-07-06'
  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-next.dealroom.co
    description: Production
  - url: https://api-next.beta.dealroom.co
    description: Beta
  - url: https://api-next.staging.dealroom.dev
    description: Staging
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, and investors.
  - name: Funding Analytics
    description: 'Purpose-built analytics: 2D heatmaps, round transitions, capital funnels.'
  - name: Timeseries
    description: Yearly entity metrics (employees, revenue, valuation).
  - name: Matching
    description: >-
      Investor matching tool: ranked investor recommendations for a given deal
      profile.
  - name: Filters
    description: >-
      Filter registry discovery and value lookup. Use `/api/reference/filters`
      to discover available filters per scope and
      `/api/reference/filters/:key/values` to look up valid values.
  - name: Account
    description: User profile, authentication introspection, and account settings.
  - name: API Keys
    description: >-
      Self-service API key management. Programmatic (M2M) keys for server-side
      and Application (PKCE) keys for browser SPAs.
  - name: Teams
    description: Team membership and invitation management.
  - name: Usage
    description: Request-count usage analytics per API key for billing and introspection.
  - name: Metrics
    description: >-
      Service observability metrics (OpenTelemetry configuration and runtime
      counters).
  - name: Health
    description: Liveness probe (public, unauthenticated).
  - name: Search
    description: >-
      Cross-resource fuzzy search across companies, investors, people,
      universities, and government & NGO bodies.
  - name: Ecosystems
    description: >-
      Curated entity collections that can be filtered, navigated, and compared.
      Includes nested landscape resources.
  - name: Landscapes
    description: Saved entity lists within an ecosystem (e.g. "top fintech in NL").
  - name: Enhancement Requests
    description: User-submitted profile data corrections routed to Dealroom Data Support.
paths:
  /api/analytics/aggregate/{source}:
    get:
      tags:
        - Aggregate
      summary: Aggregate by source
      description: >-
        Query a specific source (founders, investors, companies, funding-rounds,
        valuations) 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)
            example: founders
          required: true
          name: source
          in: path
        - schema:
            type: string
            description: >-
              ISO 4217 currency code for monetary field conversion. Defaults to
              USD.
            example: EUR
          required: false
          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
          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. Relationship fields:
              university.name, employer.city. Multi-dim: year,hq_country
            example: hq_country
          required: true
          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
          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
          name: sort
          in: query
        - schema:
            type: string
            description: Number of results to return (1-500, default 25)
            example: '25'
          required: false
          name: limit
          in: query
      responses:
        '200':
          description: Aggregated results
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AggregateResponse'
        '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'
        '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'
        '422':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - oauth2:
            - read:aggregate
        - bearerAuth:
            - read:aggregate
components:
  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
            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
  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.
      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:ecosystems: Grant the read:ecosystems permission
            write:ecosystems: Grant the write:ecosystems permission
            delete:ecosystems: Grant the delete:ecosystems permission
            write:landscapes: Grant the write:landscapes permission
            delete:landscapes: Grant the delete:landscapes permission
            read:metrics: Grant the read:metrics permission
            create:api-keys: Grant the create:api-keys permission
            read:api-keys: Grant the read:api-keys permission
            delete:api-keys: Grant the delete:api-keys permission
            admin:api-keys: Grant the admin:api-keys permission
            read:usage: Grant the read:usage permission
            read:news: Grant the read:news permission
            read:jobs: Grant the read:jobs permission
            read:people: Grant the read:people permission
            read:teams: Grant the read:teams permission
            write:teams: Grant the write:teams permission
            delete:teams: Grant the delete:teams permission
            manage:team-members: Grant the manage:team-members permission
            read:search: Grant the read:search permission
            write:ai-features: Grant the write:ai-features permission

````