Dataset

Base definition

{
"kind": "dataset",
"referenceId": integer,
"name": string,
"url": string,
"uri": string,
"owner": {
"kind": string("organization" | "user"),
"name": string
}
}

List definition

In addition to the base definition, any dataset resource returned by a list request will contain the following properties:

{
"description": string,
"createdAt": integer,
"updatedAt": integer,
"tableCount": integer,
"numBytes": string(int64),
"totalNumBytes": string(int64),
"temporalRange": [integer, integer],
"temporalPrecision": string,
"publicAccessLevel": string("none"|"overview"|"metadata"|"sample"|"data"|"edit"),
"scopedAccessLevel": string("overview"|"metadata"|"sample"|"data"|"edit"),
"accessLevel": string("overview"|"metadata"|"sample"|"data"|"edit")
}

Get definition

In addition to the base and list definition, any dataset resource returned by a get request will contain the following properties:

{
"tables": [
object(table.base)
],
"documentations": [
{
"accessLevel": string("overview"|"metadata"|"sample"|"data"),
"markdownContent": string
}
],
"tags": [
{
"name": string
}
],
"version": object(version.base),
"currentVersion": object(version.base),
"nextVersion": object(version.base)
}

Documentation

Fields

Base

kind

string

The resource type.

referenceId

integer

A unique, persistent identifier for the dataset. Will always be unique to all datasets for a given user / organization.

name

string

The name of the dataset

url

string

The table's url discoverable via the web interface.

uri

string

The fully qualified reference to the dataset, for use in generating calls to this API.

For example, /datasets/imathews.ian_s_dataset:123:v2_0

owner

object

The owner of the dataset. Will either be an organization or a user

owner.kind

string

One of "organization" or "user"

owner.name

string

The name of the owner organization or user

List

createdAt

integer

When the table was created. Stored as milliseconds since the epoch (1970-01-01).

updatedAt

integer

When the table was updated. Stored as milliseconds since the epoch (1970-01-01).

description

string

A user-provided description of the table. May be null.

tableCount

string

The number of tables on the dataset

numBytes

string(int64)

The size of all tables stored across the current version of the dataset.

totalNumBytes

string(int64)

The total storage size of this dataset, across all versions.

temporalRange

array(integer, integer)

Will be null if no range has been specified. A tuple representing the start and end values for the temporal range. Stored as milliseconds since the epoch (1970-01-01).

Note that in the case where temporalPrecision is "year" or "date", the upper bound of this value will store one millisecond before the next offset. For example:

[1980, 1982]

=> [1980-01-01 00:00:00.000, 1982-12-31 23:59:59.999]

[1990-09-19, 1990-09-24]

=> [1990-09-19 00:00:00.000, 1990-09-24 23:59:59.999]

temporalPrecision

string

The precision of the temporal range. Will be one of "year", "date", "dateTime"

publicAccessLevel

string

The accessLevel of the table to unauthenticated users. Will be one of: "none", "overview", "metadata", "data"

scopedAccessLevel

string

The accessLevel of the table for this request, taking into account the access token being used. This will never be higher than the requesting user's access level. Will be one of: "none", "overview", "metadata", "data"

accessLevel

string

The accessLevel of the table for the current user, ignoring the access token being used. Will be one of: "none", "overview", "metadata", "data"

Get

tables

array(object)

An array of tables on this dataset, returned as a table.base resource.

documentations

array(object)

An array of ordered documentation sections for the dataset

documentations[]

.accessLevel

string

The minimum accessLevel required to view the documentation section.

documentations[]

.markdownContent

string

The content of the documentation, stored as markdown. This field will be null if scopedAccessLevel < documentationSections[].accessLevel .

tags

array(object)

An array of tags on this dataset.

tags.name

string

The name of the tag

version

object

The version of the dataset that was requested. If no version was specified in the request, will be the dataset's current version. Returned as a version.base resource.

currentVersion

object

The dataset's current (latest) version. Will be null if no version has yet been released. Returned as a version.base resource.

nextVersion

object

The dataset's next version. Is only present when scopedAccessLevel == 'edit'. Will be null if no pending version has been created. Returned as a version.base resource.