Additional Data is one of the most crucial tools in your toolbox. In essence, Additional Data is a simplified version of a Key-Value database, where the database is each individual Response, allowing you to attach any additional information you might need.
By attaching information about the respondent in the video, i.e their age, household income, gender, role, etc., you’ll be able to quickly and effectively analyse and filter your responses. “Show me all responses where the respondent’s household income is below the minimum-living-wage” and similar queries are all possible thanks to Additional Data.
Another example of how Additional Data can be used is linking a Response to a response in a survey our Capture Widget was embedded in. With the help of a theoretical Additional Data key survey_response_id
, which contains your survey response ID, we can identify which survey response correlates to the video Response.
Sending Additional Data with Capture Widget
You can easily attach Additional Data to a Response before it’s even recorded by specifying it in the Capture Widget configuration. Please see our Zendesk guide on “How to pass through Additional Data at the end of your survey”.
Sending Additional Data via API
If the Response has already been uploaded, we provide multiple ways for you to enrich your Responses with further Additional Data at any point, depending on how you’re able to identify the particular Response you’re trying to update.
If you know the actual Response ID, you can send the following POST
request:
fetch('https://developer.voxpopme.com/v2/response/{responseId}/additional-data', {
method: 'POST',
headers: {
'x-api-key': 'your_api_key',
'account-id': 'your_account_id',
},
body: JSON.stringify({'attribute': 'survey_id', 'value': '15521'})
});
You can do a lot more with the Additional Data. We provide a series of endpoints to help you do exactly that, under the “Response Additional Data” section of our public API documentation.
Comments
0 comments
Article is closed for comments.