Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIGrowthMetric

Metric routes: define, query, watch

The Metric Verbs define, query, watch as api.sb routes, with inputs, result, refusals and an example.

Reference for Metric, one group of Metric routes.

Metric.define

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

Text
POST /{namespace}/metrics/define

Body, as JSON: the inputs. Emits Metric.defined.

Inputs

InputTypeRequiredDescription
namestringrequiredThe Metric’s name.
querytextrequiredThe query, over Events and Entries.
unitstringrequiredWhat one unit of it is.

Returns

OutputTypeRequiredDescription
metricMetricrequiredThe defined Metric.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/metrics/define \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Leaseline","query":"Example query","unit":"Example unit"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "metric": {
    "$id": "https://api.sb/leaseline.app/metrics/metric_GXFHAlK100",
    "$type": "Metric",
    "query": "Example query",
    "status": "draft"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Metric.define",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Metric.query

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

Text
POST /{namespace}/metrics/query

Body, as JSON: the inputs. Emits Metric.queried.

Inputs

InputTypeRequiredDescription
metricMetricThe Metric to read; omitted, the query names Events directly.
shapestringrequiredThe analysis to run.
breakdownstringThe property to split by, such as an Organization or a Motion.
windowstringThe time range, such as 30d.

Returns

OutputTypeRequiredDescription
rowsjsonrequiredThe result rows, each number with its readability.
metricMetricrequiredThe Metric read.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/metrics/query \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"shape":"trend"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "rows": {},
  "metric": {
    "$id": "https://api.sb/leaseline.app/metrics/metric_GXFHAlK100",
    "$type": "Metric",
    "query": "Example query",
    "status": "draft"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Metric.query",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Metric.watch

Watch alerts the owner of a Metric when it crosses a threshold, by a Task or a Message. Verb page.

Text
POST /{namespace}/metrics/{metric}/watch

Path: metric. Body, as JSON: the other inputs. Emits Metric.watched.

Inputs

InputTypeRequiredDescription
metricMetricrequiredThe Metric to watch.
thresholdnumberrequiredThe value that trips it.
directionstringrequiredTrip when the Metric goes above or below the threshold.

Returns

OutputTypeRequiredDescription
watchWatchrequiredThe Watch that checks it.
metricMetricrequiredThe Metric now watched.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/metrics/metric_GXFHAlK100/watch \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"threshold":1,"direction":"above"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "watch": {
    "$id": "https://api.sb/leaseline.app/watches/watch_9o4vCuR17L",
    "$type": "Watch",
    "selector": "Example selector",
    "url": "https://leaseline.app"
  },
  "metric": {
    "$id": "https://api.sb/leaseline.app/metrics/metric_GXFHAlK100",
    "$type": "Metric",
    "query": "Example query",
    "status": "draft"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Metric.watch",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

update, delete

Previous

Motion

Next