{"_id":"59f24b4ffb936d003ad30405","project":"55843604fd8d910d007b9502","version":{"_id":"558444ceafccfd0d00fcb2bb","forked_from":"55843604fd8d910d007b9505","project":"55843604fd8d910d007b9502","__v":71,"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","5b55a46b282b25000319669e","5ba4b423a1a8660003a6b4dd","5ba969b5bdd51d0003cf152c","5bb87f6ea7fe7b0003b86e02","5bbf51fee658fb000339f503"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"category":{"_id":"59b054613c3e1b0019cf27d9","project":"55843604fd8d910d007b9502","version":"558444ceafccfd0d00fcb2bb","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-06T20:02:41.600Z","from_sync":false,"order":2,"slug":"using-target-audience","title":"Using iQ Directory"},"user":"5919f13aff66b00f00f1948c","githubsync":"","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-10-26T20:53:35.636Z","link_external":false,"link_url":"","sync_unique":"","hidden":true,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"The APIs discussed in this guide allow you to manage Target Audience incentives. For more information about incentives, see [Incentives Overview](https://www.qualtrics.com/support/target-audience/incentives/incentives-overview/).\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Target Audience Only\",\n  \"body\": \"These APIs are only available to Target Audience users.\"\n}\n[/block]\nThese samples use environment variables for configuration. See [Using the Code Samples with Your Installation](using-the-api-code-samples#using-the-code-samples-with-your-installation) for more infromation.\n\nThis guide contains information on the following APIs:\n\n- [Get Contact Incentive Points](#get-contact-incentive-points)\n- [Adjust Contact Incentive Points](#adjust-contact-incentive-points)\n[block:api-header]\n{\n  \"title\": \"Get Contact Incentive Points\"\n}\n[/block]\nThe following code example shows how to use the Get Contact Incentive Points API to obtain the current incentive balance for the specified contact (**contactId** in the example).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"# Get Contact Incentive Points\\n\\nimport os\\nimport requests\\n\\n# Setting user Parameters\\napiToken = os.environ[\\\"Q_API_TOKEN\\\"]\\ndataCenter = os.environ[\\\"Q_DATA_CENTER\\\"]\\ndirectoryId = os.environ[\\\"Q_TA_POOL_ID\\\"]\\n\\ncontactId=\\\"CID_5iI5K48mC6P48HX\\\"\\n\\nbaseUrl = \\\"https://{0}.qualtrics.com/API/v3/directories/{1}/contacts/{2}/incentivepoints\\\".format(dataCenter, directoryId, contactId)\\n\\nheaders = {\\n    \\\"x-api-token\\\": apiToken,\\n    \\\"Content-Type\\\": \\\"application/json\\\"\\n    }\\n\\nresponse = requests.get(baseUrl, headers=headers)\\nprint(response.text)\\n\",\n      \"language\": \"python\"\n    }\n  ]\n}\n[/block]\nThe response object returns the specified contact's current incentive points as shown below:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"meta\\\": {\\n        \\\"httpStatus\\\": \\\"200 - OK\\\",\\n        \\\"requestId\\\": \\\"16a6d781-f2a2-41e9-b67b-3ca077fadaf9\\\"\\n    },\\n    \\\"result\\\": {\\n        \\\"points\\\": 0\\n    }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Response\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Adjust Contact Incentive Points\"\n}\n[/block]\nThe following code example shows how to change the incentive points for a specified contact. You need to obtain a UUID for the **X-IDEMPOTENCY-KEY** header in order to use this API, and the code example shows how to do that.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"# Adjust Contact Incentive Points\\n\\nimport os\\nimport uuid\\nimport requests\\n\\n# Setting user Parameters\\napiToken = os.environ[\\\"Q_API_TOKEN\\\"]\\ndataCenter = os.environ[\\\"Q_DATA_CENTER\\\"]\\ndirectoryId = os.environ[\\\"Q_TA_POOL_ID\\\"]\\n\\ncontactId=\\\"CID_5iI5K48mC6P48HX\\\"\\nkey = str(uuid.uuid4())\\n\\nbaseUrl = \\\"https://{0}.qualtrics.com/API/v3/directories/{1}/contacts/{2}/incentivepoints\\\".format(dataCenter, directoryId, contactId)\\n\\nheaders = {\\n    \\\"x-api-token\\\": apiToken,\\n    \\\"x-idempotency-key\\\": key,\\n    \\\"Content-Type\\\": \\\"application/json\\\"\\n    }\\n\\ndata = {\\n    \\\"points\\\": 4\\n    }\\n\\nresponse = requests.post(baseUrl, headers=headers, json=data)\\nprint(response.text)\\n\",\n      \"language\": \"python\"\n    }\n  ]\n}\n[/block]\nThe response object shows success with a 200 status as shown below:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"meta\\\": {\\n        \\\"httpStatus\\\": \\\"200 - OK\\\",\\n        \\\"requestId\\\": \\\"d83bd90e-3057-4a8d-86c2-75f00e630d92\\\"\\n    }\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Response\"\n    }\n  ]\n}\n[/block]","excerpt":"APIs for using incentives with Target Audience","slug":"managing-target-audience-incentives","type":"basic","title":"Managing iQ Directory Incentives"}

Managing iQ Directory Incentives

APIs for using incentives with Target Audience

The APIs discussed in this guide allow you to manage Target Audience incentives. For more information about incentives, see [Incentives Overview](https://www.qualtrics.com/support/target-audience/incentives/incentives-overview/). [block:callout] { "type": "warning", "title": "Target Audience Only", "body": "These APIs are only available to Target Audience users." } [/block] These samples use environment variables for configuration. See [Using the Code Samples with Your Installation](using-the-api-code-samples#using-the-code-samples-with-your-installation) for more infromation. This guide contains information on the following APIs: - [Get Contact Incentive Points](#get-contact-incentive-points) - [Adjust Contact Incentive Points](#adjust-contact-incentive-points) [block:api-header] { "title": "Get Contact Incentive Points" } [/block] The following code example shows how to use the Get Contact Incentive Points API to obtain the current incentive balance for the specified contact (**contactId** in the example). [block:code] { "codes": [ { "code": "# Get Contact Incentive Points\n\nimport os\nimport requests\n\n# Setting user Parameters\napiToken = os.environ[\"Q_API_TOKEN\"]\ndataCenter = os.environ[\"Q_DATA_CENTER\"]\ndirectoryId = os.environ[\"Q_TA_POOL_ID\"]\n\ncontactId=\"CID_5iI5K48mC6P48HX\"\n\nbaseUrl = \"https://{0}.qualtrics.com/API/v3/directories/{1}/contacts/{2}/incentivepoints\".format(dataCenter, directoryId, contactId)\n\nheaders = {\n \"x-api-token\": apiToken,\n \"Content-Type\": \"application/json\"\n }\n\nresponse = requests.get(baseUrl, headers=headers)\nprint(response.text)\n", "language": "python" } ] } [/block] The response object returns the specified contact's current incentive points as shown below: [block:code] { "codes": [ { "code": "{\n \"meta\": {\n \"httpStatus\": \"200 - OK\",\n \"requestId\": \"16a6d781-f2a2-41e9-b67b-3ca077fadaf9\"\n },\n \"result\": {\n \"points\": 0\n }\n}", "language": "json", "name": "Response" } ] } [/block] [block:api-header] { "title": "Adjust Contact Incentive Points" } [/block] The following code example shows how to change the incentive points for a specified contact. You need to obtain a UUID for the **X-IDEMPOTENCY-KEY** header in order to use this API, and the code example shows how to do that. [block:code] { "codes": [ { "code": "# Adjust Contact Incentive Points\n\nimport os\nimport uuid\nimport requests\n\n# Setting user Parameters\napiToken = os.environ[\"Q_API_TOKEN\"]\ndataCenter = os.environ[\"Q_DATA_CENTER\"]\ndirectoryId = os.environ[\"Q_TA_POOL_ID\"]\n\ncontactId=\"CID_5iI5K48mC6P48HX\"\nkey = str(uuid.uuid4())\n\nbaseUrl = \"https://{0}.qualtrics.com/API/v3/directories/{1}/contacts/{2}/incentivepoints\".format(dataCenter, directoryId, contactId)\n\nheaders = {\n \"x-api-token\": apiToken,\n \"x-idempotency-key\": key,\n \"Content-Type\": \"application/json\"\n }\n\ndata = {\n \"points\": 4\n }\n\nresponse = requests.post(baseUrl, headers=headers, json=data)\nprint(response.text)\n", "language": "python" } ] } [/block] The response object shows success with a 200 status as shown below: [block:code] { "codes": [ { "code": "{\n \"meta\": {\n \"httpStatus\": \"200 - OK\",\n \"requestId\": \"d83bd90e-3057-4a8d-86c2-75f00e630d92\"\n }\n}", "language": "json", "name": "Response" } ] } [/block]