Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIProductWhat you sellProductDataset

Dataset routes: create, get, list

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

Reference for Dataset, one group of Dataset routes.

Dataset.create

Creates a Dataset. Verb page.

Text
POST /{namespace}/datasets

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

Inputs

InputTypeRequiredDescription
namestringrequiredThe name of the Product.
promisetextrequiredWhat the Customer can rely on.
recordsintegerHow many Things it holds.
refreshedAtdatetimeWhen its Sources were last read.
nounNounA Dataset collects and vouches for the Things of exactly one Noun.

Returns

OutputTypeRequiredDescription
datasetDatasetrequiredThe Dataset.

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/ratebook.dev/datasets \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Ratebook","promise":"A rate for any US address in under 100 milliseconds."}'
JSON
{
  "api": "https://api.sb/ratebook.dev",
  "dataset": {
    "$id": "https://api.sb/ratebook.dev/datasets/dataset_UDQXk0KsJB",
    "$type": "Dataset",
    "name": "Ratebook",
    "promise": "A rate for any US address in under 100 milliseconds.",
    "status": "draft"
  },
  "action": {
    "$id": "https://api.sb/ratebook.dev/actions/act_M5LgINdysq",
    "operation": "Dataset.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/ratebook.dev/actions/act_M5LgINdysq"
  }
}

Dataset.get

Returns one Dataset by id. Verb page.

Text
GET /{namespace}/datasets/{id}

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

Inputs

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

Returns

OutputTypeRequiredDescription
datasetDatasetrequiredThe Dataset.

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/ratebook.dev/datasets/dataset_UDQXk0KsJB \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/ratebook.dev",
  "$type": "Dataset",
  "$id": "https://api.sb/ratebook.dev/datasets/dataset_UDQXk0KsJB",
  "dataset": {
    "$id": "https://api.sb/ratebook.dev/datasets/dataset_UDQXk0KsJB",
    "$type": "Dataset",
    "name": "Ratebook",
    "promise": "A rate for any US address in under 100 milliseconds.",
    "status": "draft"
  },
  "links": {
    "self": "https://api.sb/ratebook.dev/datasets/dataset_UDQXk0KsJB",
    "up": "https://api.sb/ratebook.dev/datasets"
  }
}

Dataset.list

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

Text
GET /{namespace}/datasets

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
datasetslist of DatasetrequiredOne page of Datasets.

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/ratebook.dev/datasets?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/ratebook.dev",
  "$type": "Dataset",
  "datasets": [
    {
      "$id": "https://api.sb/ratebook.dev/datasets/dataset_UDQXk0KsJB",
      "$type": "Dataset",
      "name": "Ratebook",
      "promise": "A rate for any US address in under 100 milliseconds.",
      "status": "draft"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "dataset_UDQXk0KsJB"
  },
  "links": {
    "self": "https://api.sb/ratebook.dev/datasets?limit=20",
    "next": "https://api.sb/ratebook.dev/datasets?after=dataset_UDQXk0KsJB"
  }
}

Dataset

Previous

update, delete

Next