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

Metric routes: create, get, list

The Metric Verbs create, get, list as api.sb routes, with inputs, result, refusals and an example.

Reference for Metric, one group of Metric routes.

Metric.create

Creates a Metric. Verb page.

Text
POST /{namespace}/metrics

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

Inputs

InputTypeRequiredDescription
querytextrequiredHow it is computed. An agent never varies the Metrics it is judged by. Never randomized.
unitstringThe unit, such as dollars or percent.

Returns

OutputTypeRequiredDescription
metricMetricrequiredThe 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 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"Example query"}'
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.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Metric.get

Returns one Metric by id. Verb page.

Text
GET /{namespace}/metrics/{id}

Path: id. Query: the other inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
idstringrequiredThe id of the Metric.
atstringA time or Version name: the record as it stood then. Unset: as it stands now.

Returns

OutputTypeRequiredDescription
metricMetricrequiredThe 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 https://api.sb/leaseline.app/metrics/metric_GXFHAlK100 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Metric",
  "$id": "https://api.sb/leaseline.app/metrics/metric_GXFHAlK100",
  "metric": {
    "$id": "https://api.sb/leaseline.app/metrics/metric_GXFHAlK100",
    "$type": "Metric",
    "query": "Example query",
    "status": "draft"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/metrics/metric_GXFHAlK100",
    "up": "https://api.sb/leaseline.app/metrics"
  },
  "actions": {
    "watch": "https://api.sb/leaseline.app/metrics/metric_GXFHAlK100/watch"
  }
}

Metric.list

Returns Metrics, newest first, one page at a time. Verb page.

Text
GET /{namespace}/metrics

Query: the inputs. Reads only: it emits no Event.

Inputs

InputTypeRequiredDescription
limitintegerAt most this many records, up to 100. The default is 20.
afterstringThe cursor from the previous page.
wherestringA filter over the properties, such as paidAt = null and total.amount > 500.
sortstringProperties to sort by, comma-separated; a leading minus sorts descending.
totalbooleanTrue adds the match count as meta.total, exact up to 10,000 matches and estimated above.
facetsstringProperties to count by value, comma-separated, returned as meta.facets.
fieldsstringProperties to return on each record, comma-separated; $id and $type always return.
includestringRelated records to embed in place of their URLs, comma-separated.
depthintegerHow many levels of related records to embed. The default is 1.
qstringWords to match across the text properties, ranked by relevance.
matchstringRanks the search by words, or meaning; words is the default.

Returns

OutputTypeRequiredDescription
metricslist of MetricrequiredOne page of Metrics.

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 "https://api.sb/leaseline.app/metrics?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Metric",
  "metrics": [
    {
      "$id": "https://api.sb/leaseline.app/metrics/metric_GXFHAlK100",
      "$type": "Metric",
      "query": "Example query",
      "status": "draft"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "metric_GXFHAlK100"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/metrics?limit=20",
    "next": "https://api.sb/leaseline.app/metrics?after=metric_GXFHAlK100"
  }
}

Metric

Previous

update, delete

Next