Versions Compared

Version Old Version 9 New Version Current
Changes made by

Abs Chamali

abs chamali

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Excerpt
hiddentrue

This API call will give you the shopping summary for each respondent. If you look in the basket_summary you will see data relating to this respondent. sku_list is a list of all the unique SUKs in the basket.

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

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

Request body:

Code Block
languagejson
{
  "event_type": "survey_data_request",
  "action": "get_shop_shelf_summary_purchases",
  "data": {
    "target": {
      "survey_id": "SURV01FNR7YQ7T01GJACN4P90ZCBRG",
      "respondent_idencoded": "previewenc14367fa406b368698d7dfa3034bda0d005b10eea",
      "block_id": "shelf"
   }
  }
}

...

Code Block
languagejson
{
	"reason": null,
	"code": 200,
	"data": {
		"data_complete": true,
		"survey_id": "SURV01FPWYJF00B84Q5AXVHF25QQ8ZSURV01FNR7YQ7T01GJACN4P90ZCBRG",
		"block_id": "shelf",
		"con"respondent_id": null,
		"respondent_encoded": "enc14367fa406b368698d7dfa3034bda0d005b10eea",
		"run_id": "preview"null,
		"exercise_duration": 17759.0,
		"basket_summary": {
			"total_unique_sku": 02,
			"total_value": 055.0,
			"sku_list": "W23, W08"
		}
	},
	"event_type": "survey_data_request",
	"action": "get_shop_shelf_summary_purchases",
	"client_msg_id": "",
	"platform_status": {
		"status": "running",
		"shut_down_timestamp": 0
	}
}

respondent_idencoded is the one passed in via the respondent App url as respondent_id

block_id is the same as present in Admin App

Note

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

Info

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

...