Standard Metrics

App · 24 actions

Read and update portfolio companies, financial metrics, notes and investment data.

Actions

ActionWhat it does
Add financing roundsAdd financing rounds.
Add securitiesAdd securities.
Add share classesAdd share classes.
Add transactionsAdd transactions.
Create companyCreate company.
Create metricsCreate metrics.
Create notesCreate notes.
Delete a specific metricDelete a specific metric.
Get budgetsGet budgets.
Get companiesGet companies.
Get custom column optionsGet custom column options.
Get custom column valuesGet custom column values.
Get documentsGet documents.
Get financing eventsGet financing events.
Get fundsGet funds.
Get information reportsGet information reports.
Get information requestsGet information requests.
Get metricsGet metrics.
Get metrics optionsGet metrics options.
Get notesGet notes.
Get securitiesGet securities.
Get share classesGet share classes.
Get transactionsGet transactions.
Update metricUpdate metric.

Add financing rounds

Add financing rounds.

Inputs

Financing roundsfinancing_roundslistRequired
financing rounds.

Outputs

datalist
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

Add securities

Add securities.

Inputs

Certificatescertificateslist
certificates.
Warrantswarrantslist
warrants.
Convertiblesconvertibleslist
convertibles.
Token investmentstoken_investmentslist
token investments.
Token warrantstoken_warrantslist
token warrants.
Token convertiblestoken_convertibleslist
token convertibles.

Outputs

dataobject
A response with messages.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "message": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Add share classes

Add share classes.

Inputs

Share classesshare_classeslistRequired
share classes.

Outputs

datalist
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

Add transactions

Add transactions.

Inputs

Salessaleslist
sales.
Conversionsconversionslist
conversions.
Exercisesexerciseslist
exercises.

Outputs

datalist
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

Create company

Create company.

Inputs

NamenametextRequired
Name of the company
Descriptiondescriptiontext
Description of the company. Defaults to empty string if not provided.
Citycitytext
City of the company. Defaults to empty string if not provided.
Sectorsectortext
Sector of the company. Defaults to 'Other' if not provided or invalid.One of: B2B Software, Direct-to-consumer, Consumer Internet/Mobile, AR/VR, Life Sciences, Health Technology, Hardware, Edtech, Media, Fintech, and 11 more.
Fiscal year endfiscal_year_endtext
Fiscal year end date in MM/DD format. Defaults to '12/31' if not provided.
Websitewebsitetext
Website URL of the company. Defaults to empty string if not provided.

Outputs

dataobject
List of role IDs and actions
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "city": "example",
    "description": "example",
    "fiscal_year_end": "example",
    "name": "example",
    "sector": "B2B Software",
    "slug": "example",
    "website": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Create metrics

Create metrics.

Inputs

On conflicton_conflicttext
Conflict resolution strategy when a metric already exists for the same company, category, date, and cadence. Budget metrics only conflict with metrics in the same budget. Point-in-time categories are always stored with the point_in_time cadence, regardless of the submitted cadence. 'overwrite' (default) updates the existing metric. 'skip' leaves the existing metric unchanged and omits it from the response; other metrics in the request are still created.One of: overwrite, skip.
RecordsrecordslistRequired
Records to send, using the documented structure.

Outputs

datalist
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

Create notes

Create notes.

Inputs

RecordsrecordslistRequired
Records to send, using the documented structure.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "author": "example",
    "author_id": "example",
    "company_id": "example",
    "created_at": "example",
    "email": "example",
    "id": "example",
    "note": "example"
  },
  "has_more": false,
  "next_cursor": null
}

Delete a specific metric

Delete a specific metric.

Inputs

Datum IDdatum_idtextRequired
datum id.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "message": "example",
    "success": true
  },
  "has_more": false,
  "next_cursor": null
}

Get budgets

Get budgets. Gets one page; to see more, run it again with the next page it gives.

Inputs

Pagepagenumber
A page number within the paginated result set.
Page sizepage_sizenumber
Number of results to return per page.
Company slugcompany_slugtext
The slug of the company to fetch budgets for. 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. This endpoint will return all budget data for your firm if a company slug isn't included. You can also make a request to the `/companies` endpoint to get a list of all your firm's companies and their slugs.
Company IDcompany_idtext
The id for the company to fetch budget data for. You can get a company's id by making a request to the `/companies` endpoint. This endpoint will return all budget data for your firm if a company id isn't included. You can get a company's id by making a request to the `/companies` endpoint.
Sort bysort_bytext
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"`.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "count": 1,
    "next": null,
    "previous": "example",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

Get companies

Get companies. Gets one page; to see more, run it again with the next page it gives.

Inputs

Pagepagenumber
A page number within the paginated result set.
Page sizepage_sizenumber
Number of results to return per page.
Idsidslist
Filter companies by ID. Can be specified multiple times to filter by multiple IDs (e.g., ?ids[]=123&ids[]=456&ids[]=789).
Namenametext
Filter companies by name. Performs case-insensitive partial matching on company names. .

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "count": 1,
    "next": null,
    "previous": "example",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

Get custom column options

Get custom column options. Gets one page; to see more, run it again with the next page it gives.

