/datasets/{datasetId}/columns (DEPRECATED)

Get a collection of columns in a dataset.

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}/columns

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

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/{datasetId}/columns?fields=dataType
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 response on the values in the following fields: id name	/datasets/{datasetId}/columns?name=Country
Paging	The default is 20 pages 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/{datasetId}/columns?sort=name:d

For more information, see Content control.

Available fields

Field	Description
dataType	The value type for the column. The value may appear as a string or an URN.
href	Points to the column ID in the dataset.
id	The GUID for the given column in the dataset.
labels	The question text as it appears in the survey.
link	This field will always be empty.
name	The string name for the column as it appears in the dataset.

GET response structure

{
   "meta": {
      "offset": 0,
      "limit": 1,
      "count": 7
   },
   "items": [
      {
         "id": <GUID of column>,
         "name":<column name>,
         "dataType": <constructor of data type>,
         "labels": [
            {
               "text": <question text>
            }
         ],
         "links": [],
         "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{datasetId}/columns/{columnId}"
      }
   ],
   "links": [
      {
         "rel": "first",
         "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{datasetId}/columns?offset=0&amp;limit=20"
      },
      {
         "rel": "prev",
         "href": null
      },
      {
         "rel": "last",
         "href": null 
      },
      {
         "rel": "next",
         "href": null
      }
   ],
   "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{GUID of dataset}/columns"
}

Parent topic: Dataset endpoints (DEPRECATED)