/datasets/{datasetId}/concepts (DEPRECATED)

Get a collection of concepts for a dataset. Use the concepts endpoint to get information such as the order of questions and answers, question and answer text, and the structure of complex questions such as grids.

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

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 collection of concepts.

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}/concepts?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 all of the available fields (including an array) except for:
  • column
  • extraData
  • links
/datasets/{datasetId}/concepts?q=tags.contains ("singlechoice")
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 available fields except for:
  • extraData
  • links
  • tags
/datasets/{datasetId}/concepts?sort=orderInParent:d

For more information, see Content control.

Available fields

Field Description
column Describes the relationship for the data in the column.
  • id: The GUID for the column
  • links: This field does not provide context to the data. The value is typically null.
  • href: Points to the column in the dataset.
datasetId The GUID for the dataset the concept is associated with.
extraData The string name or GUID for any value that cannot be mapped to a column or concept.

The values in this field will depend on the concept. For a complete list of possible values see, Extra data.

id The GUID for the given activity or concept.
links Links to child concepts.
  • rel: The string value for the relationship of the child concept.
  • href: Points to the child concept.
name The string name for the given:
  • Activity as it appears in the application (for example, "Satisfaction Survey")
  • Question as it appears in the application (for example, "Gender")
orderInParent The number value for the question's position in the survey.
parentId The GUID of the activity or the question the concept is associated to.
Note: The parentId value for the activity is typically null.
tags The string name for the concept source and its value.
  • Source: Possible values question or responsevariable.
  • Value: Examples include status and singlechoice.
GET response structure

The following is an example of a typical GET response structure without filtering. 


{
   "meta": {
      "offset": 0,
      "limit": 20,
      "count": 2
   },
   "items": [
      {
         "id": <GUID of activity>,
         "name": <activity name>,
         "parentId": null,
         "tags": [
            <activity type>
         ],
         "column": null,
         "orderInParent": 0,
         "extraData": {
            "id": <GUID of extra data>,
            "state": <alive|deleted|hidden>,
            "name": "<activity name>,
            "createdAt": <date-time (UTC) the dataset was created>,
            "lastUpdatedAt": <date-time (UTC) the activity was revised>,
            "version": <number of revisions>
         },
         "datasetId": <GUID of the dataset>,
         "links": [
            {
               "rel": "children",
               "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{GUID of dataset}/concepts?parentId={parentId}"
            }
         ],
         "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{guid of dataset}/concepts/{GUID of concept}"
      },
      {
         "id": <GUID of concept>,
         "name": <concept name>,
         "parentId": <GUID of parent concept>,
         "tags": [
            <question|responseVariable>,
            <value>
         ],
         "column": {
            "id": <GUID of column>,
            "links": [],
            "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{GUID of dataset}/columns/{GUID of column}"
         },
         "orderInParent": <numerical order of question in the survey>,
         "extraData": {
            "id": <GUID of extra data>,
            "state": <alive|deleted>,
            "name": <question name>,
            "text": <question text>,
            "questionType": <survey question type>,
            "extensionType": <Sparq 1 or Community question type>,
            "choices": [
               {
                  "id": <GUID of column>,
                  "state": <alive|deleted|hidden>,
                  "answerType": <regularAnswer|textAnswer>,
                  "text": <answer text>
               },
               {
                  "id": <GUID of column>,
                  "state": <alive|deleted|hidden>,
                  "answerType": <regularAnswer|textAnswer>,
                  "text": <answer text>
               },
               {
                  "id": <GUID of column>,
                  "state": <alive|deleted|hidden>,
                  "answerType": <regularAnswer|textAnswer>,
                  "text": <answer text>
               }
            ]
         },
         "datasetId": <GUID of dataset>,
         "links": [
            {
               "rel": "children",
               "href": null
            }
         ],
         "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{guid of dataset}/concepts/{GUID of concept}"
      },
      {
         "id": <GUID of concept>,
         "name": <concept name>,
         "parentId": <GUID of parent concept>,
         "tags": [
            <question|responseVariable>,
            <value>
         ],
         "column": {
            "id": <GUID of column>,
            "links": [],
            "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{GUID of datset}/columns/<GUID of column>"
         },
         "orderInParent": <number of question>,
         "extraData": {
            "Id": <GUID of extra data>,
            "Name": <question name>,
            "Choices": [
               {
                  "Id": <GUID of colum>,
                  "Text": <answer text>
               },
               {
                  "Id": <GUID of column>,
                  "Text": <answer text>
               },
               {
                  "Id": <GUID of column>,
                  "Text": <answer text>
               }
            ]
         },
         "datasetId": <GUID of dataset>,
         "links": [
            {
               "rel": "children",
               "href": null
            }
         ],
         "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{GUID of dataset}/concepts/{GUID of concept}"
      }
   ],
   "links": [
      {
         "rel": "first",
         "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{GUID of datset}/concepts?offset=0&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}/concepts"
}