---
title: "Dataset information"
method: GET
path: "/api/v1/datasets"
tags: ["Datasets"]
---

# Dataset information

`GET /api/v1/datasets`

This endpoint enables you to gather information about the datasets that in exist in your organization's Soda Cloud account, including information about the Soda Cloud resources with which it is associated, such as data source, incidents, attributes and health status.

This GET is a paginated API that uses the following parameters to request specific details:

- `size`: Supply an integer value between 10 and 1000, inclusive. The default value is 10.

- `page`: Supply an integer value. The default value is 0.

- `from`: Optionally, use this parameter to collect only the information for datasets that have been updated after a particular point in time.  Supply an ISO8601 timestamp value. Example: `2023-12-31T10:15:30+01:00`

- `datasourceName`:  Optionally, use this parameter to collect only the information for datasets associated with a specific datasource.

- `search`: Optionally, use this parameter to perform a fuzzy search on the dataset name.

If not specified, the query gathers information for all datasets in the account and sorts the results first by dataset name and then by datasource name in ascending order.

## Authorization

Soda only returns the datasets to which the user has **View dataset** permissions. Soda Cloud Admins have access to all datasets.**See [Manage dataset roles](https://go.soda.io/roles-dataset) for more information.**

## Authentication

User authentication required: `true`

This endpoint accepts authentication via API keys in the `Basic` authentication header, or a pre-authenticated token in HTTP cookie `token`. Cookie sessions extend automatically on each request.

## Tags

`Datasets`

## Rate limiting

30 requests/60 seconds

## Query parameters

- `datasourceName` string
- `from` string, date-time
- `page` integer
- `search` string
- `size` integer

## Response `200`

Successful response

- PublicApiDatasetsResponse
  - `content` DatasetsContentDTO[], required
    - `attributes` MapOfStringToObject
    - `checks` number, required
    - `cloudUrl` string, required
    - `dataQualityStatus` 'pass' | 'warn' | 'fail'
    - `datasetQualifiedName` string
    - `datasource` DatasourcePropertiesDTO
      - `label` string
      - `name` string
      - `prefix` string
      - `type` string
      - `version` '3' | '4'
    - `healthStatus` integer, required
    - `id` string, required
    - `incidents` number, required
    - `label` string
    - `lastUpdated` string, date-time
    - `name` string, required
    - `owners` DatasetOwnerDTO[]
      - `type` 'user' | 'userGroup', required
      - `user` UserContentDTO
        - `email` string, required
        - `firstName` string
        - `fullName` string
        - `lastName` string
        - `userId` string, required
      - `userGroup` UserGroupContentBasicDTO
        - `name` string, required
        - `userGroupId` string, required
    - `partitionColumn` DatasetPartitionColumnContentDTO
      - `columnType` 'unknown' | 'string' | 'integer' | 'float' | 'time' | 'boolean' | 'date' | 'dateTime', required
      - `name` string, required
    - `qualifiedName` string
    - `tags` string[]
    - `timePartition` DatasetTimePartitionDTO
      - `partitionColumn` DatasetPartitionColumnContentDTO
        - `columnType` 'unknown' | 'string' | 'integer' | 'float' | 'time' | 'boolean' | 'date' | 'dateTime', required
        - `name` string, required
      - `sqlExpression` string
      - `timePartitionType` 'disabled' | 'partitionColumn' | 'sqlExpression'
  - `first` boolean, required
  - `last` boolean, required
  - `number` integer, required
  - `size` integer, required
  - `totalElements` integer, required
  - `totalPages` integer, required

## Other responses

- `400` — Bad request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not found
- `429` — Too many requests
- `500` — Internal server error

---

[API](https://skmtc.dev/soda/apis/soda-cloud-api-v4.md) · [All operations](https://skmtc.dev/soda/apis/soda-cloud-api-v4/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/soda/soda-cloud-api-v4/revisions/ce87192b6b72/schema)
