# Standard Metrics

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

App · 24 actions. Web page: https://docs.lodol.com/docs/integrations/standard-metrics

## Actions

### Add financing rounds

Add financing rounds.

**Inputs**

- Financing rounds (`financing_rounds`, list, required): financing rounds.

**Outputs**

- `data` (list): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### Add securities

Add securities.

**Inputs**

- Certificates (`certificates`, list): certificates.
- Warrants (`warrants`, list): warrants.
- Convertibles (`convertibles`, list): convertibles.
- Token investments (`token_investments`, list): token investments.
- Token warrants (`token_warrants`, list): token warrants.
- Token convertibles (`token_convertibles`, list): token convertibles.

**Outputs**

- `data` (object): A response with messages.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "message": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```

### Add share classes

Add share classes.

**Inputs**

- Share classes (`share_classes`, list, required): share classes.

**Outputs**

- `data` (list): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### Add transactions

Add transactions.

**Inputs**

- Sales (`sales`, list): sales.
- Conversions (`conversions`, list): conversions.
- Exercises (`exercises`, list): exercises.

**Outputs**

- `data` (list): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### Create company

Create company.

**Inputs**

- Name (`name`, text, required): Name of the company
- Description (`description`, text): Description of the company. Defaults to empty string if not provided.
- City (`city`, text): City of the company. Defaults to empty string if not provided.
- Sector (`sector`, text): 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_end`, text): Fiscal year end date in MM/DD format. Defaults to '12/31' if not provided.
- Website (`website`, text): Website URL of the company. Defaults to empty string if not provided.

**Outputs**

- `data` (object): List of role IDs and actions
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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_conflict`, text): 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 (`records`, list, required): Records to send, using the documented structure.

**Outputs**

- `data` (list): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### Create notes

Create notes.

**Inputs**

- Records (`records`, list, required): Records to send, using the documented structure.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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_id`, text, required): datum id.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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 (`page`, number): A page number within the paginated result set.
- Page size (`page_size`, number): Number of results to return per page.
- Company slug (`company_slug`, text): 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_id`, text): 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_by`, text): 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**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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 (`page`, number): A page number within the paginated result set.
- Page size (`page_size`, number): Number of results to return per page.
- Ids (`ids`, list): Filter companies by ID. Can be specified multiple times to filter by multiple IDs (e.g., ?ids[]=123&ids[]=456&ids[]=789).
- Name (`name`, text): Filter companies by name. Performs case-insensitive partial matching on company names. .

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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 (`page`, number): A page number within the paginated result set.
- Page size (`page_size`, number): Number of results to return per page.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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 (`page`, number): A page number within the paginated result set.
- Page size (`page_size`, number): Number of results to return per page.
- Company slug (`company_slug`, text): 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_id`, text): 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**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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 (`page`, number): A page number within the paginated result set.
- Page size (`page_size`, number): Number of results to return per page.
- Company ID (`company_id`, text): 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_state`, text): The parse state of the documents to request. One of "not-started", "in-progress", "completed", "needs-input", "not-parseable".
- From (`from_value`, date and time): The from date (inclusive) from which to query uploaded_at as an ISO 8601 formatted date
- To (`to`, date and time): The to date (inclusive) from which to query uploaded_at as an ISO 8601 formatted date
- Source (`source`, text): The source of the documents to request. One of "information-request", "implementation", "upload", "email", "stakeholder-update".

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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_ids`, list): Filter by company IDs.
- Financing IDs (`financing_ids`, list): Filter by financing event IDs.
- Sort by (`sort_by`, text): 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_crypto`, true/false): Filter by whether the financing event is a crypto financing event.
- Co investors (`co_investors`, list): Filter financing events by co-investor name and role.

**Outputs**

