Get Distribution
GET {{baseUrl}}/distributions/:distributionId?surveyId=SV_cHbKMOdeT8NetF3
Retrieve a distribution. <!--From Readme The values are self evident, with the exception of:
- skip—skip sending email, e.g., due to contact frequency rules),
- block—e.g., (1) a circuit breaker to prevent send duplicates or (2) user marked the spam button.-->
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
surveyId | string | (Required) The ID of the survey to which the distribution belongs. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"result":{"id":"EMD_1234567890abcde","parentDistributionId":"EMD_1234567890abcde","ownerId":"UR_1M4aHozEkSxUfCl","organizationId":"exampleorganization1","requestStatus":"nostrud sed amet minim proident","requestType":"\u003cstring\u003e","sendDate":"1996-09-14T23:15:25.380Z","createdDate":"1967-04-06T02:58:03.837Z","modifiedDate":"2022-01-19T10:55:39.436Z","headers":{"fromEmail":"apiexample@qualtrics.com","replyToEmail":"apiexample@qualtrics.com","fromName":"Test Name","subject":"Example Subject"},"recipients":{"mailingListId":"CG_012345678901234","contactId":"CGC_012345678901234","libraryId":"UR_1M4aHozEkSxUfCl","sampleId":"CG_012345678901235"},"message":{"libraryId":"UR_1M4aHozEkSxUfCl","messageId":"MS_0Vdgn7nLGSQBlYN","messageText":"Example Message Text","messageType":"Inline"},"surveyLink":{"surveyId":"SV_cHbKMOdeT8NetF3","expirationDate":"1964-03-28T17:31:08.377Z","linkType":"Multiple"},"stats":{"sent":0,"failed":0,"started":0,"bounced":0,"opened":0,"skipped":0,"finished":0,"complaints":0,"blocked":0},"embeddedData":{"sunt973":"aute Lorem Duis aliq","magna_18c":"qui consequat nulla dolor","eiusmod_032":"labore","cupidatat8":"reprehenderit ad dolore dolor","labore81c":"dolor"}},"meta":{"httpStatus":"exercitation dolore","requestId":"adipisicing enim do","notice":"ut mollit irure l"}}