{"_id":"5a13458245769d002674f702","project":"55843604fd8d910d007b9502","version":{"_id":"558444ceafccfd0d00fcb2bb","forked_from":"55843604fd8d910d007b9505","project":"55843604fd8d910d007b9502","__v":66,"createdAt":"2015-06-19T16:35:26.435Z","releaseDate":"2015-06-19T16:35:26.435Z","categories":["558444cfafccfd0d00fcb2bc","558444cfafccfd0d00fcb2bd","55ad4ce733616a0d00599d2e","55ad4cef6aadf20d0015b764","55ad4cf36aadf20d0015b765","55ad4cfb24cf160d0013584f","55ad4d0024cf160d00135850","55ad4d0a24cf160d00135851","55ad4d0d24cf160d00135852","55ad4d126aadf20d0015b766","55ad4d1624cf160d00135853","55ad4d1933616a0d00599d2f","55ad4d2233616a0d00599d30","55ad4d2e24cf160d00135854","55d35b6bf77e6d0d00b1b092","55d3649a0168850d0073f14a","55d366d40168850d0073f15a","55d37fcff77e6d0d00b1b13f","55d383e50168850d0073f1e1","55d3ac26c336ec0d007c2251","55d3c51cb2330119009c31db","55d3c59bfe37111900e536f3","55d3c5a7fe37111900e536f4","55d3c5b4fe37111900e536f5","55d3c5d4fe37111900e536f6","55d3c5d6b2330119009c31df","55d3c5d71f478b170077c164","55d3c687b2330119009c31e4","55d3c6a4fe37111900e536f9","55d3c6befe37111900e536fa","55d3c6e8d2c66f0d00497f93","55d49dcfd7c16b2d007de905","55d4ca8f5082980d0009c79b","55d4cab9c95a3d2f0069ad3d","55d4d279c95a3d2f0069ad60","55d4d9355082980d0009c7e1","55d4f6b5988e130d000b3eb1","55d64dc8e60a2f0d00b88ecb","5627ca43fcbbc621004ec07d","56c64a0d8f98b50d0012c37c","56f1b8b13eb62a34003ea041","56f1b9df4476fb2200795e8c","57f6907dca5e5d1700039ae9","591dd06ca266c423002ec4ca","59234825e465c11900922518","5936f82eaa591e0027638d57","59972f54fd7078001992c136","599c6da8f180820025f14909","59b054613c3e1b0019cf27d9","59b1ceca2d6231003ad73e5f","59b1cf1857911600382e0dc4","59b1cf2730f3d60010c30ef7","59b1cf385d4b89003035441a","59b1cf5857911600382e0dc6","59bc2c4e26ac9b0010a8b753","59bc2ce20b3eb30010657b70","59f0c793ba3bc90030f413ab","59f0cd62f5ecda00325294b9","59fb55a8e8d0f600101aedc3","59fcb05c067f8d0028613f86","5a2af4a1bc5fba00283909c1","5a83673b0e56010012138c12","5a972f2e77b85a0070e4ebe2","5aa300224ed4b40012c53e1d","5acd20095efd8d000359bb3c","5ad50889c05179000306021e","5af0927a8779670003daff34"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"category":{"_id":"59bc2c4e26ac9b0010a8b753","project":"55843604fd8d910d007b9502","version":"558444ceafccfd0d00fcb2bb","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-15T19:38:54.721Z","from_sync":false,"order":39,"slug":"target-audience-transaction-import","title":"Target Audience Transaction Import"},"user":"59b80b74a2d5550038e23726","__v":4,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-20T21:13:38.108Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"code":"curl 'https://yourdatacenterid.qualtrics.com/API/v3/directories/POOL_012345678901234/mailinglists/CG_012345678901234/transactioncontacts/PGRS_012345678901234/summary' \\\n-X 'GET' \\\n-H 'X-API-TOKEN: yourtokenhere'","language":"curl"}]},"settings":"","results":{"codes":[{"name":"","code":"{\n  \"result\": {\n    \"percentComplete\": 100.0,\n    \"contacts\": {\n      \"count\": {\n        \"added\": 1,\n        \"updated\": 0,\n        \"failed\": 0\n      }\n    },\n    \"transactions\": {\n      \"count\": {\n        \"created\": 1\n      }\n    },\n    \"invalidEmails\": [\n         \"invalid:::at:::email\",\n         \"invalidemail\",\n         \"this.is.invalid\"\n     ],\n    \"status\": \"in progress\"\n  },\n  \"meta\": {\n    \"httpStatus\":\"200 - OK\",\n    \"requestId\":\"917f4d90-9166-4f40-b510-b416625c9d2d\"\n  }\n}","language":"json","status":200}]},"auth":"required","params":[{"_id":"58c05e34b803d2250035ef80","ref":"","in":"path","required":true,"desc":"The directory ID, also known as the pool ID","default":"","type":"string","name":"directoryId"},{"_id":"58be4f35a36fdf0f000a3f31","ref":"","in":"path","required":true,"desc":"The ID of the list for which the import request was initiated for","default":"","type":"string","name":"mailingListId"},{"_id":"58be4f35a36fdf0f000a3f30","ref":"","in":"path","required":true,"desc":"The ID from the response of [Import Transaction Contacts](doc:import-mailing-list-contacts-with-transactions)","default":"","type":"string","name":"importId"}],"url":"/v:version/directories/:directoryId/mailinglists/:mailingListId/transactioncontacts/:importId/summary"},"isReference":false,"order":2,"body":"This endpoint is a follow up to [Import Mailing List Contacts with Transactions](doc:import-mailing-list-contacts-with-transactions). This API call can be used to retrieve a full report of a contacts import. The \"contacts\" key returns a short summary of how many contacts were imported, updated, or failed to import. The \"transactions\" key returns the count of transactions that were added. The \"invalidEmails\" key returns an array of malformed emails that must be corrected before re-importing. \n[block:api-header]\n{\n  \"title\": \"Frequently Asked Questions\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Why are my counts all 0 for contacts and transactions, even though the percentComplete is 100?\",\n  \"body\": \"This situation usually indicates that you provided a **directoryId**, **mailingListId** or **transactionBatchId** that does not exist.\\n\\nIf the **directoryId**, **mailingListId** or **transactionBatchId** doesn't represent an existing (non-deleted) collection, you won't be able to import contacts or transactions into it.\"\n}\n[/block]","excerpt":"Retrieve the status of the associated import request","slug":"transaction-contacts-import-summary","type":"endpoint","title":"Transaction Contacts Import Summary"}

getTransaction Contacts Import Summary

Retrieve the status of the associated import request

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

directoryId:
required
string
The directory ID, also known as the pool ID
mailingListId:
required
string
The ID of the list for which the import request was initiated for
importId:
required
string
The ID from the response of [Import Transaction Contacts](doc:import-mailing-list-contacts-with-transactions)

Examples


Result Format


Documentation

This endpoint is a follow up to [Import Mailing List Contacts with Transactions](doc:import-mailing-list-contacts-with-transactions). This API call can be used to retrieve a full report of a contacts import. The "contacts" key returns a short summary of how many contacts were imported, updated, or failed to import. The "transactions" key returns the count of transactions that were added. The "invalidEmails" key returns an array of malformed emails that must be corrected before re-importing. [block:api-header] { "title": "Frequently Asked Questions" } [/block] [block:callout] { "type": "warning", "title": "Why are my counts all 0 for contacts and transactions, even though the percentComplete is 100?", "body": "This situation usually indicates that you provided a **directoryId**, **mailingListId** or **transactionBatchId** that does not exist.\n\nIf the **directoryId**, **mailingListId** or **transactionBatchId** doesn't represent an existing (non-deleted) collection, you won't be able to import contacts or transactions into it." } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}