Inputs

Pagepagenumber
A page number within the paginated result set.
Page sizepage_sizenumber
Number of results to return per page.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "count": 1,
    "next": null,
    "previous": "example",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

Get custom column values

Get custom column values. Gets one page; to see more, run it again with the next page it gives.

Inputs

Pagepagenumber
A page number within the paginated result set.
Page sizepage_sizenumber
Number of results to return per page.
Company slugcompany_slugtext
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. Either the `company_slug` or `company_id` parameter must be passed to this endpoint.
Company IDcompany_idtext
The id for the company whose metrics' to request. You can get a company's id by making a request to the `/companies` endpoint. Either the `company_slug` or `company_id` parameter must be passed to this endpoint.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "count": 1,
    "next": null,
    "previous": "example",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

Get documents

Get documents. Gets one page; to see more, run it again with the next page it gives.

Inputs

Pagepagenumber
A page number within the paginated result set.
Page sizepage_sizenumber
Number of results to return per page.
Company IDcompany_idtext
The id for the company whose documents to request. You can get a company's id by making a request to the `/companies` endpoint.
Parse stateparse_statetext
The parse state of the documents to request. One of "not-started", "in-progress", "completed", "needs-input", "not-parseable".
Fromfrom_valuedate and time
The from date (inclusive) from which to query uploaded_at as an ISO 8601 formatted date
Totodate and time
The to date (inclusive) from which to query uploaded_at as an ISO 8601 formatted date
Sourcesourcetext
The source of the documents to request. One of "information-request", "implementation", "upload", "email", "stakeholder-update".

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "count": 1,
    "next": null,
    "previous": "example",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

Get financing events

Get financing events. Returns the full service response for the connected account.

Inputs

Company IDscompany_idslist
Filter by company IDs.
Financing IDsfinancing_idslist
Filter by financing event IDs.
Sort bysort_bytext
Sort results by a field. Prefix with '-' for descending order, '+' or no prefix for ascending.One of: closing_date, +closing_date, -closing_date, round_size, +round_size, -round_size.
Is cryptois_cryptotrue/false
Filter by whether the financing event is a crypto financing event.
Co investorsco_investorslist
Filter financing events by co-investor name and role.

Outputs

datalist
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

Get funds

Get funds. Gets one page; to see more, run it again with the next page it gives.

Inputs

Pagepagenumber
A page number within the paginated result set.
Page sizepage_sizenumber
Number of results to return per page.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "count": 1,
    "next": null,
    "previous": "example",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

Get information reports

Get information reports. Gets one page; to see more, run it again with the next page it gives.

Inputs

Pagepagenumber
A page number within the paginated result set.
Page sizepage_sizenumber
Number of results to return per page.
Company IDcompany_idtext
ID of a company to filter
Information requestinformation_request_idtext
ID of an Information Request to filter

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "count": 1,
    "next": null,
    "previous": "example",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

Get information requests

Get information requests. Gets one page; to see more, run it again with the next page it gives.

Inputs

Pagepagenumber
A page number within the paginated result set.
Page sizepage_sizenumber
Number of results to return per page.
Namenametext
An optional name of the information request to filter by.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "count": 1,
    "next": null,
    "previous": "example",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

Get metrics

Get metrics. Gets one page; to see more, run it again with the next page it gives.

Inputs

