/datasets/{datasetId} (DEPRECATED)

Get a dataset for a survey.

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/{datasetId}

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 API Access.

Available methods

Method Description
GET Returns a dataset.

Available fields

Field Description
href The link to the current page.
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

{
  "id": <GUID of the dataset>,
  "name": <activity name>,
  "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/{GUID of dataset}"
}