Standard Metrics
App · 24 actions
Read and update portfolio companies, financial metrics, notes and investment data.
Actions
| Action | What it does |
|---|---|
| Add financing rounds | Add financing rounds. |
| Add securities | Add securities. |
| Add share classes | Add share classes. |
| Add transactions | Add transactions. |
| Create company | Create company. |
| Create metrics | Create metrics. |
| Create notes | Create notes. |
| Delete a specific metric | Delete a specific metric. |
| Get budgets | Get budgets. |
| Get companies | Get companies. |
| Get custom column options | Get custom column options. |
| Get custom column values | Get custom column values. |
| Get documents | Get documents. |
| Get financing events | Get financing events. |
| Get funds | Get funds. |
| Get information reports | Get information reports. |
| Get information requests | Get information requests. |
| Get metrics | Get metrics. |
| Get metrics options | Get metrics options. |
| Get notes | Get notes. |
| Get securities | Get securities. |
| Get share classes | Get share classes. |
| Get transactions | Get transactions. |
| Update metric | Update metric. |
Add financing rounds
Add financing rounds.
Inputs
- Financing rounds
financing_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
- Certificates
certificateslist - certificates.
- Warrants
warrantslist - warrants.
- Convertibles
convertibleslist - convertibles.
- Token investments
token_investmentslist - token investments.
- Token warrants
token_warrantslist - token warrants.
- Token convertibles
token_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 classes
share_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
- Sales
saleslist - sales.
- Conversions
conversionslist - conversions.
- Exercises
exerciseslist - 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
- Name
nametextRequired - Name of the company
- Description
descriptiontext - Description of the company. Defaults to empty string if not provided.
- City
citytext - City of the company. Defaults to empty string if not provided.
- Sector
sectortext - 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 end
fiscal_year_endtext - Fiscal year end date in MM/DD format. Defaults to '12/31' if not provided.
- Website
websitetext - 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 conflict
on_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. - Records
recordslistRequired - 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
- Records
recordslistRequired - 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 ID
datum_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
- Page
pagenumber - A page number within the paginated result set.
- Page size
page_sizenumber - Number of results to return per page.
- Company slug
company_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 ID
company_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 by
sort_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
- Page
pagenumber - A page number within the paginated result set.
- Page size
page_sizenumber - Number of results to return per page.
- Ids
idslist - Filter companies by ID. Can be specified multiple times to filter by multiple IDs (e.g., ?ids[]=123&ids[]=456&ids[]=789).
- Name
nametext - 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
- Page
pagenumber - A page number within the paginated result set.
- Page size
page_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
- Page
pagenumber - A page number within the paginated result set.
- Page size
page_sizenumber - Number of results to return per page.
- Company slug
company_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 ID
company_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
- Page
pagenumber - A page number within the paginated result set.
- Page size
page_sizenumber - Number of results to return per page.
- Company ID
company_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 state
parse_statetext - The parse state of the documents to request. One of "not-started", "in-progress", "completed", "needs-input", "not-parseable".
- From
from_valuedate and time - The from date (inclusive) from which to query uploaded_at as an ISO 8601 formatted date
- To
todate and time - The to date (inclusive) from which to query uploaded_at as an ISO 8601 formatted date
- Source
sourcetext - 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 IDs
company_idslist - Filter by company IDs.
- Financing IDs
financing_idslist - Filter by financing event IDs.
- Sort by
sort_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 crypto
is_cryptotrue/false - Filter by whether the financing event is a crypto financing event.
- Co investors
co_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
- Page
pagenumber - A page number within the paginated result set.
- Page size
page_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
- Page
pagenumber - A page number within the paginated result set.
- Page size
page_sizenumber - Number of results to return per page.
- Company ID
company_idtext - ID of a company to filter
- Information request
information_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
- Page
pagenumber - A page number within the paginated result set.
- Page size
page_sizenumber - Number of results to return per page.
- Name
nametext - 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
- Page
pagenumber - A page number within the paginated result set.
- Page size
page_sizenumber - Number of results to return per page.
- Company slug
company_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 ID
company_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.
- From
from_valuedate and time - The from date (inclusive) from which to query metrics for as an ISO 8601 formatted date
- To
todate and time - The to date (inclusive) from which to query metrics until as an ISO 8601 formatted date
- Category
categorytext - 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`
- Budget
budget_idtext - A budget id for requesting budget metrics. See the `/budgets` endpoint for more information about how to get budget ids
- Updated at from
updated_at_fromdate and time - The from date (inclusive) from which to query updated_at as an ISO 8601 formatted date
- Updated at to
updated_at_todate and time - The to date (inclusive) from which to query updated_at as an ISO 8601 formatted date
- Include deleted
include_deletedtext - Set to '1' if you want to include deleted metrics.One of:
1. - Include budgets
include_budgetstext - Set to "1" if you want budget metrics to be returned as well.One of:
1. - Include archived
include_archivedtext - Set to '0' to exclude archived metrics. Defaults to '1' (include archived).One of:
0,1. - Include non fye aligned
include_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.
- Cadence
cadencetext - 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 metric
custom_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 by
sort_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
- Page
pagenumber - A page number within the paginated result set.
- Page size
page_sizenumber - Number of results to return per page.
- Category name
category_nametext - Name of the category
- Category ID
category_idtext - ID of the category
- Is standard
is_standardtrue/false - Is category standard
- Type
typetext - Type of the categoryOne of:
Integer,Decimal,String,Money,Percentage,Select. - Is point in time
is_point_in_timetrue/false - Is category point in time
- Is archived
is_archivedtrue/false - Is category archived
- Choices
choiceslist - Choice options for the category
- Is multiple
is_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
- Page
pagenumber - A page number within the paginated result set.
- Page size
page_sizenumber - Number of results to return per page.
- Company slug
company_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 ID
company_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 by
sort_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 IDs
company_idslist - Filter by company IDs.
- Security IDs
security_idslist - Filter by security IDs.
- Fund
fund_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 IDs
company_idslist - Filter by company IDs.
- Share class IDs
share_class_idslist - Filter by share class IDs.
- Purchase type
purchase_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 IDs
company_idslist - Filter by company IDs.
- Transaction IDs
transaction_idslist - Filter by transaction IDs.
- Event
eventtext - Filter by transaction event type.One of:
exercise,conversion,sale. - Input security ID
input_security_idtext - Filter by the input security ID of the transaction.
- Output security ID
output_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 ID
datum_idtextRequired - datum id.
- Value
valuetext - value.
- Currency
currencytext - currency.One of:
AED,AUD,BDT,BRL,CAD,CHF,CNY,COP,CZK,DKK, and 31 more. - Comments
commentslist - 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
}