Minimum Success Criteria methods: create, get, list
The Minimum Success Criteria Verbs create, get, list as typed SDK methods, with inputs, result, refusals and an example.
Reference for Minimum Success Criteria, one group of Minimum Success Criteria methods.
MinimumSuccessCriteria.create
Creates a Minimum Success Criteria. Verb page.
interface MinimumSuccessCriteriaVerbs {
create(input: MinimumSuccessCriteriaCreateInput, options?: SB.CallOptions): SB.Call<MinimumSuccessCriteria>
}Emits MinimumSuccessCriteria.created.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
objective | text | required | The qualitative outcome. |
horizon | string | One of day, week, quarter, year, or three-years. | |
metric | Metric | required | The Metric the number is measured in. |
value | number | required | The number to reach. |
by | date | required | The date it must be reached. |
fermi | json | The Price, rates and volumes that show the number is reachable. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
minimumSuccessCriteria | Minimum Success Criteria | required | The Minimum Success Criteria. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
import { $ } from 'startup-builder'
const minimumSuccessCriteria = await $.MinimumSuccessCriteria.create({ objective: 'Example objective', metric: 'metric_GXFHAlK100', value: 1, by: '2026-10-22' })MinimumSuccessCriteria.get
Returns one Minimum Success Criteria by id. Verb page.
interface MinimumSuccessCriteriaVerbs {
get(input: MinimumSuccessCriteriaGetInput, options?: SB.CallOptions): SB.Call<MinimumSuccessCriteria>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
id | string | required | The id of the Minimum Success Criteria. |
at | string | A time or Version name: the record as it stood then. Unset: as it stands now. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
minimumSuccessCriteria | Minimum Success Criteria | required | The Minimum Success Criteria. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
import { $ } from 'startup-builder'
const minimumSuccessCriteria = await $.MinimumSuccessCriteria.get({ id: 'msc_3UF8zdSOyQ' })MinimumSuccessCriteria.list
Returns Minimum Success Criteria, newest first, one page at a time. Verb page.
interface MinimumSuccessCriteriaVerbs {
list(input?: MinimumSuccessCriteriaListInput, options?: SB.CallOptions): SB.ListCall<MinimumSuccessCriteria>
}Reads only: it emits no Event.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
limit | integer | At most this many records, up to 100. The default is 20. | |
after | string | The cursor from the previous page. | |
where | string | A filter over the properties, such as paidAt = null and total.amount > 500. | |
sort | string | Properties to sort by, comma-separated; a leading minus sorts descending. | |
total | boolean | True adds the match count as meta.total, exact up to 10,000 matches and estimated above. | |
facets | string | Properties to count by value, comma-separated, returned as meta.facets. | |
fields | string | Properties to return on each record, comma-separated; $id and $type always return. | |
include | string | Related records to embed in place of their URLs, comma-separated. | |
depth | integer | How many levels of related records to embed. The default is 1. | |
q | string | Words to match across the text properties, ranked by relevance. | |
match | string | Ranks the search by words, or meaning; words is the default. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
minimumSuccessCriteria | list of Minimum Success Criteria | required | One page of Minimum Success Criteria. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
import { $ } from 'startup-builder'
const minimumSuccessCriteria = await $.MinimumSuccessCriteria.list({ limit: 20 })