Skip to main content
GET
/
api
/
timeseries
Timeseries — yearly metric aggregation
curl --request GET \
  --url https://api.example.com/api/timeseries \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "year": 123,
      "value": 123
    }
  ],
  "query_info": {
    "metric": "employees",
    "aggregation": "sum",
    "total_years": 123,
    "timing_ms": 123
  }
}

Authorizations

​
Authorization
string
header
required

Auth0 JWT access token

Query Parameters

​
metric
enum<string>
required

Metric to aggregate across years

Available options:
employees,
revenue_usd,
valuation_usd,
ebitda_usd,
vc_funding_usd
Example:

"revenue_usd"

​
aggregation
enum<string>
default:sum

Aggregation function to apply (default: sum)

Available options:
sum,
avg,
median,
count
Example:

"sum"

​
year_min
string

Minimum year (inclusive)

Pattern: ^\d+$
Example:

"2018"

​
year_max
string

Maximum year (inclusive)

Pattern: ^\d+$
Example:

"2024"

​
filter
string

Entity filter expression: key[op]:value. Same syntax as /api/aggregate/:source

Example:

"total_funding_usd[gte]:1000000"

Response

Yearly aggregated metric values

​
data
object[]
required
​
query_info
object
required