Get the list of accessible wrangled datasets for the authenticated user.

Tip: In the UI, the WrangledDataset object is called a recipe.

Version: v3

Required Permissions

Request

Request Type: GET

Endpoint:

/v3/wrangledDatasets

Endpoint with embedded flow:

/v3/wrangledDatasets?embed=flow

For more information, see API WrangledDatasets Get v3.

Endpoint with paged retrieval:


By default, this endpoint returns results in sets of 25. 

You can apply query parameters to change the size of the default set and to page through result sets. The following example queries for results 100 at a time. In this case, the query asks for results 3-102:

/v3/wrangledDatasets?embed=flow&limit=100&offset=2

If the count of retrieved results is less than the limit, you have reached the end of the results.

Request Body:

Empty.

Response

Response Status Code - Success: 200 - OK

Response Body Example:

{
  "data": [
    {
      "id": 35,
      "wrangled": true,
      "createdAt": "2017-02-03T05:16:55.844Z",
      "updatedAt": "2017-02-03T05:16:56.998Z",
      "createdBy": 1,
      "updatedBy": 1,
      "name": "base_type_map_array_record_large",
      "description": null,
      "activeSample": {
        "id": 12
      },
      "flow": {
        "id": 12
      },
      "script": {
        "id": 36
      }
    },
    {
      "id": 33,
      "wrangled": true,
      "createdAt": "2017-02-03T05:15:16.145Z",
      "updatedAt": "2017-02-03T05:15:18.859Z",
      "createdBy": 1,
      "updatedBy": 1,
      "name": "original_2_1_random_rows",
      "description": null,
      "activeSample": {
        "id": 10
      },
      "flow": {
        "id": 11
      },
      "script": {
        "id": 34
      }
    },
    {
      "id": 31,
      "wrangled": true,
      "createdAt": "2017-02-03T01:53:41.284Z",
      "updatedAt": "2017-02-03T01:53:41.284Z",
      "createdBy": 1,
      "updatedBy": 1,
      "name": "cdr.txt",
      "description": null,
      "flow": {
        "id": 10
      },
      "script": {
        "id": 32
      }
    },
    {
      "id": 30,
      "wrangled": true,
      "createdAt": "2017-02-03T01:53:40.930Z",
      "updatedAt": "2017-02-03T01:53:40.930Z",
      "createdBy": 1,
      "updatedBy": 1,
      "name": "customer_above_512k",
      "description": null,
      "flow": {
        "id": 10
      },
      "script": {
        "id": 31
      }
    }
  ]
}

Reference

For more information on the properties of a wrangled dataset, see API ImportedDatasets Get v3.

For more information on the embedded flow properties, see API Flows Get v3.