Skip to main content
POST
/
metrics
Create metrics
curl --request POST \
  --url https://api.standardmetrics.io/v1/metrics/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "value": "1000",
    "company_id": "RjX8",
    "category": "cash_in_bank",
    "date": "2023-07-31",
    "metric_cadence": "point_in_time",
    "currency": "USD",
    "is_budget_metric": true,
    "budget_id": "yzJm"
  }
]
'
[
  {
    "value": "1000",
    "company_id": "RjX8",
    "category": "cash_in_bank",
    "date": "2023-07-31",
    "metric_cadence": "point_in_time",
    "currency": "USD",
    "is_budget_metric": true,
    "budget_id": "yzJm"
  }
]

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

​
on_conflict
enum<string>
default:overwrite

Conflict resolution strategy when a metric already exists for the same company, category, and date. 'overwrite' (default) updates the existing row. 'skip' leaves the existing row unchanged.

Available options:
overwrite,
skip

Body

application/json
​
value
string

Metric value

Example:

"1000"

​
company_id
string

Company ID

Example:

"RjX8"

​
category
enum<string>

Metric category (can also be the name of a custom metric using its display name (e.g., "Total Number of Customers"))

Available options:
accounts_payable,
accounts_receivable,
arr,
assets,
burn_per_fte,
cash_flow_from_financing_activities,
cash_flow_from_investing_activities,
cash_flow_from_operating_activities,
cash_in_bank,
cash_payments,
cash_receipts,
churned_arr,
contraction_arr,
cost_of_goods_sold,
current_assets,
current_liabilities,
custom,
ebitda,
equity,
expansion_arr,
fair_value,
fully_diluted_shares,
gross_irr,
gross_margin,
gross_profit,
headcount,
investment_amount,
latest_price_per_share,
liabilities,
long_term_liabilities,
moic,
net_assets,
net_burn,
net_income,
net_new_arr,
net_operating_profit,
net_other_income,
net_profit,
new_logo_arr,
non_current_assets,
operating_margin,
other_non_current_assets,
ownership,
post_money_valuation,
pre_money_valuation,
property_plants_and_equipment,
reactivation_arr,
realized_value,
revenue,
revenue_growth,
revenue_per_fte,
runway,
short_term_investments,
total_change_in_cash,
total_operating_expenses,
total_shares_owned
Example:

"cash_in_bank"

​
date
string

Date

Example:

"2023-07-31"

​
metric_cadence
enum<string>

Metric cadence

Available options:
point_in_time,
day,
week,
month,
quarter,
half_year,
year
Example:

"point_in_time"

​
currency
enum<string>

Currency. Only required for money-type metrics.

Available options:
AED,
AUD,
BDT,
BRL,
CAD,
CHF,
CNY,
COP,
CZK,
DKK,
EUR,
GBP,
GHS,
HKD,
IDR,
ILS,
INR,
ISK,
JOD,
JPY,
KES,
KRW,
MXN,
NGN,
NOK,
NZD,
PEN,
PHP,
PKR,
SAR,
SEK,
SGD,
THB,
TRY,
TWD,
TZS,
USD,
VND,
ZAR
Example:

"USD"

​
is_budget_metric
boolean

Is budget metric. Defaults to False if not provided.

Example:

true

​
budget_id
string

Budget ID

Example:

"yzJm"

Response

201 - application/json
​
value
string

Metric value

Example:

"1000"

​
company_id
string

Company ID

Example:

"RjX8"

​
category
enum<string>

Metric category (can also be the name of a custom metric using its display name (e.g., "Total Number of Customers"))

Available options:
accounts_payable,
accounts_receivable,
arr,
assets,
burn_per_fte,
cash_flow_from_financing_activities,
cash_flow_from_investing_activities,
cash_flow_from_operating_activities,
cash_in_bank,
cash_payments,
cash_receipts,
churned_arr,
contraction_arr,
cost_of_goods_sold,
current_assets,
current_liabilities,
custom,
ebitda,
equity,
expansion_arr,
fair_value,
fully_diluted_shares,
gross_irr,
gross_margin,
gross_profit,
headcount,
investment_amount,
latest_price_per_share,
liabilities,
long_term_liabilities,
moic,
net_assets,
net_burn,
net_income,
net_new_arr,
net_operating_profit,
net_other_income,
net_profit,
new_logo_arr,
non_current_assets,
operating_margin,
other_non_current_assets,
ownership,
post_money_valuation,
pre_money_valuation,
property_plants_and_equipment,
reactivation_arr,
realized_value,
revenue,
revenue_growth,
revenue_per_fte,
runway,
short_term_investments,
total_change_in_cash,
total_operating_expenses,
total_shares_owned
Example:

"cash_in_bank"

​
date
string

Date

Example:

"2023-07-31"

​
metric_cadence
enum<string>

Metric cadence

Available options:
point_in_time,
day,
week,
month,
quarter,
half_year,
year
Example:

"point_in_time"

​
currency
enum<string>

Currency. Only required for money-type metrics.

Available options:
AED,
AUD,
BDT,
BRL,
CAD,
CHF,
CNY,
COP,
CZK,
DKK,
EUR,
GBP,
GHS,
HKD,
IDR,
ILS,
INR,
ISK,
JOD,
JPY,
KES,
KRW,
MXN,
NGN,
NOK,
NZD,
PEN,
PHP,
PKR,
SAR,
SEK,
SGD,
THB,
TRY,
TWD,
TZS,
USD,
VND,
ZAR
Example:

"USD"

​
is_budget_metric
boolean

Is budget metric. Defaults to False if not provided.

Example:

true

​
budget_id
string

Budget ID

Example:

"yzJm"