/datasets/{datasetId}/concepts/{conceptId} (DEPRECATED)

Get a concept resource 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}/concepts/{conceptId}

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 single concept.

Available fields

Field Description
column Describes the relationship of the data in the column.
  • id: The GUID for the column in the dataset
  • 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 values of any data that cannot be mapped to a column, record, or concept.
Note: The values in this field will vary depending on the data source. For a complete list of possible values see, Extra data.
href The link to the current page.
id The GUID for the concept.
links Links to child concepts:
  • rel: The string value for the relationship of the child concept.
  • href: Points to the child concept in the dataset.
name The string name for the survey or question as it appears in the application.
orderInParent The number value for the question's position in the survey. The value for a survey is zero (0).
parentId The GUID of the survey or question the concept is a child of.
tags The string names for the concept data source and its value (if applicable).
  • Data source: Possible values are survey, question, or responseVariable
  • Data value: Examples include status and singlechoice
GET response structure

{
   "id": <GUID of concept>,
   "name": <concept name>,
   "parentId": <GUID of parent concept>,
   "tags": [
      <survey|question|responseVariable>,
      <value>
   ],
   "column": {
      "id": <GUID of column>,
      "links": [],
      "href": <link to column>
   },
   "orderInParent": <number>,
   "extraData": {
      "id": <GUID of extra data>,
      "state": <alive|deleted|hidden>,
      "name": <survey or question name>,
      "text": <question text (for question concepts only)>,
      "questionType": <type of question>,
      "extensionType": "<type of extension>,
      "choices": [
         {
            "id": <GUID of answer option>,
            "state": <alive|deleted|hidden>,
            "answerType": <RegularAnswer|openEnd>,
            "text": <answer text>
         },
         {
            "id": <GUID of answer option>,
            "state": <alive|deleted|hidden>,
            "answerType": <RegularAnswer|openEnd>,
            "text": <answer text>
         },
         {
            "id": <GUID of answer option>,
            "state": <alive|deleted|hidden>,
            "answerType": <RegularAnswer|openEnd>,
            "text": <answer text>
         }
      ]
   },
   "datasetId": <GUID of dataset>,
   "links": [
      {
         "rel": "children",
         "href": null
      }
   ],
   "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{datasetId}/concepts/{conceptId}"
}