Pagepagenumber
A page number within the paginated result set.
Page sizepage_sizenumber
Number of results to return per page.
Company slugcompany_slugtext
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. Either the `company_slug` or `company_id` parameter must be passed to this endpoint.
Company IDcompany_idtext
The id for the company whose metrics' to request. You can get a company's id by making a request to the `/companies` endpoint. Either the `company_slug` or `company_id` parameter must be passed to this endpoint.
Fromfrom_valuedate and time
The from date (inclusive) from which to query metrics for as an ISO 8601 formatted date
Totodate and time
The to date (inclusive) from which to query metrics until as an ISO 8601 formatted date
Categorycategorytext
The category of metrics to request. If not specified, all metrics are returned. This parameter can be passed multiple times to filter by multiple categories. Custom metrics can be queried by using their display name (e.g., "Total Number of Customers"). To return only custom metrics, set category to "custom". Available standard metric categories include: `accounts_payable`, `accounts_receivable`, `active_users`, `ai_inference_cost`, `ai_type`, `arr`, `assets`, `burn_per_fte`, `cash_flow_from_financing_activities`, `cash_flow_from_investing_activities`, `cash_flow_from_operating_activities`, `cash_in_bank`, `churned_arr`, `contraction_arr`, `cost_of_goods_sold`, `current_assets`, `current_liabilities`, `custom`, `ebitda`, `equity`, `expansion_arr`, `fair_value`, `fully_diluted_shares`, `general_and_administrative_expenses`, `gross_irr`, `gross_margin`, `gross_profit`, `headcount`, `inactive_users`, `investment_amount`, `latest_price_per_share`, `liabilities`, `long_term_liabilities`, `lost_customers`, `lost_users`, `moic`, `net_assets`, `net_burn`, `net_income`, `net_new_arr`, `net_operating_profit`, `net_other_income`, `net_profit`, `new_customers`, `new_logo_arr`, `new_users`, `non_current_assets`, `number_of_customers`, `operating_margin`, `other_non_current_assets`, `outstanding_debt`, `ownership`, `post_money_valuation`, `pre_money_valuation`, `property_plants_and_equipment`, `reactivation_arr`, `realized_value`, `research_and_development_expenses`, `revenue`, `revenue_growth`, `revenue_per_fte`, `runway`, `sales_and_marketing_expenses`, `short_term_investments`, `stock_based_compensation`, `total_ai_cost`, `total_change_in_cash`, `total_operating_expenses`, `total_shares_owned`
Budgetbudget_idtext
A budget id for requesting budget metrics. See the `/budgets` endpoint for more information about how to get budget ids
Updated at fromupdated_at_fromdate and time
The from date (inclusive) from which to query updated_at as an ISO 8601 formatted date
Updated at toupdated_at_todate and time
The to date (inclusive) from which to query updated_at as an ISO 8601 formatted date
Include deletedinclude_deletedtext
Set to '1' if you want to include deleted metrics.One of: 1.
Include budgetsinclude_budgetstext
Set to "1" if you want budget metrics to be returned as well.One of: 1.
Include archivedinclude_archivedtext
Set to '0' to exclude archived metrics. Defaults to '1' (include archived).One of: 0, 1.
Include non fye alignedinclude_non_fye_alignedtrue/false
Set to 'true' to include metrics whose dates do not align with the company's fiscal year end. These are hidden in the app by default.
Cadencecadencetext
The cadence type of the metrics to request. Cadence options include: `"point_in_time"`, `"month"`, `"quarter"`, `"year"`. The later three should only be set for cumulative categories.
Custom metriccustom_metrictext
The name of the custom metric to query. This field is only populated for metrics in the "custom" category. When filtering for specific metrics, using the `category` field is preferred.
Sort bysort_bytext
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"`.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "count": 1,
    "next": null,
    "previous": "example",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

Get metrics options

Get metrics options. Gets one page; to see more, run it again with the next page it gives.

Inputs

Pagepagenumber
A page number within the paginated result set.
Page sizepage_sizenumber
Number of results to return per page.
Category namecategory_nametext
Name of the category
Category IDcategory_idtext
ID of the category
Is standardis_standardtrue/false
Is category standard
Typetypetext
Type of the categoryOne of: Integer, Decimal, String, Money, Percentage, Select.
Is point in timeis_point_in_timetrue/false
Is category point in time
Is archivedis_archivedtrue/false
Is category archived
Choiceschoiceslist
Choice options for the category
Is multipleis_multipletrue/false
Is the category multiple choice

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "count": 1,
    "next": null,
    "previous": "example",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

Get notes

Get notes. Gets one page; to see more, run it again with the next page it gives.

Inputs

Pagepagenumber
A page number within the paginated result set.
Page sizepage_sizenumber
Number of results to return per page.
Company slugcompany_slugtext
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. Either the `company_slug` or `company_id` parameter must be passed to this endpoint.
Company IDcompany_idtext
The id for the company whose metrics' to request. You can get a company's id by making a request to the `/companies` endpoint. Either the `company_slug` or `company_id` parameter must be passed to this endpoint.
Sort bysort_bytext
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"`.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "count": 1,
    "next": null,
    "previous": "example",
    "results": []
  },
  "has_more": false,
  "next_cursor": null
}

Get securities

Get securities. Returns the full service response for the connected account.

Inputs

Company IDscompany_idslist
Filter by company IDs.
Security IDssecurity_idslist
Filter by security IDs.
Fundfund_idtext
Filter by fund ID.

Outputs

datalist
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

Get share classes

Get share classes. Returns the full service response for the connected account.

Inputs

Company IDscompany_idslist
Filter by company IDs.
Share class IDsshare_class_idslist
Filter by share class IDs.
Purchase typepurchase_typetext
Filter by purchase type: 'primary' or 'secondary'.One of: primary, secondary.

Outputs

datalist
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

Get transactions

Get transactions. Returns the full service response for the connected account.

Inputs

Company IDscompany_idslist
Filter by company IDs.
Transaction IDstransaction_idslist
Filter by transaction IDs.
Eventeventtext
Filter by transaction event type.One of: exercise, conversion, sale.
Input security IDinput_security_idtext
Filter by the input security ID of the transaction.
Output security IDoutput_security_idtext
Filter by the output security ID of the transaction.

Outputs

datalist
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

Update metric

Update metric. Empty fields keep their current values.

Inputs

Datum IDdatum_idtextRequired
datum id.
Valuevaluetext
value.
Currencycurrencytext
currency.One of: AED, AUD, BDT, BRL, CAD, CHF, CNY, COP, CZK, DKK, and 31 more.
Commentscommentslist
comments.

Outputs

dataobject
Data.
has_moretrue/false
Has more.
next_cursortext
Next cursor.
Example output
{
  "data": {
    "comments": [],
    "currency": "AED",
    "id": "example",
    "value": "example"
  },
  "has_more": false,
  "next_cursor": null
}

On this page