list

HTTP Request

GET /api/v1/organizations/:userName/datasets
GET /api/v1/users/:userName/datasets

Path parameters

Parameter

userName

The username of the user or organization for which you want to list datasets

Query parameters

ParameterTypeDescription

labels

string

Optional. A comma-separated list of labels to filter on. If multipart labels are present (e.g., school:humanities), you may provide just the prefix to include all entities labeled with that prefix. Labels are administrator-specific information. You must be an administrator of an organization in order to filter on labels. Labels are currently not supported on user-owned datasets.

maxResults

integer

Maximum number of results to return. Defaults to 100, may not exceed 1000.

pageToken

string

Page token, returned by a previous call, to request the next page of results. If not provided, the first page will be returned

This endpoint extends the general API structure.

Authorization

Only datasets to which you have at least overview access will be returned. In order to include datasets that are not publicly visible, your API token must have the following scope:

  • data.overview

Learn more about authorization.

Request body

The request body must be empty.

Response body

Returns a JSON representation of an array of dataset.list resources

{
    "kind": "datasetList",
    "nextPageToken": str,
    "results": [
        object(dataset.list)
    ]
}

Last updated