Versions Compared

Key

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

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": "get_data_request",
  "action": "get_conjoint_shelf_version_summary",
  "data": {
    "target": {
      "survey_id": "SURV01FPWYJF00B84Q5AXVHF25QQ8Z",
      "block_id": "conshelf",
      "versionrespondent_idencoded": "1enc14367fa406b368698d7dfa3034bda0d005b10eea"
    }
  }
}

Response:

Code Block
languagejson
{
  	"code": 200,
  	"data": {
  		"survey_id": "SURV01FPWYJF00B84Q5AXVHF25QQ8Z",
		"block_id": "shelf",
		"blockrespondent_id": "null",
		"respondent_encoded": "conenc14367fa406b368698d7dfa3034bda0d005b10eea",
		"data_complete": true,
		"respondentversion_id": "preview1",
		"tasks": [
			{
				"record_type": "product_clicked_on",
				"versiontask_id": "1",
				"sku_selected": "430623",
"tasks": [
{
  				"time_of_action": 1663658221746.0,
				"purchase_price": 43.0,
				"relative_selection_time": 5684.0
			},
			{
				"record_type": "product_purchased",
				"task_id": "1",
				"sku_selected": "430623",
				"time_of_action": 1663658223402.0,
				"purchase_price": 43.0,
				"relative_selection_time": 7340.0
			},
			{
				"record_type": "product_clicked_on",
				"task_id": "2",
				"sku_selected": "B101488429",
				"time_of_action": 1663658238051.0,
				"purchase_price": 51.0,
				"relative_selection_time": 11558.0
			},
			{
				"record_type": "nothing_to_select": "5393.0",
  _buy",
				"task_id": "3",
				"time_of_action": 1663658243768.0,
				"relative_selection_time": 2135.0
			},
			{
				"record_type": "product_clicked_on",
				"task_id": "4",
				"sku_selected": "265533",
				"time_of_action": 1663658250848.0,
				"purchase_price": 87.0,
				"relative_selection_time": 4686.0
			},
			{
				"record_type": "aggregate",
				"task_id": "5393.0"
}
]
},
  "1",
				"task_duration": 7340.0
			},
			{
				"record_type": "aggregate",
				"task_id": "2",
				"task_duration": 11558.0
			},
			{
				"record_type": "aggregate",
				"task_id": "3",
				"task_duration": 2135.0
			},
			{
				"record_type": "aggregate",
				"task_id": "4",
				"task_duration": 4686.0
			}
		]
	},
	"event_type": "get_data_request",
  	"action": "get_conjoint_shelf_version_summary",
  	"client_msg_id": ""
}

One should mostly be interested in the tasks list. It's a list of products selected in shelf actions for each conjoint task.time_to_select .

Their are 4 record types you will get from this API;
- product_clicked_on for when a product has been clicked on.
- product_purchased for when a product has been selected/purchased.
- nothing_to_buy for when one leaves a task without selecting/purchasing at least 1 product.
- aggregate for any further data about a given task. ie; task_duration as in example above.

relative_selection_time is time in milliseconds, since the previous selection (or since the block task started, in the case of the first

...

relative_selection_time is always time in milliseconds , since the block task started.