- `data` (list): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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 (`page`, number): A page number within the paginated result set.
- Page size (`page_size`, number): Number of results to return per page.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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 (`page`, number): A page number within the paginated result set.
- Page size (`page_size`, number): Number of results to return per page.
- Company ID (`company_id`, text): ID of a company to filter
- Information request (`information_request_id`, text): ID of an Information Request to filter

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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 (`page`, number): A page number within the paginated result set.
- Page size (`page_size`, number): Number of results to return per page.
- Name (`name`, text): An optional name of the information request to filter by.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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 (`page`, number): A page number within the paginated result set.
- Page size (`page_size`, number): Number of results to return per page.
- Company slug (`company_slug`, text): 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_id`, text): 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_value`, date and time): The from date (inclusive) from which to query metrics for as an ISO 8601 formatted date
- To (`to`, date and time): The to date (inclusive) from which to query metrics until as an ISO 8601 formatted date
- Category (`category`, text): 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_id`, text): 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_from`, date and time): The from date (inclusive) from which to query updated_at as an ISO 8601 formatted date
- Updated at to (`updated_at_to`, date and time): The to date (inclusive) from which to query updated_at as an ISO 8601 formatted date
- Include deleted (`include_deleted`, text): Set to '1' if you want to include deleted metrics. One of: `1`.
- Include budgets (`include_budgets`, text): Set to "1" if you want budget metrics to be returned as well. One of: `1`.
- Include archived (`include_archived`, text): Set to '0' to exclude archived metrics. Defaults to '1' (include archived). One of: `0`, `1`.
- Include non fye aligned (`include_non_fye_aligned`, true/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 (`cadence`, text): 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_metric`, text): 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_by`, text): 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**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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 (`page`, number): A page number within the paginated result set.
- Page size (`page_size`, number): Number of results to return per page.
- Category name (`category_name`, text): Name of the category
- Category ID (`category_id`, text): ID of the category
- Is standard (`is_standard`, true/false): Is category standard
- Type (`type`, text): Type of the category. One of: `Integer`, `Decimal`, `String`, `Money`, `Percentage`, `Select`.
- Is point in time (`is_point_in_time`, true/false): Is category point in time
- Is archived (`is_archived`, true/false): Is category archived
- Choices (`choices`, list): Choice options for the category
- Is multiple (`is_multiple`, true/false): Is the category multiple choice

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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 (`page`, number): A page number within the paginated result set.
- Page size (`page_size`, number): Number of results to return per page.
- Company slug (`company_slug`, text): 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_id`, text): 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_by`, text): 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**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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_ids`, list): Filter by company IDs.
- Security IDs (`security_ids`, list): Filter by security IDs.
- Fund (`fund_id`, text): Filter by fund ID.

**Outputs**

- `data` (list): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "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_ids`, list): Filter by company IDs.
- Share class IDs (`share_class_ids`, list): Filter by share class IDs.
- Purchase type (`purchase_type`, text): Filter by purchase type: 'primary' or 'secondary'. One of: `primary`, `secondary`.

**Outputs**

- `data` (list): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### Get transactions

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

**Inputs**

- Company IDs (`company_ids`, list): Filter by company IDs.
- Transaction IDs (`transaction_ids`, list): Filter by transaction IDs.
- Event (`event`, text): Filter by transaction event type. One of: `exercise`, `conversion`, `sale`.
- Input security ID (`input_security_id`, text): Filter by the input security ID of the transaction.
- Output security ID (`output_security_id`, text): Filter by the output security ID of the transaction.

**Outputs**

- `data` (list): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### Update metric

Update metric. Empty fields keep their current values.

**Inputs**

- Datum ID (`datum_id`, text, required): datum id.
- Value (`value`, text): value.
- Currency (`currency`, text): currency. One of: `AED`, `AUD`, `BDT`, `BRL`, `CAD`, `CHF`, `CNY`, `COP`, `CZK`, `DKK`, and 31 more.
- Comments (`comments`, list): comments.

**Outputs**

- `data` (object): Data.
- `has_more` (true/false): Has more.
- `next_cursor` (text): Next cursor.

**Example output**

```json
{
  "data": {
    "comments": [],
    "currency": "AED",
    "id": "example",
    "value": "example"
  },
  "has_more": false,
  "next_cursor": null
}
```
