Jump to Content
Dotdigital APIGuidesRecipesAPI Reference
HomeGuidesRecipesAPI Reference
GuidesRecipesAPI ReferenceLog inHelp centreDotdigital API
API Reference
Log inHelp centre

Accounts and Utilities

  • Get account informationget
  • Get server timeget
  • Empty recycle binpost

Contacts and Data

  • Contacts
    • Get contacts based on your criteriaget
    • Retrieve the status of a contacts import requestget
    • Import contact collectionput
    • Retrieve a contact by an identifierget
    • Retrieve the status of a delete contacts jobget
    • Delete multiple contactspost
    • Create a contactpost
    • Replace a contactput
    • Deletes a contact using a specific identifierdelete
    • Import a single contactpatch
  • Contact data fields
    • Create contact data fieldpost
    • Delete contact data fielddelete
    • Get contact data fieldsget
  • Lists / Address books
    • Create listpost
    • Delete listdelete
    • Update listput
    • Get listget
    • Get listsget
    • Get private listsget
    • Get public listsget
    • Get unsubscribed from list since dateget
    • Unsubscribe contact from listpost
    • Resubscribe contact to listpost
    • Resubscribe contact to list with no challengepost
    • Delete contact from listdelete
    • Delete contacts from listpost
    • Delete all contacts from listpost
    • Get bulk contact deletion progressget
  • Preferences and subscriptions
    • Unsubscribe contactpost
    • Bulk suppress contactsput
    • Resubscribe contactpost
    • Resubscribe contact with no challengepost
    • Get suppressed contacts since dateget
    • Get subscriptions for contactget
    • Get unsubscribed contacts since dateget
    • Create preferencepost
    • Update preferenceput
    • Get preferencesget
    • Get modified preferences since dateget
    • Delete preferencedelete
    • Set preferences for contactput
    • Get preferences for contactget
    • Get contacts opted into a preference and an address bookget
    • Get contacts opted into a preferenceget
    • Get contacts with modified preference opt-in since dateget
    • Get contacts with modified preference opt-in in address book since dateget
  • Segments
    • Get segmentsget
    • Refresh segmentpost
    • Get refresh progress for segmentget
  • Scoring
    • Get scoring for contactsget
    • Get scoring modified since date for contactsget
    • Get scoring for contactget
    • Get scoring for contacts in address bookget

Insight Data

  • Insight data
    • Retrieve the status of an asynchronous requestget
    • Lists all Insight data collectionsget
    • Creates an Insight data collectionpost
    • Empties an Insight data collectiondelete
    • Gets the JSON schema for an Insight data collectionget
    • Deletes an Insight data collectiondelete
  • Bulk import
    • Bulk imports Insight dataput
    • Retrieve the status of a Insight data import requestget
  • Account collections
    • List account Insight data collectionsget
    • Retrieves records from an accounts Insight data collectionget
    • Retrieve single record from an account Insight data collectionget
    • Upsert record into an account Insight data collectionput
    • Delete record from an account Insight data collectiondelete
  • Contacts collections
    • Retrieve data for contact-scoped Insight data collectionget
    • Retrieve records for a contact from Insight data collectionget
    • List Insight data collections for a contactget
    • Empty Insight data collection for a contactdelete
    • Retrieve Insight data record for a contactget
    • Upsert record into Insight data collection for a contactput
    • Delete record from Insight data collection for a contactdelete

