Skip to main content
GET
Multi-metric aggregate

Authorizations

Authorization
string
header
required

OAuth2 client-credentials flow against the Dealroom Auth0 tenant. Use the client_id / client_secret from a Programmatic API key. Tokens are valid for 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.

Headers

API-Version
string<date>

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.

Example:

"2026-09-01"

Path Parameters

source
enum<string>
required

The source to aggregate

Available options:
founders,
investors,
companies,
funding-rounds,
valuations,
entities,
fundings
Example:

"companies"

Query Parameters

currency
string

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

Example:

"EUR"

metric
required

Metric definition: label,metric_type. Repeat for multiple metrics. Types: count, count_distinct:field, sum:field, avg:field, median:field, p25:field, p75:field, percentage:numerator_label/denominator_label. Example: metric=total,count&metric=unicorns,count&metric=pct,percentage:unicorns/total

Minimum string length: 1
Example:

"total,count"

metric_filter

Per-metric filter expression: :<filter_expression>. Example: metric_filter=unicorns:is_unicorn[eq]:true

Minimum string length: 1
Example:

"unicorns:is_unicorn[eq]:true"

metric_having

Post-aggregation filter: [op]:. Operators: gt, gte, lt, lte, eq, neq. Only valid with group_by. Example: metric_having=percentage[gt]:25

Minimum string length: 1
Example:

"percentage[gt]:25"

group_by
string

Dimension(s) to group by, comma-separated. Omit for flat aggregation. Includes map_area — the startup-map choropleth dimension (requires an active ecosystem); its per-entity dots counterpart is GET /data/{companies|investors|universities}/geo.

Minimum string length: 1
Pattern: ^[a-z][a-z0-9_.]*(?:,[a-z][a-z0-9_.]*)*$
Example:

"hq_country"

filter
string

Filter expression: and(key[op]:value,...), or(...). Example: and(tag_id[eq]:42,launch_year[gte]:2020)

Example:

"and(tag_id[eq]:42,launch_year[gte]:2020)"

sort
string

Sort by metric label or 'dimension'. Prefix with - for descending

Pattern: ^-?[a-z][a-z0-9_]*$
Example:

"-total"

limit
string

Number of results to return (1-500, default 25)

Example:

"25"

Response

Multi-metric results (grouped or flat depending on group_by)

data
object[]
required
query_info
object
required
currency
string
required