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

Readout routes: create, get, list

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

Reference for Readout, one group of Readout routes.

Readout.create

Creates a Readout. Verb page.

Text
POST /{namespace}/readouts

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

Inputs

InputTypeRequiredDescription
valuenumberrequiredThe Metric’s value for the Variant.
nintegerrequiredHow many exposed units it counts.
intervaljsonThe low and high bounds of the estimate.
readabilitystringrequiredOne of A, B, C, or inadmissible: how far the number can be trusted.
pooledbooleanTrue when exposures from sibling Startups or earlier Portfolio results are pooled in.
experimentExperimentThe Experiment the result belongs to; the learn step drafts the next Variant from it.
variantVariantThe Variant the number describes.

Returns

OutputTypeRequiredDescription
readoutReadoutrequiredThe Readout.

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/readouts \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"value":1,"n":1,"readability":"A"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "readout": {
    "$id": "https://api.sb/leaseline.app/readouts/readout_dlRDxjf2vt",
    "$type": "Readout",
    "value": 1,
    "n": 1,
    "readability": "A"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Readout.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Readout.get

Returns one Readout by id. Verb page.

Text
GET /{namespace}/readouts/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
readoutReadoutrequiredThe Readout.

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/readouts/readout_dlRDxjf2vt \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Readout",
  "$id": "https://api.sb/leaseline.app/readouts/readout_dlRDxjf2vt",
  "readout": {
    "$id": "https://api.sb/leaseline.app/readouts/readout_dlRDxjf2vt",
    "$type": "Readout",
    "value": 1,
    "n": 1,
    "readability": "A"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/readouts/readout_dlRDxjf2vt",
    "up": "https://api.sb/leaseline.app/readouts"
  }
}

Readout.list

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

Text
GET /{namespace}/readouts

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
readoutslist of ReadoutrequiredOne page of Readouts.

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/readouts?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Readout",
  "readouts": [
    {
      "$id": "https://api.sb/leaseline.app/readouts/readout_dlRDxjf2vt",
      "$type": "Readout",
      "value": 1,
      "n": 1,
      "readability": "A"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "readout_dlRDxjf2vt"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/readouts?limit=20",
    "next": "https://api.sb/leaseline.app/readouts?after=readout_dlRDxjf2vt"
  }
}

Readout

Previous

update, delete

Next