Marketing and Automation

  • Email Campaigns
    • Create campaignpost
    • Create split test campaignpost
    • Update campaignput
    • Copy campaignpost
    • Delete campaigndelete
    • Send campaignpost
    • Send time optimised campaignpost
    • Get campaign send statusget
    • Add campaign attachmentpost
    • Remove campaign attachmentdelete
    • Get campaign attachmentsget
    • Get all campaignsget
    • Get campaigns sent to address book or segmentget
    • Get campaignget
    • Get campaign with detailsget
    • Get campaign summaryget
    • Get campaign opensget
    • Get campaign opens for a contactget
    • Get campaign activity for a contactget
    • Get campaign activity since dateget
    • Get campaign clicksget
    • Get campaign clicks and link groupsget
    • Get campaign clicks since dateget
    • Get campaign clicks and link groups since dateget
    • Get campaign opens since dateget
    • Get campaign activityget
    • Get campaign address booksget
    • Get campaign clicks for a contactget
    • Get campaign contact clicks and link groupsget
    • Get campaigns with activity since dateget
    • Get campaign page views for a contactget
    • Get campaign page views since dateget
    • Get campaign replies for a contactget
    • Get campaign ROI activity for a contactget
    • Get campaign ROI activity since dateget
    • Get campaign social bookmark viewsget
    • Get campaign social bookmark views for a contactget
    • Get campaign hard bouncersget
    • Get campaign split test resultsget
    • Get custom from addressesget
    • Get campaign revenue since dateget
    • Get campaign revenue for contactget
  • Campaign Templates
    • Create templatepost
    • Get template by idget
    • Get templatesget
    • Update templateput
  • Documents
    • Create document folderpost
    • Get document foldersget
    • Get documents in folderget
    • Upload documentpost
  • Images
    • Create image folderpost
    • Get image foldersget
    • Get image folders by idget
    • Upload campaign imagepost
  • Pages and forms
    • Get formsget
    • Get form by IDget
    • Get forms with activity since dateget
    • Get form fieldsget
    • Get form responsesget
    • Get form responses with activity since dateget
  • Programs
    • Create program enrolmentpost
    • Get programsget
    • Get program by IDget
    • Get program enrolment report faultsget
    • Get program enrolmentget
    • Get program enrolments by statusget
  • Product recommendations
    • Get all product recommendationsget
  • SMS campaigns
    • Create SMS campaignpost
    • Copy SMS campaignpost
    • Get SMS campaignget
    • Get SMS campaignsget
    • Update SMS campaignput
    • Delete SMS campaigndelete
    • Send SMS messagepost

Communications

  • App Messaging
    • Registering your app users
    • Creating a JWT for an app user
    • Android
    • iOS
    • Javascript
    • Cordova
  • Content API
    • Upload a filepost
    • Retrieve a fileget
    • Delete a filedelete
  • Email2SMS
  • Omnichannel messaging
    • Calling the Omnichannel API
    • Addressing your messages
    • Channel selection
    • Cross channel messaging
    • Custom messages
    • Multi part messages
    • Templates
    • Additional options
    • Message send response
    • Inbound messages and receipts
  • Omnichannel channels
    • SMS
      • Get SMS phone numberget
      • Get SMS shortcodesget
      • Get SMS keywordsget
    • MMS
    • Push
    • WhatsApp
    • Facebook Messenger
    • App Messaging
  • Omnichannel API
    • Send a batch of new messagespost
    • Send a new messagepost
    • Retrieves the current state of a specific message.get
    • Deletes a Messagedelete
    • Patches a Messagepatch
    • Posts an inbound messagepost
    • Posts a status for an inboundpost
    • Posts a status for a messagepost
    • Retrieves message history for a profileget
  • Phone number validation
    • Validates a single phone numberget
  • Templates
    • Create a templatepost
    • Retrieves a list of all available templatesget
    • Retrieves a templateget
    • Updates a templateput
    • Deletes a templatedelete
  • Transactional email
    • Send transactional emailpost
    • Send batch transactional emailpost
    • Send transactional email using a triggered campaignpost
    • Send batch transactional email using a triggered campaignpost
    • Get transactional email statisticsget
    • Transactional Email via SMTP
  • Webhooks
    • Message Events
    • Omnichannel Profile Events
    • Facebook Events
    • App Messaging - Conversation Events
    • App Messaging - Message Events
    • App Messaging - Session Events
    • Chat - Events
    • Chat - Message Events
    • Chat - Presence Events
  • Webhooks API
    • Create a webhook configurationpost
    • Retrieves a webhook configurationget
    • Deletes a webhook configurationdelete
    • Updates a webhook configurationput
    • Retrieves a webhook configurationget
    • Retrieves a webhook available eventsget
    • Gets a list of available events templates that the caller can use when creating webhookget

Firehose Events

  • Large objects
    • Retrieve large objectget

Session API

  • /cpaas/sessions/tokens/anon
    • Gets a token that can be used to start an anonymous sessionget
  • /cpaas/sessions/{id}
    • Retrieves details about a sessionget
    • Ends a session, revoking access to services.delete

