Skip to content

by Startups.Studio

Metric.query

POST /{namespace}/metrics/query

Query reads Metrics or Events as a trend, funnel, retention curve, path or lifecycle, broken down by any property.

Noun: Metric
Mode: do
Event: Metric.queried

You, to your agent

Query the latest metric.

curl -X POST https://api.sb/tutorloop.com/metrics/query \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"shape":"trend"}'

import { $ } from 'startup-builder'

const { rows, metric } = await $.Metric.query({ shape: 'trend' })

npx startup-builder do Metric.query --json '{"shape":"trend"}'

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

Inputs

Input	Type	Required	Description
`metric`	Metric		The Metric to read; omitted, the query names Events directly.
`shape`	`string`	required	The analysis to run.
`breakdown`	`string`		The property to split by, such as an Organization or a Motion.
`window`	`string`		The time range, such as `30d`.

Outputs

Output	Type	Required	Description
`rows`	`json`	required	The result rows, each number with its readability.
`metric`	Metric	required	The Metric read.

Effects

Emits Metric.queried.
Performed by the Analyst.
Two-way: it runs at once, in the try, send and do modes.

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

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

Previous Page

Metric.update

Next Page