Skip to main content

ListContactTransactionsResponse

result objectrequired

Response information.

elements object[]required
  • Array [
  • transactionIdTransactionId (string)

    The Qualtrics ID of the Contact Transaction.

    Default value: CTR_0AbCd1234
    Example: CTR_3DzxXfwKBBkAbLT
    contactIdContactId (string)

    The Qualtrics ID of the Contact.

    Default value: CID_0AbCd1234
    Example: CID_012345678901234
    mailingListIdMailingListId (string)

    The Qualtrics ID of the Mailing List.

    Default value: CG_0AbCd1234
    Example: CG_0CgJ5dUewtIvxIN
    transactionDatestring<date-time>
    Default value: 2020-01-01 12:30:00
    data object
    property name*stringnullable
    enrichments object[]
  • Array [
  • metric object

    The value of the enrichment

    datestring<date-time>

    The date that the metric was recorded

    typestring

    The type of the metric. A Gauge metric tracks a specific value at a point in time

    fieldstring

    The SES attribute for the metric

    enumValuestring

    If an SES attributes is an enum value then this is set to correctly map the numeric value to the appropriate enum value

    numValueinteger<int32>

    The numeric value of the metric

    source object

    The source of the enrichment. The provider and the context are combined with the metric field to determine a unique key for the enrichment

    context object

    The context of the enrichment provides both a unique key and a reference back to the originating data

    property name*string
    providerstring

    The provider of the enrichment

  • ]
  • ]
  • nextPageNextPage (string)nullable

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

    meta objectrequired

    Response metadata.

    httpStatushttp status (string)required

    HTTP status code.

    requestIdAn identifier of the incoming request. (string)required

    An identifier of the incoming request.

    noticeAn informational string about the request. (string)

    An informational string about the request.

    ListContactTransactionsResponse
    {
    "result": {
    "elements": [
    {
    "transactionId": "CTR_3DzxXfwKBBkAbLT",
    "contactId": "CID_012345678901234",
    "mailingListId": "CG_0CgJ5dUewtIvxIN",
    "transactionDate": "2020-01-01 12:30:00",
    "data": {},
    "enrichments": [
    {
    "metric": {
    "date": "2024-07-29T15:51:28.071Z",
    "type": "string",
    "field": "string",
    "enumValue": "string",
    "numValue": 0
    },
    "source": {
    "context": {},
    "provider": "string"
    }
    }
    ]
    }
    ],
    "nextPage": "string"
    },
    "meta": {
    "httpStatus": "string",
    "requestId": "string",
    "notice": "string"
    }
    }