Analytics API

  • /cpaas/analytics/conversationmessages
    • Retrieves conversation message analyticsget
  • /cpaas/analytics/messages
    • Retrieves message analyticsget
  • /cpaas/analytics/sessions
    • Retrieves session analyticsget
  • /cpaas/analytics/sms/tracking
    • Retrieves url tracking analyticsget
  • /cpaas/analytics/sms/verify
    • Retrieves sms verify analyticsget
  • /cpaas/analytics/sms/inbound
    • Retrieves inbound SMS analyticsget
  • /cpaas/analytics/sms/outbound
    • Retrieves outbound SMS analyticsget

Chat Config API

  • /cpaas/chat/config
    • Retrieves the chat configuration for an apiSpaceget
  • /cpaas/chat/config/teams/{teamId}
    • Retrieves the members of a teamget
    • Removes the config for a teamdelete
  • /cpaas/chat/config/teams/{teamId}/appMessaging
    • Update the App Messaging config for a teamput
    • Removes the App Messaging config for a teamdelete
  • /cpaas/chat/config/teams/{teamId}/settings
    • Update general settings for a teamput
    • Removes the settings for a teamdelete

Chat Message API

  • /cpaas/chats/{chatId}/events
    • Retrieves a chat's eventsget
  • /cpaas/chats/{chatId}/messages
    • Retrieves a chat's messages from an point (event) in time and works backwardsget
    • Sends a message to chatpost
  • /cpaas/chats/{chatId}/messages/statusupdates
    • Posts message updates backpost

Chat API

  • /cpaas/chats/{chatId}
    • Retrieves a chatget
    • Updates a chatput
    • Deletes a chatdelete
  • /cpaas/chats/{chatId}/assign
    • Assigns a chatput
  • /cpaas/chats/{chatId}/close
    • Closes a chatput
  • /cpaas/chats/{chatId}/channel
    • Changes the channel for an existing chatput
  • /cpaas/chats/{chatId}/form
    • Sends a form to a chatpost
  • /cpaas/chats
    • Retrieves a list of chatsget
    • Creates a new chatpost
  • /cpaas/chats/{chatId}/typing
    • Indicates that the caller is typing in this chatpost
    • Indicates that the caller has stopped typing in this chatdelete
  • /cpaas/chats/{chatId}/participants
    • Retrieves the chat participantsget

Conversation Message API

  • /cpaas/conversations/{conversationId}/events
    • Retrieves a conversation's eventsget
  • /cpaas/conversations/{conversationId}/messages
    • Retrieves a conversation's messages from an point (event) in time and works backwardsget
    • Sends a message to conversationpost
  • /cpaas/conversations/{conversationId}/messages/statusupdates
    • Posts message updates backpost

Conversation API

  • /cpaas/conversations/{conversationId}
    • Retrieves a conversationget
    • Updates a conversationput
    • Deletes a conversationdelete
  • /cpaas/conversations
    • Retrieves a list of conversationsget
    • Creates a new conversationpost
  • /cpaas/conversations/{conversationId}/typing
    • Indicates that the caller is typing in this conversationpost
    • Indicates that the caller has stopped typing in this conversationdelete
  • /cpaas/conversations/{conversationId}/participants
    • Retrieves the conversation participantsget
    • Adds a list of participants to a conversationpost
    • Deletes a list of participants from a conversationdelete

Message Rules API

  • /cpaas/automation/inboundrules
    • Retrieves a message rules configuration listget
    • Create a message rule configurationpost
  • /cpaas/automation/inboundrules/{messageRulesId}
    • Retrieves single message rule configurationget
    • Update single message rule configurationput
    • Delete single message rule configurationdelete

Chat Presence API

  • /cpaas/presence
    • Retrieves the presence for a list of agent's profileIdsget
  • /cpaas/presence/appmessaging
    • Retrieves the presence for a list of user's profileIdsget

