DocsAPIMetrics

List metrics for a company

Returns metrics for a given company. By default the computed view: the same figures the app shows, one value per metric and period, reconciled across sources and including rolled-up periods and derived metrics (each marked by value_type). Pass computed_view=false for the raw stored data points only.

GET
/metrics
Query Params

Maximum number of results (1-1000, default: 500)

Example: 500

Number of results to skip (default: 0)

Example: 0

Company ID (required)

Example: 42

Filter by metric name. E.g. arr, gmv, billedArr, contractedArr, cashBalance, revenue, burnRate, ebitda, headcount, enps, grossMargin, grossProfit, etc.

Example: revenue

Filter by period type (month, quarter, year, custom)

Example: month

true (default): the company's financials as shown in the app – one value per metric and period, reconciled across sources, with rolled-up periods and derived metrics; see value_type. false: every stored data point as it was reported, including the ones a better source overrides.

Example: true

Credentials

Bearer
curl -X GET "https://api.fundra.com/v1/metrics?company_id=42&name=revenue&period_type=month&computed_view=true" \
  -H "Authorization: Bearer <token>"

Successfully retrieved metrics

{
  "data": [
    {
      "id": "1",
      "company_id": "42",
      "name": "revenue",
      "value": 1500000,
      "currency": "USD",
      "period_type": "month",
      "period_label": "2024-Jan",
      "period_start": "2024-01-01",
      "period_end": "2024-01-31",
      "period_sort_num": 202401,
      "is_selected": true,
      "source_id": null,
      "source_file_id": "V1StGXR8Z5jd",
      "created_at": "2024-01-15T10:00:00Z",
      "value_type": "reported",
      "is_conflicting": false,
      "alternatives_count": 0
    }
  ],
  "pagination": {
    "total": 200,
    "limit": 100,
    "offset": 0
  }
}

Previous

List metric namesGET

Next

Insert metrics for a companyPOST