{"_id":"5ca636df3e07ad00344d141a","project":"55dd9f2e0efd5821000d54d9","version":{"_id":"55dd9f4dab0e4d210045aae9","__v":45,"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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"category":{"_id":"55e047a9a44fae0d00214672","project":"55dd9f2e0efd5821000d54d9","version":"55dd9f4dab0e4d210045aae9","__v":22,"pages":["55eda104a872a80d00acffa7","55eda7d9df21af2b009e21ec","55eda8e1ec4c3e3900b75676","55edad128dcb210d00568ff0","55edae26df21af2b009e21f9","55edb180a872a80d00acffcd","55edb8778dcb210d00569009","55ef0935e7f5490d000c0e1e","55ef0e40bfb7ae0d0013ad92","55ef121cb97ce63700d0599b","55ef18198eb7ae0d00feeb58","55f0526c8a93b22b0083fed3","55f054af8a93b22b0083fed5","55f0553aa1f8a4230086c79d","55f297f91741861700249dc4","55f2a7e4d1c4c7170033df23","55f2a8c4fb7aad2300bf17c2","55f2aabed1c4c7170033df27","55f2acbe525cb12300c6c4e2","560158002499c119000fae2c","560163939137690d00335741","56016d072499c119000fae94"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-28T11:36:09.580Z","from_sync":false,"order":6,"slug":"campaigns","title":"Campaigns"},"user":"55dd9841cafe7221002a4c62","__v":11,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-04-04T16:54:55.000Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[{"language":"csharp","code":"var url = \"/v2/campaigns/1/activities/23/clicks\";\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}"}]},"results":{"codes":[{"status":200,"language":"json","code":"[\n  {\n    \"contactId\": 23,\n    \"email\": \"nelson.redeker:::at:::example.com\",\n    \"url\": \"http://company123.com/holidays\",\n    \"ipAddress\": \"192.168.93.223\",\n    \"userAgent\": \"Mozilla/4.0 (compatible; MSIE 7.0; Windows NT 6.0; SLCC1; .NET CLR 2.0.50727; .NET CLR 3.0.04506; InfoPath.2)\",\n    \"dateClicked\": \"2013-01-02T17:52:00\",\n    \"keyword\": \"Alexandria holiday deals\",\n    \"groups\": [\n      {\n        \"name\": \"africa\",\n        \"dateCreated\": \"2019-03-01T14:55:38.2566667\"\n      },\n      {\n        \"name\": \"egypt\",\n        \"dateCreated\": \"2019-03-07T12:18:13.69\"\n      }\n    ]\n  }\n]","name":""}]},"settings":"","auth":"required","params":[{"_id":"5ca63ebf2df53900190ba34b","ref":"","in":"path","required":true,"desc":"This is the ID of the campaign, which needs to be included within the URL","default":"","type":"int","name":"CampaignID"},{"_id":"5ca63ebf2df53900190ba34a","ref":"","in":"path","required":false,"desc":"This is the ID of the contact, which needs to be included within the URL","default":"","type":"int","name":"ContactID"},{"_id":"5ca63ebf2df53900190ba349","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":"5ca63ebf2df53900190ba348","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":"http://api.dotmailer.com/v2/campaigns/[CampaignID]/activities/[ContactID]/clicks-with-groups?select=[Select]&skip=[Skip]"},"isReference":false,"order":28,"body":"This operation returns a list of clicks for links, along with the links' assigned link groups, by a specified contact in a specified campaign.","excerpt":"Gets a list of campaign link clicks, with assigned link groups, for a contact","slug":"get-campaign-contact-clicks-and-link-groups","type":"endpoint","title":"Get campaign contact clicks and link groups"}

getGet campaign contact clicks and link groups

Gets a list of campaign link clicks, with assigned link groups, for a contact

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

CampaignID:
required
integer
This is the ID of the campaign, which needs to be included within the URL
ContactID:
integer
This is the ID of the contact, 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 returns a list of clicks for links, along with the links' assigned link groups, by a specified contact in a specified campaign.