{"_id":"56016d072499c119000fae94","user":"55dd9841cafe7221002a4c62","version":{"_id":"55dd9f4dab0e4d210045aae9","__v":39,"project":"55dd9f2e0efd5821000d54d9","createdAt":"2015-08-26T11:13:17.024Z","releaseDate":"2015-08-26T11:13:17.024Z","categories":["55dd9f4dab0e4d210045aaea","55ddb5fa9067202b00ddff6f","55e0472c6bad670d0081f213","55e04764a44fae0d00214671","55e047a9a44fae0d00214672","55e047b258c5460d0076a9a7","55e95e337fc27b2d00d32cf2","55e979bda7ca823900ad549a","55edb8c18dcb210d0056900b","55f0365c8563861700a33765","55f03677d58f9b1900acf996","55f036938eeefc23001ea5de","55f036a38563861700a33767","55f036c08563861700a33769","55f036d02911b72100482cd7","55f036e92911b72100482cd9","55f036fa8563861700a3376b","55f0370ee507711900e58c69","55f0371df6101b1900c70700","55f0374f2911b72100482cdb","55f0375e2911b72100482cdc","560eb0f659cb8d0d0015cd52","560eb25239fad419002ae1e0","561fb64d4d67490d00804b2a","562b9f775a39cd0d009aff22","562ba0505a39cd0d009aff23","562ba149d56bc30d00f0cb18","562ba595f68a5f0d007b1f3b","562ba78fd56bc30d00f0cb1b","562ba8b95a39cd0d009aff27","562baadf6562140d001501d2","562bab37f68a5f0d007b1f3d","562bc1bf9ebc950d000f7523","562bc99ced4bea0d00c11dfa","562bd29c1b98640d00714520","562bd5875a39cd0d009aff60","562bdfabff2da50d002c0aaf","562be0bd5a39cd0d009aff75","57a0b476d8313e1900454439"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"category":{"_id":"55f0374f2911b72100482cdb","project":"55dd9f2e0efd5821000d54d9","version":"55dd9f4dab0e4d210045aae9","__v":5,"pages":["560e5d99dfdd5a2100e8ef9b","560e608a54af2b0d005bbf01","560e63de39fad419002ae176","560e687afb97be0d0042beda","560e8369fb97be0d0042bef3"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-09T13:42:39.755Z","from_sync":false,"order":14,"slug":"surveys-and-forms","title":"Surveys and forms"},"editedParams2":true,"editedParams":true,"__v":2,"parentDoc":null,"project":"55dd9f2e0efd5821000d54d9","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-22T15:00:23.209Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"csharp","name":"","code":"var url = \"/v2/surveys?assignedToAddressBookOnly=false\";\n\nusing (var httpClient = new HttpClient())\n{\n\thttpClient.BaseAddress = new Uri(\"https://api.dotmailer.com\");\n\tvar credentials = Encoding.ASCII.GetBytes(\"username:password\");\n\thttpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(\"Basic\", Convert.ToBase64String(credentials));\n\tvar result = httpClient.GetAsync(url).Result;\n}"},{"code":"","language":"json"},{"code":"$url = $baseUrl . “/v2/surveys?assignedToAddressBookOnly=false“;\n$ch = curl_init();\ncurl_setopt($ch, CURLOPT_URL, $url);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt(\n\t$ch, CURLOPT_HTTPHEADER, array('Accept: application/json',\n    \t'Content-Type: application/json')\n);\ncurl_setopt($ch, CURLAUTH_BASIC, CURLAUTH_DIGEST);\ncurl_setopt(\n\t$ch, CURLOPT_USERPWD,\n    $apiUsername . ':' . $apiPassword\n);\n\t\t\t\n$response = json_decode(curl_exec($ch));","language":"php"}]},"method":"get","results":{"codes":[{"code":" {\n    \"id\": 1,\n    \"name\": \"Event Registration Form\",\n    \"url\": \"https://dotmailer-surveys.com/001ln562-3411pu49\",\n    \"dateSurveyCreated\": \"2014-11-07T15:56:36.1016491Z\",\n    \"dateSurveyModified\": \"2015-07-15T15:55:07.0531132Z\",\n    \"state\": \"Active\",\n    \"firstActiveDate\": \"2014-11-19T10:55:09.8345347Z\",\n    \"lastInactiveDate\": null,\n    \"scheduledStartDate\": null,\n    \"scheduledEndDate\": null,\n    \"confirmationMode\": \"Text\",\n    \"submissionMode\": \"Single\",\n    \"fieldCount\": 10,\n    \"notifyCreatorOnResponse\": false,\n    \"respondentNotificationType\": \"None\",\n    \"respondentNotificationCampaignId\": null,\n    \"isAssignedToAddressBook\": false,\n    \"assignedAddressBookTarget\": \"AllContacts\",\n    \"assignedSpecificAddressBookId\": null,\n    \"firstResponseDate\": \"2014-11-19T11:00:10.153Z\",\n    \"lastResponseDate\": \"2015-06-05T10:37:51.793Z\",\n    \"totalCompleteResponses\": 18,\n    \"totalCompleteResponsesInLastDay\": 1,\n    \"totalCompleteResponsesInLastWeek\": 1,\n    \"totalIncompleteResponses\": 0,\n    \"totalViews\": 19,\n    \"totalBounces\": 1,\n    \"timeToCompleteMax\": 12430747,\n    \"timeToCompleteMin\": 1,\n    \"timeToCompleteTotal\": 12432973,\n    \"sourceDirectTotal\": 0,\n    \"sourceEmailTotal\": 20,\n    \"sourceEmbeddedTotal\": 0,\n    \"sourcePopoverTotal\": 0,\n    \"sourceFacebookTotal\": 0,\n    \"sourceTwitterTotal\": 0,\n    \"sourceGooglePlusTotal\": 0,\n    \"sourceOtherTotal\": 0\n  }","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"56016da12499c119000fae96","ref":"","in":"query","required":false,"desc":"This parameter can be set to 'true' to only retrieve surveys assigned to an address book, and 'false' to only retrieve surveys that aren't assigned to an address book. This parameter goes within the URL.","default":"","type":"boolean","name":"AssignedToAddressBookOnly"},{"_id":"55ddc1fdbfd5072d002e7b01","ref":"","in":"query","required":false,"desc":"The select parameter requires a number between 1 and 500 (0 is not a valid number). You may only select a maximum of 500 results in a single request. This parameter goes within the URL.","default":"","type":"int","name":"Select"},{"_id":"55f2ad22d1c4c7170033df29","ref":"","in":"query","required":false,"desc":"The skip parameter should be used in tandem with the select parameter when wanting to iterate through a whole data set. If you want to select the next 500 records you should set the select parameter to 500 and the skip parameter to 500, which will return records 501 to 1000. You should continue to do this until 0 records are returned to retrieve the whole data set. This parameter goes within the URL.","default":"","type":"int","name":"Skip"}],"url":"/v:version/surveys?assignedToAddressBookOnly=[AssignedToAddressBookOnly]&select=[Select]&skip=[Skip]"},"isReference":false,"order":0,"body":"This operation retrieves all existing surveys within the account.","excerpt":"Gets a list of all surveys in the account","slug":"get-surveys","type":"endpoint","title":"Get surveys"}

getGet surveys

Gets a list of all surveys in the account

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

AssignedToAddressBookOnly:
boolean
This parameter can be set to 'true' to only retrieve surveys assigned to an address book, and 'false' to only retrieve surveys that aren't assigned to an address book. This parameter goes within the URL.
Select:
integer
The select parameter requires a number between 1 and 500 (0 is not a valid number). You may only select a maximum of 500 results in a single request. This parameter goes within the URL.
Skip:
integer
The skip parameter should be used in tandem with the select parameter when wanting to iterate through a whole data set. If you want to select the next 500 records you should set the select parameter to 500 and the skip parameter to 500, which will return records 501 to 1000. You should continue to do this until 0 records are returned to retrieve the whole data set. This parameter goes within the URL.

Examples


Result Format


Documentation

This operation retrieves all existing surveys within the account.