For more information on using API

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

Get a click report for a specific campaign. 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

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

ApiClickDetailsReport

Name

Description

Type

Additional information

total_items

Total clicks in the campaign

integer
urls_clicked

List of URLs clicked

Collection of ApiClickDetails

Response Formats

application/json, text/json

Sample: 
{
  "total_items": 1,
  "urls_clicked": [
    {
      "id": 1,
      "name": "sample string 2",
      "link_name": "sample string 3",
      "link_id": 4,
      "link_type": "sample string 5",
      "link_url": "sample string 6",
      "profile_id": 7,
      "unique_links": 8,
      "non_unique_links": 9,
      "position": "sample string 10"
    },
    {
      "id": 1,
      "name": "sample string 2",
      "link_name": "sample string 3",
      "link_id": 4,
      "link_type": "sample string 5",
      "link_url": "sample string 6",
      "profile_id": 7,
      "unique_links": 8,
      "non_unique_links": 9,
      "position": "sample string 10"
    }
  ]
}

application/xml, text/xml

Sample: 
<ApiClickDetailsReport xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TotalItems>1</TotalItems>
  <Items>
    <ApiClickDetails>
      <ID>1</ID>
      <Name>sample string 2</Name>
      <LinkName>sample string 3</LinkName>
      <LinkId>4</LinkId>
      <LinkType>sample string 5</LinkType>
      <LinkUrl>sample string 6</LinkUrl>
      <PROFILE_ID>7</PROFILE_ID>
      <UniqueLinks>8</UniqueLinks>
      <NonUniqueLinks>9</NonUniqueLinks>
      <POSITION>sample string 10</POSITION>
    </ApiClickDetails>
    <ApiClickDetails>
      <ID>1</ID>
      <Name>sample string 2</Name>
      <LinkName>sample string 3</LinkName>
      <LinkId>4</LinkId>
      <LinkType>sample string 5</LinkType>
      <LinkUrl>sample string 6</LinkUrl>
      <PROFILE_ID>7</PROFILE_ID>
      <UniqueLinks>8</UniqueLinks>
      <NonUniqueLinks>9</NonUniqueLinks>
      <POSITION>sample string 10</POSITION>
    </ApiClickDetails>
  </Items>
</ApiClickDetailsReport>