Aggregate data by source with structured filter syntax

curl --request GET \
  --url https://api-next.dealroom.co/api/aggregate/{source} \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {}
  ],
  "query_info": {
    "source": "<string>",
    "group_by": "<string>",
    "metric": "<string>",
    "total_groups": 123
  },
  "currency": "<string>"
}

Aggregate

Aggregate data by source with structured filter syntax

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(location[eq]:81,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: location[eq]:81, location[in_any]:1234|5678
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

GET

api

aggregate

{source}

Aggregate data by source with structured filter syntax

curl --request GET \
  --url https://api-next.dealroom.co/api/aggregate/{source} \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {}
  ],
  "query_info": {
    "source": "<string>",
    "group_by": "<string>",
    "metric": "<string>",
    "total_groups": 123
  },
  "currency": "<string>"
}

Authorizations

Authorization

string

header

required

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.

Path Parameters

source

enum<string>

required

The source to aggregate (founders, investors, companies, funding-rounds, valuations)

Available options:

founders,

investors,

companies,

funding-rounds,

valuations,

entities,

fundings

Example:

"founders"

Query Parameters

currency

string

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

Example:

"EUR"

metric

string

required

Metric to compute: count, count_distinct:field, sum:field, avg:field, median:field, p25:field, p75:field

Minimum string length: 1

Example:

"count"

group_by

string

required

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

Minimum string length: 1

Pattern: ^[a-z][a-z0-9_.]*(?:,[a-z][a-z0-9_.]*)*$

Example:

"hq_country"

filter

string

Filter expression using structured syntax: and(key[op]:value,...), or(...). Example: and(tag_id[eq]:42,location[eq]:81)

Example:

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

sort

string

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

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

Example:

"-count"

limit

string

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

Example:

"25"

Response

Aggregated results

data

object[]

required

Show child attributes

query_info

object

required

Show child attributes

currency

string

required

List valuations with filters Multiple metrics with per-metric filters in a single query

Documentation Index

Authorizations

Path Parameters

Query Parameters

Response