Profile API

  • /cpaas/profiles/export
    • Exports the result of a profile query in a formatted file for downloadpost
  • /cpaas/profiles/bulk
    • Deletes the requested profilesdelete
    • Creates or updates the supplied profiles with the supplied datapatch
  • /cpaas/profiles/{id}
    • Retrieves a Profileget
    • Updates or undeletes a Profileput
    • Deletes a Profiledelete
    • Patches a Profilepatch
  • /cpaas/profiles/{id}/optin
    • Set profile opt in for specified channelsput
    • Set profile opt in for specified channelsdelete
  • /cpaas/profiles/{id}/rels/primary/{linkedId}
    • Creates a relationship where the linked profile is the primary and this profile is a childput
    • Deletes the profile's relationship to a primary profiledelete
  • /cpaas/profiles/{id}/rels/link/{linkedId}
    • Creates a relationship where this profile is the primary and the linked profile is a childput
    • Deletes the primary profile's relationship to a linked Profiledelete
  • /apispaces/{apiSpaceId}/profiles/{id}/devices/{deviceId}
    • Removes device from profile and closes related opened sessionsdelete
  • /apispaces/{apiSpaceId}/profiles/devices/push/validation
    • Retrieves push capabilities summarypost
  • /cpaas/profiles
    • Query profilesget
    • Creates a new Profilepost
  • /cpaas/profiles/optin
    • Gets default profiles opt in/out options for each channel in channel serviceget
    • Set default profiles opt in/out options for each channel in channel serviceput

