Start an Update Embedded data job

POST {{baseUrl}}/surveys/:surveyId/update-responses

Start a job to update embedded data for responses in a survey.

Limits

Jobs are limited in size to 250 thousand responseIds. ResponseIds are not allowed to be duplicated. A job's size is also limited: the http request body must be less than 5mb and the size of the file at fileUrl must be less than 750mb. The new EmbeddedData must be a map with keys and values of string type. The values can be at most 1000 characters long. Jobs for the same survey/brand are queued and not run concurrently. Expect jobs to take longer and be marked with a queued status if initiating multiple jobs simultaneously.

SLOs

The execution of this job may take up to 1 hour. Additionally, updates take additional time to propagate into Data & Analysis Dashboards. Large jobs generally take longer but all jobs have an overall SLO of 6 hours. This SLO does not apply for jobs that are queued.

fileUrl

The fileUrl should return a json body when an HTTP GET request is sent to the url. The Content-Type must be oneOf application/json, application/octet-stream, or binary/octet-stream. The Content-Length header value is also checked against the filesize limit. The parsing of the json file is fairly strict and will error for any unexpected fields or data types. This is intended to protect against accidental typos that could result in incorrect behavior.

Request Body

{"updates"=>[{"responseId"=>"<string>", "resetRecordedDate"=>true, "embeddedData"=>{"cupidatat_e"=>"<string>", "occaecat_0b9"=>"<string>"}}, {"responseId"=>"<string>", "resetRecordedDate"=>true, "embeddedData"=>{"nostrudcb"=>"<string>", "dolore_53a"=>"<string>"}}], "removeEdits"=>false, "ignoreMissingResponses"=>false, "fileUrl"=>"<string>"}

HEADERS

RESPONSES

status: OK

{"result":{"progressId":"\u003cstring\u003e"},"meta":{"requestId":"\u003cstring\u003e","httpStatus":"\u003cstring\u003e","notice":"\u003cstring\u003e"}}