Skip to content

by Startups.Studio

Metric.define

POST /{namespace}/metrics/define

Define compiles a Metric’s query against the Startup’s Events and Entries and lists every Event it reads.

Noun: Metric
Mode: do
Event: Metric.defined

You, to your agent

Define the latest metric.

curl -X POST https://api.sb/ledgerlark.com/metrics/define \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"LedgerLark","query":"Example query","unit":"Example unit"}'

import { $ } from 'startup-builder'

const metric = await $.Metric.define({ name: 'LedgerLark', query: 'Example query', unit: 'Example unit' })

npx startup-builder do Metric.define --json '{"name":"LedgerLark","query":"Example query","unit":"Example unit"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Metric.define({ name: 'LedgerLark', query: 'Example query', unit: 'Example unit' })"
  }
}

Inputs

Input	Type	Required	Description
`name`	`string`	required	The Metric’s name.
`query`	`text`	required	The query, over Events and Entries.
`unit`	`string`	required	What one unit of it is.

Outputs

Output	Type	Required	Description
`metric`	Metric	required	The defined Metric.

Effects

Emits Metric.defined.
Performed by the Analyst.
Two-way: it runs at once, in the try, send and do modes.
A Change that renames or removes an Event this Metric reads must map it to a new Event, or the Change is refused.

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.	Metric.define

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Metric.create

Previous Page

Metric.delete

Next Page