For more information on using API

GET https://webapi.mymarketing.co.il/api/campaignreports/{id}/clickdetails/{linkId}?FromDate={FromDate}&ToDate={ToDate}&Page={Page}&Limit={Limit}

Get a specific link clickdetails. You can limit the search to specific time (by default, the search will be for campaigns that were updated in the last 3 months. Please note: if the campaign you are searching for wasn't sent in the given dates - you'll get an error)

Request Information

URI Parameters

Name

Description

Type

Additional information

id

Campaign id. Can be found using the endpoint "Get account's email campaigns..." or in the UI(go to Emails->Emails Lists->click on the campaign's preview -> you'll find the id int the URL)

integer

Required

linkId

Link id. Can be found in the UI ("Email" -> "Email Reports" -> "clickers" -> go to clickers on a specific link -> you wiil see "linkid=" in the url)

integer

Required

from_date

The start date the campaign was last updated

date
to_date

The end date the campaign was last updated

date
page

Get a specific page (number of pages is limited)

integer

Range: inclusive between 1 and 2147483647

limit

Limit the number of items you get in the results. (Removing the "limit" will, by default, display only 20 records)

integer

Range: inclusive between 1 and 100

Body Parameters

None.

Response Information

Resource Description

ApiReportCampaignClickDetailsList

Name

Description

Type

Additional information

urls_clicked

Items list

Collection of ApiReportCampaignClickDetails
total_items

Number of items

integer

Response Formats

application/json, text/json

Sample: 
{
  "urls_clicked": [
    {
      "contact_id": 1,
      "first_name": "sample string 1",
      "last_name": "sample string 2",
      "email": "sample string 3",
      "sms": "sample string 4",
      "click_date": "2016-12-24T14:12:12"
    },
    {
      "contact_id": 1,
      "first_name": "sample string 1",
      "last_name": "sample string 2",
      "email": "sample string 3",
      "sms": "sample string 4",
      "click_date": "2016-12-24T14:12:12"
    }
  ],
  "total_items": 1
}

application/xml, text/xml

Sample: 
<ApiReportCampaignClickDetailsList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models.CampaignReport">
  <total_items>1</total_items>
  <urls_clicked>
    <ApiReportCampaignClickDetails>
      <click_date>2016-12-24T14:12:12</click_date>
      <contact_id>1</contact_id>
      <email>sample string 3</email>
      <first_name>sample string 1</first_name>
      <last_name>sample string 2</last_name>
      <sms>sample string 4</sms>
    </ApiReportCampaignClickDetails>
    <ApiReportCampaignClickDetails>
      <click_date>2016-12-24T14:12:12</click_date>
      <contact_id>1</contact_id>
      <email>sample string 3</email>
      <first_name>sample string 1</first_name>
      <last_name>sample string 2</last_name>
      <sms>sample string 4</sms>
    </ApiReportCampaignClickDetails>
  </urls_clicked>
</ApiReportCampaignClickDetailsList>