v1

latestOpenAPI 3.1.02026-07-231411067.5 KB
Datasets

Dataset information

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 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

get/api/v1/datasets

Query parameters

datasourceNamestring
fromstring date-time
pageinteger
searchstring
sizeinteger

Response

Successful response

firstboolean required
lastboolean required
numberinteger required
sizeinteger required
totalElementsinteger required
totalPagesinteger required