Dataset
Fields
Nested fields are written with dots; [] marks the items of an array.
| Field | Type | Always present | Description |
|---|---|---|---|
coverage | object | no | The date range the dataset covers. Not every filing in the range is parsed. |
coverage.basis | string | no | — |
coverage.from | date (YYYY-MM-DD) | null | no | — |
coverage.to | date (YYYY-MM-DD) | null | no | — |
dataset | string | no | — |
derive_steps | array of object | no | Each item's fields follow, as derive_steps[].…. |
derive_steps[].step | string | no | — |
derive_steps[].version | string | no | — |
description | string | null | no | — |
extractor | string | no | — |
filings | object | no | Filing counts by parse status. Present only when the server is set to publish them. |
filings.by_status | object | no | — |
filings.total | integer | no | — |
forms | array of string | no | — |
latest_parsed_at | date-time (RFC 3339, UTC) | null | no | — |
links | object | no | — |
queue | object | no | Filings waiting for the current parser version. failed counts filings the parser gave up on; it is present only when the server is set to publish it. |
queue.failed | integer | no | — |
queue.oldest_queued_at | date-time (RFC 3339, UTC) | null | no | — |
queue.queued | integer | no | — |
rows_estimated | object | no | Estimated rows per table. Null when no estimate exists yet. |
status | string | no | One of: available, in_preparation. |
tables | array of string | no | — |
version | string | no | The parser version now in use. |
Used by
- Part of DatasetList.
Markdown version: /docs/reference/schemas/dataset.md