Data product reference
Every key of a Dataset product file, its default caps and the Verbs that read and deliver its records, for lookup.
A data product is a product file with $type:, usually with API beside it. These tables list what each key holds, the defaults every Dataset API starts with, and every Verb that reads or delivers its records.
Definition
| Key | Type | Holds | Required | Status |
|---|---|---|---|---|
$type | list | One or more of App, API, Agent, Dataset, Service | required | live |
nouns | Noun names | The Nouns it exposes; a Dataset holds Things of exactly one | live | |
verbs | Verb ids | The Verbs a Customer may call | live | |
interfaces | list | The Interfaces it ships on; every kind by default | live | |
sources | Source ids | Where its records come from, each owned, wrapped or recruited | required | beta |
refresh | hourly, daily, weekly or monthly | How often it re-reads every Source | beta | |
coverage | list of sentences | The population and date range it answers for, never "complete" | required | beta |
The product file convention shows the keys in a working file.
Dataset API defaults
| Default | Value |
|---|---|
| Facts published beside the price | recordCount, coverage, refreshedAt, schedule, source, license |
| Lookups a caller with no key may make, per IP per day | 100 |
| Free lookups per key, per month | 1,000 |
What a test key reads | Synthetic records only |
| List calls | Paged and priced per row |
| Usage | Billed hits and free misses, apart; a HEAD coverage check is free |
| Repeat lookups | The same key inside 24 hours counts once |
Verbs
| Verb | What it does | Event |
|---|---|---|
Dataset.create | Creates the Dataset from its product file | Dataset.created |
Source.create | Adds a Source it draws on | Source.created |
Integration.connect | Connects a wrapped Source with its credentials | Integration.connected |
Integration.sync | Exchanges records with a connected Source | Integration.synced |
Collection.query | Reads records by SQL or a Relationship path | Collection.queried |
Collection.export | Writes records to a file or a warehouse, once or on a schedule | Collection.exported |
Thing.restore | Brings back a deleted record with its history | Thing.restored |
Every get takes at, a time or a Version name, and returns the record as it stood then.
Capabilities without a Verb
| Capability | What it adds | Proposed Verbs |
|---|---|---|
| Dataset refresh | Refresh one Source now, or backfill a past range | Dataset.refresh, Dataset.backfill |
| Corrections | Fix a value that was wrong when served and tell each reader | Thing.correct |
A capability with status planned has no Verb, so no guide offers it and no agent promises it.