Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Current »

This API call will return detailed results of the findability shelf exercise, both as aggregate and detailed data. Meaning you check and verify the choices a respondent has given.

New server Endpoint (note this is different to get params_id):

https://public-survey-data-api.rose.conceptsauce.io/api

Request body:

{
	"event_type": "survey_data_request",
	"action": "get_findability_details",
	"data": {
		"target": {
			"survey_id": "SURVT01FZD9WM6E2VXDEM8RAKZ3N1HF",
			"block_id": "findability",
			"respondent_encoded": "enc14367fa406b368698d7dfa3034bda0d005b10eea"
		}
	}
}

Response:

{
	"reason": null,
	"code": 200,
	"data": {
		"survey_id": "SURVT01FZD9WM6E2VXDEM8RAKZ3N1HF",
		"block_id": "findability",
		"respondent_id": "null",
		"respondent_encoded": "enc14367fa406b368698d7dfa3034bda0d005b10eea",
		"data_complete": true,
		"findability_details": {
			"correct_product_found": true,
			"correct_product_found_at_attempt": 2,
			"exercise_duration": 8589.0,
			"exercise_duration_excluding_dialogs": 4230.0,
			"max_attempts": 3,
			"target_sku": [
				"a9300605002593"
			],
			"selected_products": [
				{
					"sku": "a9300633353315",
					"default_side": "front",
					"measure": "560g",
					"name": "Woolworths Select Max Charge",
					"price_per": "",
					"price": "4",
					"size": [
						0.232,
						0.315,
						0.077
					],
					"reference_shelf": "1",
					"bay_id": "1",
					"zone": "Default_zone",
					"relative_selection_time": 3241.0,
					"absolute_duration": 2892.0
				},
				{
					"sku": "a9300605002593",
					"default_side": "front",
					"measure": "350g",
					"name": "Nestle Milo",
					"price_per": "",
					"price": "4.99",
					"size": [
						0.188,
						0.282,
						0.056
					],
					"reference_shelf": "1",
					"bay_id": "1",
					"zone": "Default_zone",
					"relative_selection_time": 8589.0,
					"absolute_duration": 1338.0
				}
			]
		}
	},
	"event_type": "survey_data_request",
	"action": "get_findability_details",
	"client_msg_id": ""
}

respondent_encoded is the one passed in the respondent App url as respondent_id and is retrieved using the Get Respondent Encoded ID step.

block_id is the same as present in Admin App

relative_time as currently "duration between block start to the time of purchase" 
absolute_duration represents the time it took to select a product from the time a confirm Dialog is closed.

Inside the target , each parameter must be set manually. The provided by survey_id, respondent_id and block_id ARE ONLY EXAMPLES.

If the specified value is invalid, response for such a request will be with code: 802 (which means: No data available for specified target)

The response with 802 code may also mean: The target is alright, but no respondent bought anything yet.

  • No labels