API Reference

Retrieve a list of datasets

Description

Returns a list of datasets.

Use this endpoint to identify any datasets that exist within a given spreadsheet, up to one per sheet.

GET /spreadsheets/{spreadsheetId}/datasets

🚧

Required OAuth Scopes:

file:read

Parameters

ParameterInTypeRequiredDescription
spreadsheetIdpathstringtrueThe unique identifier of the spreadsheet

Code Samples

curl -X GET https://api.app.wdesk.com/platform/v1/spreadsheets/{spreadsheetId}/datasets  \ 
-H 'Accept: application/json' \ 
-H 'Authorization: Bearer {access-token}'
http GET https://api.app.wdesk.com/platform/v1/spreadsheets/{spreadsheetId}/datasets  \ 
Accept:application/json \ 
Authorization:"Bearer {access-token}"
wget --method=GET "https://api.app.wdesk.com/platform/v1/spreadsheets/{spreadsheetId}/datasets" \
 --output-document -  \ 
 --header 'Accept: application/json' \ 
 --header 'Authorization: Bearer {access-token}'
import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.app.wdesk.com/platform/v1/spreadsheets/{spreadsheetId}/datasets', headers = headers)

print(r.json())

Returns

200 - OK

Returns a JSON object with data and @nextLink properties. data contains a list of partial Dataset objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn't appear. If the request returns no results at all, data contains an empty array.

Example Responses


{
  "data": [
    {
      "sheet": "27f1b61c04ae4b0991bc73c631914e1d",
      "range": "A1:Q7"
    },
    {
      "sheet": "242a56d3cc0742c8abad0820bd318b23",
      "range": "A1"
    }
  ],
  "@nextLink": "{opaqueUrl}"
}