/datasets (DEPRECATED)

Get a collection of a datasets.

Important: The Batch Data Extract and Dataset V2 endpoints should be used instead of the Datasets endpoints.

• Batch Data Extract endpoints return a complete export of activity and profile variable data.
• Datasets V2 endpoints allows you to select specific activities or profile variables.

Resource URL

/v1/applications/{communityApiKeyName}/datasets

Note:

Use the appropriate regional endpoint to ensure that you comply with your organization's privacy policy, and applicable laws and regulations. For details about the available regional endpoints, and how to identify your organization's region, see Shared responsibility.

Available methods

Method	Description
GET	Returns a collection of datasets.

Parameters

Parameters can be appended to the request to further refine the results returned.

Operation	Description	Example
Refine the response by field	To reduce the number of fields returned, specify the fields in a comma separated list.	/datasets?fields=name
Filtering by value	By default, all the items are returned unless you specify your criteria using the variable name and value. You can filter the results on the values in the id and name fields.	/datasets?name=satisfaction
Paging	The default is 20 items are returned at a time and the maximum is 1000.	Use the limit and offset query string parameters to effectively page through the results.
Sorting	You can sort the results on the id and name fields.	/datasets?sort=id:d

For more information, see Content control.

Available fields

Field	Description
alternateId	The integer ID of a power survey. If the survey is a Community survey, the value is null.
id	The GUID for the given dataset.
links	Links to the data types, columns, concepts, and records in the dataset.
name	The string name of the activity as it appears in the application.

GET response structure

{
   "meta": {
      "offset": 0,
      "limit": 1,
      "count": 143
   },
   "items": [
      {
         "id": <GUID of the dataset 1>,
         "alternateId": <integer id of power survey>,
         "name": <activity name 1>,
         "links": [
            {
               "rel": "dataTypes",
               "href": <link to data types>
            },
            {
               "rel": "columns",
               "href": <link to columns>
            },
            {
               "rel": "concepts",
               "href": <link to concepts>
            },
            {
               "rel": "records",
               "href": <link to records>
            }
         ],
         "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{datasetId}"
      }
   ],
   "links": [
      {
         "rel": "first",
         "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/?offset=0&limit=20"
      },
      {
         "rel": "prev",
         "href": null
      },
      {
         "rel": "last",
         "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/?offset=60&limit=20"
      },
      {
         "rel": "next",
         "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/?offset=20&limit=20"
      }
   ],
   "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/"
}

Parent topic: Dataset endpoints (DEPRECATED)