Deprecated

  • Address books
    • Add contact to address bookpost
    • Bulk import contacts in address book with merge optionpost
    • Get modified contacts in address book since dateget
    • Get contacts from address bookget
  • Email Contacts
    • Create contactpost
    • Create contact with consentpost
    • Create contact with consent and preferencespost
    • Bulk import contacts collectionpost
    • Bulk import contactspost
    • Bulk import contacts in address bookpost
    • Get contact import statusget
    • Get contact import reportget
    • Get contact import report faultsget
    • Update contact with consent and preferencesput
    • Delete contactdelete
    • Get contactget
    • Get contact with consentget
    • Get contact address booksget
    • Get all contacts countget
    • Get contactsget
    • Get contacts created since dateget
    • Get modified contacts since dateget
    • Update contact with consentput
    • Update contactput
  • Facebook API
    • Facebook Meta Data Servicepost
  • Insight and transactional data
    • Add transactional data to contactpost
    • Bulk add transactional data to contactspost
    • Replace transactional data by keypost
    • Get transactional data import statusget
    • Get transactional data import reportget
    • Get transactional data collection for contact by emailget
    • Get transactional data by keyget
    • Get account scoped transactional dataget
    • Get transactional data collectionsget
    • Delete transactional data collection for contact by iddelete
    • Delete transactional data collection for contact by emaildelete
    • Delete transactional data by keydelete
    • Empty transactional data collectionput
  • SOAP API
    • SOAP - Account
      • GetCurrentAccountInfo
      • EmptyRecycleBin
    • SOAP - Address books
      • CreateAddressBook
      • UpdateAddressBook
      • DeleteAddressBook
      • GetAddressBooks
      • GetAddressBookById
      • GetAddressBooksForCampaign
      • GetAddressBooksForContact
      • AddContactToAddressBook
      • ImportContactsToAddressBook
      • ImportContactsToAddressBookWithMergeOption
      • GetContactsInAddressBook
      • GetModifiedContactsInAddressBook
      • GetContactsScoreInAddressBook
      • GetContactsInAddressBookWithPreference
      • GetModifiedPreferencesOptInsByAddressBook
      • UnsubscribeContactFromAddressBook
      • GetUnsubscribedContactsInAddressBook
      • ResubscribeContactToAddressBook
      • ResubscribeContactToAddressBookWithNoChallenge
      • DeleteContactFromAddressBook
      • DeleteContactsFromAddressBook
      • DeleteAllContactsFromAddressBook
    • SOAP - Campaigns
      • CreateCampaign
      • CreateSplitTestCampaign (beta)
      • CopyCampaign
      • UpdateCampaign
      • SendCampaign
      • SendTimeOptimisedCampaign
      • DeleteCampaign
      • GetCampaignSendProgress
      • AttachDocumentToCampaign
      • DetachDocumentFromCampaign
      • GetCampaignAttachments
      • GetCampaigns
      • GetCampaignsForAddressBook
      • GetCampaignById
      • GetCampaignSummary
      • GetCampaignWithDetails
      • GetCampaignOpens
      • GetCampaignOpensSinceDate
      • GetCampaignActivities
      • GetCampaignActivitiesSinceDate
      • GetSentCampaignsWithActivitySinceDate
      • GetCampaignClicks
      • GetCampaignClicksSinceDate
      • GetCampaignClicksAndLinkGroups
      • GetCampaignClicksAndLinkGroupsSinceDate
      • GetCampaignPageViewsSinceDate
      • GetCampaignContactActivity
      • GetCampaignContactClicks
      • GetCampaignContactClicksAndLinkGroups
      • GetCampaignContactOpens
      • GetCampaignContactPageViews
      • GetCampaignContactReplies
      • GetCampaignContactRoiDetails
      • GetCampaignRoiDetailsSinceDate
      • GetCampaignContactSocialBookmarkViews
      • GetCampaignSocialBookmarkViews
      • GetCampaignHardBouncingContacts
      • GetCampaignSplitTestResults
    • SOAP - Contacts
      • CreateContact
      • CreateContactWithConsent
      • CreateContactWithConsentAndPreferences
      • ImportContacts
      • UpdateContact
      • UpdateContactWithConsent
      • UpdateContactWithConsentAndPreferences
      • DeleteContact
      • GetContactByEmail
      • GetContactById
      • GetAllAccountContactsCount
      • GetContacts
      • GetModifiedContacts
      • GetNewContacts
      • GetContactImportProgress
      • GetContactImportReport
      • GetContactImportReportFaults
      • GetSuppressedContacts
      • GetUnsubscribedContacts
      • UnsubscribeContact
      • ResubscribeContact
      • ResubscribeContactWithNoChallenge
      • GetContactsScore
      • GetContactsScoreModifiedSinceDate
      • GetContactScoreByEmail
      • GetContactScoreByContactId
      • GetContactByIdWithConsent
      • GetContactByEmailWithConsent
      • GetContactsWithPreference
      • GetModifiedPreferenceOptIns
    • SOAP - Contact data fields
      • CreateDataField
      • DeleteDataField
      • GetDataFields
    • SOAP - Custom from addresses
      • GetCustomFromAddresses
    • SOAP - Document folders
      • CreateDocumentFolder
      • UploadDocument
      • GetDocumentFolders
      • GetDocuments
    • SOAP - Image folders
      • CreateImageFolder
      • UploadImage
      • GetImageFolders
      • GetImageFolderById
    • SOAP - Pages and forms
      • GetSurveys
      • GetSurveyById
      • GetSurveyFields
      • GetSurveyResponses
      • GetSurveyResponsesWithActivitySinceDate
      • GetSurveysWithActivitySinceDate
    • SOAP - Preferences
      • CreatePreference
      • SetPreferencesForContact
      • UpdatePreference
      • DeletePreference
      • GetPreferences
      • GetPreferencesForContact
      • GetPreferencesModifiedSinceDate
    • SOAP - Product recommendations
      • GetProductRecommendations
    • SOAP - Programs
      • CreateEnrolment
      • GetPrograms
      • GetProgramById
      • GetEnrolmentReport
      • GetEnrolmentsByStatus
      • GetEnrolmentById
    • SOAP - Segments
      • GetSegments
      • GetSegmentRefreshProgress
      • RefreshSegment
    • SOAP - Server time
      • GetServerTime
    • SOAP - SMS
      • SendSingleSmsMessage
      • CreateSMSCampaign
      • CopySMSCampaign
      • GetSMSCampaigns
      • GetSMSCampaign
      • UpdateSMSCampaign
      • DeleteSMSCampaign
    • SOAP - Templates
      • GetTemplates
      • CreateTemplate
      • UpdateTemplate
      • GetTemplateById
    • SOAP - Transactional email
      • SendTransactionalEmail
      • SendTransactionalEmailTriggeredCampaign
      • GetTransactionalEmailStatistics
    • SOAP - Transactional data
      • AddTransactionalData
      • ImportTransactionalData
      • ReplaceTransactionalDataByKey
      • DeleteTransactionalDataByContact
      • DeleteTransactionalDataByKey
      • GetTransactionalDataImportProgress
      • GetTransactionalDataImportReport
      • GetTransactionalDataByContact
      • GetTransactionalDataByKey
      • GetAccountScopedTransactionalData

GetCampaignContactClicksAndLinkGroups

Get campaign contact clicks with groups

This method returns a list of link clicks with the link groups by a specified contact in a specified campaign.

SOAP action: http://apiconnector.com/v2/ApiService/GetCampaignContactClicksAndLinkGroups

The only difference with the method https://developer.dotdigital.com/docs/getcampaigncontactclicks is the result contains also 'Groups' property described above