Skip to content

by Startups.Studio

Metric.create

POST /{namespace}/metrics

Creates a Metric.

Noun: Metric
Mode: do
Event: Metric.created

You, to your agent

Add a metric to PetPantry.

curl -X POST https://api.sb/petpantry.shop/metrics \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"Example query"}'

import { $ } from 'startup-builder'

const metric = await $.Metric.create({ query: 'Example query' })

npx startup-builder do Metric.create --json '{"query":"Example query"}'

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

Create makes a new Metric from the inputs below. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`query`	`text`	required	How it is computed. An agent never varies the Metrics it is judged by. Never randomized.
`unit`	`string`		The unit, such as dollars or percent.

Outputs

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

Effects

Emits Metric.created.
Two-way: try, send, do.

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.create

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

Previous Page

Metric.define

Next Page