Skip to main content

ListDistributionHistoryResponse

result objectrequired
elements object[]required
  • Array [
  • contactIdstringrequired

    The ID of the contact to which this distribution history entry belongs.

    Example: CID_6SvNjhDzWKKWdCt
    contactLookupIdstring
    Example: CGC_2SvBjhAzwZK4dEx
    distributionIdstringrequired

    The ID of the distribution that was sent out

    Example: EMD_m3ox030by7ydblg
    statusDistributionStatus (string)required
    • Pending: The distribution is scheduled but has yet to be sent.
    • Success: The distribution was successfully delivered to the contact.
    • Error: An error occurred while attempting to send the distribution.
    • Opened: The distribution was opened by the contact.
    • Complaint: The contact complained that the distribution was spam.
    • Skipped: The contact was skipped due to contact frequency rules or blacklisted contact information.
    • Blocked: The distribution failed to send, because the contact blocked it or the email was caught by the spam circuit breaker.
    • Failure: The distribution failed to be delivered.
    • Unknown: The distribution failed for an unknown reason.
    • SoftBounce: The distribution bounced but can be retried.
    • HardBounce: The distribution bounced and should not be retried.
    • SurveyStarted: The contact started the survey distributed.
    • SurveyPartiallyFinished: The contact submitted a partially completed survey response.
    • SurveyFinished: The contact submitted a completed survey response.
    • SurveyScreenedOut: The contact screened out while taking the survey.
    • SessionExpired: The contact's survey session has expired.

    Possible values: [Pending, Success, Error, Opened, Complaint, Skipped, Blocked, Failure, Unknown, SoftBounce, HardBounce, SurveyStarted, SurveyPartiallyFinished, SurveyFinished, SurveyScreenedOut, SessionExpired]

    surveyLinkstringnullablerequired

    The survey link sent with the distribution. This is null when no link was sent.

    Example: https://yourdatacenterid.qualtrics.com/WRQualtricsSurveyEngine?Q_DL=bQNtCGvkeC1rJs1_efmR5rlb76FBjy5_CGC_aabb1122cc3344d
    contactFrequencyRuleIdstringnullablerequired

    When the distribution status is Skipped, this value indicates the contact frequency rule that caused the distribution to be skipped for this contact. Otherwise, this value is null. In the case the rule has been deleted this field will be set to RULE_DELETED

    Example: CFR_gNV8vMdKZtWbT34
    responseIdstringnullablerequired

    The ID of the survey response submitted by this contact. If no survey response has been submitted, this value will be null. If the survey was setup to anonymize responses, then this value will be Anonymous.

    Example: R_YXIPQimT0z0A3i9
    responseCompletedAtstring<date-time>nullablerequired

    The time a response was completed, will be null for uncompleted surveys

    Example: 2017-07-21T17:32:28Z
    sentAtstring<date-time>nullablerequired

    The time a survey was sent to the respondent

    Example: 2017-07-21T17:32:28Z
    openedAtstring<date-time>nullablerequired

    The time a survey was opened by the respondent, will be null if the survey has not been opened

    Example: 2017-07-21T17:32:28Z
    responseStartedAtstring<date-time>nullablerequired

    The time a response was started by the respondent, will be null if survey has not been started

    Example: 2017-07-21T17:32:28Z
    surveySessionIdstringnullablerequired

    An identifier that represents the session in which the respondent interacted with the survey

    Example: FS_1CwF4quYDr7AzoD
  • ]
  • nextPageNextPage (string)nullable

    Page number of result if response is divided across several pages. For the last page of results, the value returned is a URL.

    meta objectrequired

    Response metadata

    httpStatushttp status (string)required

    HTTP status code.

    requestIdAn identifier of the incoming request. (string)required

    Unique identifier of the associated request.

    noticeAn informational string about the request. (string)

    An informational string about the request.

    ListDistributionHistoryResponse
    {
    "result": {
    "elements": [
    {
    "contactId": "CID_6SvNjhDzWKKWdCt",
    "contactLookupId": "CGC_2SvBjhAzwZK4dEx",
    "distributionId": "EMD_m3ox030by7ydblg",
    "status": "Pending",
    "surveyLink": "https://yourdatacenterid.qualtrics.com/WRQualtricsSurveyEngine?Q_DL=bQNtCGvkeC1rJs1_efmR5rlb76FBjy5_CGC_aabb1122cc3344d",
    "contactFrequencyRuleId": "CFR_gNV8vMdKZtWbT34",
    "responseId": "R_YXIPQimT0z0A3i9",
    "responseCompletedAt": "2017-07-21T17:32:28Z",
    "sentAt": "2017-07-21T17:32:28Z",
    "openedAt": "2017-07-21T17:32:28Z",
    "responseStartedAt": "2017-07-21T17:32:28Z",
    "surveySessionId": "FS_1CwF4quYDr7AzoD"
    }
    ],
    "nextPage": "string"
    },
    "meta": {
    "httpStatus": "string",
    "requestId": "string",
    "notice": "string"
    }
    }