{"_id":"5b0d6717d6bf55000336e4d0","project":"55dd9f2e0efd5821000d54d9","version":{"_id":"55dd9f4dab0e4d210045aae9","__v":47,"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","5b19051beece890003020163","5b34ded01cb20f000391ad6d","5b3a325acffe770003fd29e5","5b3c737a7f7b890003365501","5b3c929b367036000391b11e","5b7c1e210dc2e20003871521","5da48fa678007c00d3826dfd","5da4905f535c4a002716833a"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"category":{"_id":"55f0365c8563861700a33765","version":"55dd9f4dab0e4d210045aae9","__v":10,"pages":["560d337799bb5a0d0044f2ae","560d3c1799bb5a0d0044f2b9","560e8b1fdfdd5a2100e8efd8","560e8c31c4e4ae0d00b42f3e","560e8f5159cb8d0d0015cd21","560e8faccac9dc0d007af836","560e915739fad419002ae1a6","560e9264c4e4ae0d00b42f4a","560e954d39fad419002ae1aa","561fb03b9dc7ce0d00c38c90"],"project":"55dd9f2e0efd5821000d54d9","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-09T13:38:36.012Z","from_sync":false,"order":20,"slug":"transactional-data","title":"Transactional data"},"user":"55dd9841cafe7221002a4c62","githubsync":"","__v":5,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-05-29T14:43:35.314Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"[\n    {\n        \"key\": \"Resort001\",\n        \"contactIdentifier\": \"-1\",\n        \"json\": \"{\\r\\n  \\\"Name\\\": \\\"Playa del Fun\\\",\\r\\n  \\\"Country\\\": \\\"Spain\\\",\\r\\n  \\\"Stars\\\": 3.0000000000,\\r\\n  \\\"Category\\\": \\\"Family beach\\\",\\r\\n  \\\"Image\\\": \\\"https://www.123holidays.com/resorts/1/9/7/9/3/1/files/imagecache/63595/w20_124720_beachresort1.jpg\\\",\\r\\n  \\\"Short_desc\\\": \\\"Close to three water parks and the best beach around, this resort is a favourite with families.\\\",\\r\\n  \\\"From_price\\\": 412.0000000000,\\r\\n  \\\"Link\\\": \\\"https://www.123holidays.com/resorts/playa_del_fun\\\"\\r\\n}\"\n    }\n]","name":""}]},"method":"get","examples":{"codes":[{"code":"var url = \"/v2/transactional-data/Resorts\";\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}","language":"csharp","name":""},{"code":"","language":"json"},{"code":"$url = $baseUrl .  \"/v2/transactional-data/Resorts\";\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"}]},"settings":"","auth":"required","params":[{"_id":"560d3313ac2859170013fb14","ref":"","in":"path","required":true,"desc":"The name of the transactional data collection, which needs to be included within the URL","default":"","type":"string","name":"CollectionName"},{"_id":"5d5ab393d7ffed002d13b7ba","ref":"","in":"query","required":false,"desc":"The select parameter requires a number between 1 and 1000 (0 is not a valid number). You may only select a maximum of 1000 results in a single request. This parameter goes within the URL.","default":"","type":"int","name":"Select"},{"_id":"5d5aa991f412be007370a27c","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 1000 records you should set the select parameter to 1000 and the skip parameter to 1000, which will return records 1001 to 2000. 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/transactional-data/[CollectionName]?select=[Select]&skip=[Skip]"},"isReference":false,"order":10,"body":"This operation gets transactional data in a specified collection at an account level (transactional data that isn't associated with a contact).","excerpt":"Gets transactional data in a collection at account level","slug":"get-account-scoped-transactional-data","type":"endpoint","title":"Get account scoped transactional data"}

getGet account scoped transactional data

Gets transactional data in a collection at account level

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

CollectionName:
required
string
The name of the transactional data collection, which needs to be included within the URL

Query Params

Select:
integer
The select parameter requires a number between 1 and 1000 (0 is not a valid number). You may only select a maximum of 1000 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 1000 records you should set the select parameter to 1000 and the skip parameter to 1000, which will return records 1001 to 2000. 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 gets transactional data in a specified collection at an account level (transactional data that isn't associated with a contact).