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 10 Next »

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):

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

Request body:

{
  "event_type": "survey_data_request",
  "action": "get_shop_shelf_summary_purchases",
  "data": {
    "target": {
      "survey_id": "SURV01FNR7YQ7T01GJACN4P90ZCBRG",
      "respondent_id": "preview",
      "block_id": "shelf"
   }
  }
}

Response:

{
	"code": 200,
	"data": {
		"survey_id": "SURV01FPWYJF00B84Q5AXVHF25QQ8Z",
		"block_id": "con",
		"respondent_id": "preview",
		"basket_summary": {
			"total_unique_sku": 0,
			"total_value": 0.0,
			"sku_list": ""
		}
	},
	"event_type": "survey_data_request",
	"action": "get_shop_shelf_summary_purchases",
	"client_msg_id": ""
}

respondent_id is the one passed in the respondent App url

block_id is the same as present in Admin App

Inside the target , each parameter must be set manually. The provided by me 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.

Other requests will be documented later…

  • No labels