{"_id":"5627ca6866c62617009d1844","category":{"_id":"5627ca43fcbbc621004ec07d","project":"55843604fd8d910d007b9502","version":"558444ceafccfd0d00fcb2bb","__v":7,"pages":["5627ca593a4c6b0d00c455e9","5627ca6866c62617009d1844","5627ca823a4c6b0d00c455eb","5627ca9c22ef6a2100fb3513","56292b022c0fd9190067da82","5632ce9310b6040d0087944b","56df6582c0e74f0e00ba6ce6"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-21T17:24:19.325Z","from_sync":false,"order":0,"slug":"api","title":"API"},"__v":58,"project":"55843604fd8d910d007b9502","user":"558435c2fb52ee0d0015d190","version":{"_id":"558444ceafccfd0d00fcb2bb","forked_from":"55843604fd8d910d007b9505","project":"55843604fd8d910d007b9502","__v":45,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-21T17:24:56.718Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"The base API url consists of the qualtrics hostname for your organization followed by `/API`. The schema must be `https`.\n\nExample base url:\n`https://yourdatacenterid.qualtrics.com/API`\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"How to Find your API hostname\"\n}\n[/block]\n1. Login to your Qualtrics account\n2. Use the hostname found in the location bar\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/TAWAHy34RzCSEF9ua9id_Screen%20Shot%202016-04-05%20at%209.48.02%20AM.png\",\n        \"Screen Shot 2016-04-05 at 9.48.02 AM.png\",\n        \"707\",\n        \"113\",\n        \"#047cc4\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nYour hostname should have one of the following formats:\n`yourorganizationid.yourdatacenterid.qualtrics.com`\n`yourdatacenterid.qualtrics.com`\n`yourorganizationid.qualtrics.com`\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"What if I use the wrong hostname?\"\n}\n[/block]\nAPI calls will still work if you use the wrong hostname. However, your request will be proxied to the correct data center. This will significantly extend the time it takes for you to receive a response. You will know your request was proxied since the `meta` field will contain the following notice:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"result\\\": {\\n  ...\\n  },\\n  \\\"meta\\\": {\\n    \\\"httpStatus\\\": \\\"200 - OK\\\",\\n    \\\"requestId\\\": \\\"b698813c-bde1-4734-85e6-931b2db3e83a\\\",\\n    \\\"notice\\\": \\\"Request proxied. For faster response times, use this host instead: yourdatacenterid.qualtrics.com\\\"\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"root-url","type":"basic","title":"Base URL and Data Center IDs"}

Base URL and Data Center IDs


The base API url consists of the qualtrics hostname for your organization followed by `/API`. The schema must be `https`. Example base url: `https://yourdatacenterid.qualtrics.com/API` [block:api-header] { "type": "basic", "title": "How to Find your API hostname" } [/block] 1. Login to your Qualtrics account 2. Use the hostname found in the location bar [block:image] { "images": [ { "image": [ "https://files.readme.io/TAWAHy34RzCSEF9ua9id_Screen%20Shot%202016-04-05%20at%209.48.02%20AM.png", "Screen Shot 2016-04-05 at 9.48.02 AM.png", "707", "113", "#047cc4", "" ] } ] } [/block] Your hostname should have one of the following formats: `yourorganizationid.yourdatacenterid.qualtrics.com` `yourdatacenterid.qualtrics.com` `yourorganizationid.qualtrics.com` [block:api-header] { "type": "basic", "title": "What if I use the wrong hostname?" } [/block] API calls will still work if you use the wrong hostname. However, your request will be proxied to the correct data center. This will significantly extend the time it takes for you to receive a response. You will know your request was proxied since the `meta` field will contain the following notice: [block:code] { "codes": [ { "code": "{\n \"result\": {\n ...\n },\n \"meta\": {\n \"httpStatus\": \"200 - OK\",\n \"requestId\": \"b698813c-bde1-4734-85e6-931b2db3e83a\",\n \"notice\": \"Request proxied. For faster response times, use this host instead: yourdatacenterid.qualtrics.com\"\n }\n}", "language": "json" } ] } [/block]