Skip to main content

Get a respondent variable

Lisa Wong
Updated

Cross reference the column ID in the dataset concepts with the concept ID in the dataset records to find the member ID, the date the member started a survey, and the date the member completed the survey.

Get a member ID

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.

  1. Get the dataset concepts.
    Tip: Increase the response limit to ensure you can find the value you are looking for.

    Example GET request

    https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{datasetId}/concepts/concepts?limit=1000

  2. In the response payload, search for MemberId in the name field, and then record the column ID.

    Example response

    In the example below, the column ID is 7ed9d1f0-3cc5-5998-ad0d-07e29e5b56ef. 

    
...
{
    "id": "7ed9d1f0-3cc5-5998-ad0d-07e29e5b56ef",
    "name": "MemberId",
    "parentId": "7e323297-9f51-4903-a0e9-02dd29f04951",
    "tags": [
       "responsevariable",
       "memberid"
    ],
    "column": {
       "id": "7ed9d1f0-3cc5-5998-ad0d-07e29e5b56ef",
       "links": [],
       "href": "https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{datasetId}/columns/{columnId}"
    },
...
  3. Get the records for the dataset.

    Example GET request

    https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{datasetId}/records?limit=1000
  4. In the records response, search for the column ID you copied from the concepts payload.

    Example member ID

    In the example below, the Member ID is e4f324cf-6b61-48f0-b438-a71d01785723. 

    
...
{
    "columnId": "7ed9d1f0-3cc5-5998-ad0d-07e29e5b56ef",
    "value": "e4f324cf-6b61-48f0-b438-a71d01785723"
}
...

Get the date a member started a survey

  1. Get the dataset concepts.
    Tip: Increase the response limit to ensure you can find the value you are looking for.

    Example GET request

    https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{datasetId}/concepts/concepts?limit=1000
  2. In the response payload, search for responsedate in the name field, and then record the column ID.

    Example response

    In the example below, the column ID is 1287d5d9-c3ee-5302-b4bd-8470486aaff5. 

    
...
{
    "id": "1287d5d9-c3ee-5302-b4bd-8470486aaff5",
    "name": "ResponseDate",
    "parentId": "7e323297-9f51-4903-a0e9-02dd29f04951",
    "tags": [
       "responsevariable",
       "responsedate"
    ],
    "column": {
       "id": "1287d5d9-c3ee-5302-b4bd-8470486aaff5",
       "links": [],
       "href": "https://api.{region}.alida.com/insights/ds/api/v1/tenants/fe7c0a1a-6d0d-41eb-8377-198ab4a23506/datasets/7e323297-9f51-4903-a0e9-02dd29f04951/columns/1287d5d9-c3ee-5302-b4bd-8470486aaff5"
    },
...
  3. Get the records for the dataset.

    Example GET request

    https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{datasetId}/records?limit=1000
  4. In the records response, search for the column ID you recorded from the concepts payload.

    Example response date

    In the example below, the member started the survey on 2017-02-17T22:53:20.0000000Z. 

    
...
{
    "columnId": "1287d5d9-c3ee-5302-b4bd-8470486aaff5",
    "value": "2017-02-17T22:53:20.0000000Z"
},
...

Get the date a member completed a survey

  1. Get the dataset concepts.
    Tip: Increase the response limit to ensure you can find the value you are looking for.

    Example GET request

    https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{datasetId}/concepts/concepts?limit=1000
  2. In the response payload, search for completiondate in the name field, and then record column ID.

    Example GET response

    In the example below, the column ID is 3fab3d17-b70b-59ee-aa06-280abce87b97. 

    
...
{
    "id": "3fab3d17-b70b-59ee-aa06-280abce87b97",
    "name": "CompletionDate",
    "parentId": "7e323297-9f51-4903-a0e9-02dd29f04951",
    "tags": [
       "responsevariable",
       "completiondate"
    ],
    "column": {
       "id": "3fab3d17-b70b-59ee-aa06-280abce87b97",
       "links": [],
       "href": "https://api.{region}.alida.com/insights/ds/api/v1/tenants/fe7c0a1a-6d0d-41eb-8377-198ab4a23506/datasets/7e323297-9f51-4903-a0e9-02dd29f04951/columns/3fab3d17-b70b-59ee-aa06-280abce87b97"
    },
...
  3. Get the records for the dataset.

    Example GET request

    https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{datasetId}/records?limit=1000
  4. In the records response, search for the column ID you recorded from the concepts payload.

    Example completion date

    In the example below, the member completed the survey on 2017-02-17T22:56:34.0000000Z. 

    
...
{
    "columnId": "3fab3d17-b70b-59ee-aa06-280abce87b97",
    "value": "2017-02-17T22:56:34.0000000Z"
},
...

Get all the respondent variables at the same time

  1. Get the dataset concepts.
    Tip: Increase the response limit to ensure you can find the value you are looking for.

    Example GET request

    https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{datasetId}/concepts/concepts?limit=1000
  2. In the response payload, search for MemberId, responsedate, and completiondate in the name field, and then record the column ID for each variable.
  3. Get the records, using a comma or ampersand to append the column IDs to the request.

    Example: Comma separator

    GET https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{datasetId}/records?conceptId={MemberIdColumnId},{responsedateColumnId},{completiondateColumnId}

    Example: Ampersand separator

    GET https://api.{region}.alida.com/v1/applications/{communityApiKeyName}/datasets/{datasetId}/records?conceptId={MemberIdColumnId}&conceptId={responsedateColumnId}&conceptId={completiondateColumnId}
Parent topic: Common Scenarios: Datasets
Related information
Powered by Zendesk