GET
/
metrics
/
Get metrics
curl --request GET \
  --url https://api.standardmetrics.io/v1/metrics/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "next": "<string>",
  "previous": "<string>",
  "results": [
    {
      "id": "<string>",
      "value": "<string>",
      "currency": "<string>",
      "converted_value": "<string>",
      "preferred_currency": "<string>",
      "date": "2023-11-07T05:31:56Z",
      "category": "<string>",
      "category_type": "<string>",
      "category_id": "<string>",
      "cadence": "<string>",
      "is_budget_metric": "<string>",
      "budget_id": "<string>",
      "custom_metric": "<string>",
      "fx_rate": "<string>",
      "detailed_source": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "company_id": "<string>",
      "deleted_at": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Your valid bearer token. All Auth tokens persist for all requests. Make sure to replace Client Credential Basic tokens with Bearer tokens after retrieving your bearer token. Go to the API Reference/Setup, User Guides/Initial Setup, or API Reference/Get API Access Token page to get your token.

Query Parameters

​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

​
company_slug
string

The slug that uniquely identifies the company whose metrics' to request. You can find the slug for a company by going to that company's portfolio page, and then the last portion of the URL will be the unique slug for said company. For example: in the url: app.standardmetrics.io/venture/fund-slug/portfolio/example-slug/, "example-slug" would the the slug. You can also make a request to the /companies endpoint to get a list of all your firm's companies and their slugs. <b>Either the company_slug or company_id parameter must be passed to this endpoint.</b>

​
company_id
string

The id for the company whose metrics' to request. You can get a company's id by making a request to the /companies endpoint. <b>Either the company_slug or company_id parameter must be passed to this endpoint.</b>

​
from
string

The from date (inclusive) from which to query metrics for as an ISO 8601 formatted date

​
to
string

The to date (inclusive) from which to query metrics until as an ISO 8601 formatted date

​
category
string

The category of metric to request. If not specified, datums of all category types will be returned. This parameter can be passed multiple times to filter for multiple specific categories. Category options include: "custom_document", "custom", "cash_in_bank", "net_burn", "runway", "revenue", "gross_margin", "total_operating_expenses", "net_income", "cost_of_goods_sold", "gross_profit", "net_operating_profit", "net_other_income", "net_profit", "cap_table", "balance_sheet", "income_statement", "cash_flow_statement", "d_and_o_insurance", "cash_receipts", "cash_payments", "net_assets", "assets", "liabilities", "equity", "headcount", "budget", "ebitda"

​
budget_id
string

A budget id for requesting budget metrics. See the /budgets endpoint for more information about how to get budget ids

​
updated_at_from
string<date-time>

The from date (inclusive) from which to query updated_at as an ISO 8601 formatted date

​
updated_at_to
string<date-time>

The to date (inclusive) from which to query updated_at as an ISO 8601 formatted date

​
include_deleted
enum<string>

Set to '1' if you want to include deleted metrics.

Available options:
1
​
include_budgets
enum<string>

Set to "1" if you want budget metrics to be returned as well.

Available options:
1
​
cadence
string

The cadence type of the metrics to request. Cadence options include: "point_in_time", "day", "week", "month", "quarter", "half_year", "year"

​
custom_metric
string

The name of the custom metric for which you want to query for. Your custom metric names can be accessed via the /custom-metrics endpoint. Note that if you filter by a category that is not "custom", no data will come back.

​
sort_by
string

The field to sort your query by. Currently, created_at is the only supported field. To sort in descending order, prepend the field you're sorting by with a -. Ascending order is implied, but you can also prepend the field you're sorting by with + to sort in ascending order. E.g. to sort by created_at in ascending order use "sort_by=-created_at" and to sort by created_at in descending order use "sort_by=+created_at" or just "sort_by=created_at".

Response

200 - application/json

The response is of type object.