# Top Link Clicked List

Retrieve a list of overall aggregated click statistics, grouped by URL.

> Note: If no query parameters are used, will return stats with FromTS equal to the current day at 00:00 UTC.

Endpoint: GET /v3/REST/toplinkclicked
Version: 1.0.0
Security: basicAuth

## Query parameters:

  - `ActualClicks` (boolean)
    When true, will retrieve statistics for the total number of click events. When false, will retrieve a count of unique (deduplicated) clicks.

Default value: false

  - `CampaignID` (integer)
    Retrieves link click statistics only for the specified Campaign ID.

  - `Contact` (integer)
    Retrieves link click statistics only for the specified contact ID.

  - `ContactsList` (integer)
    Retrieves link click statistics only for the specified contact list ID.

  - `CustomCampaign` (string)
    Retrieves link click statistics only for the campaign with the specified Custom Value.

  - `From` (string)
    Retrieves link click statistics only for messages sent from the specified Sender Email address.

  - `FromDomain` (string)
    Retrieves link click statistics only for messages sent from the specified domain.

  - `FromID` (integer)
    Retrieves link click statistics only for messages sent from the sender address with the specified ID.

  - `FromTS` (string)
    Retrieves link click statistics only for messages sent after the specified timestamp. Both Unix timestamp (e.g. 1514764800) and RFC3339 (2018-01-01T00:00:00) formats are accepted.

  - `FromType` (integer)
    Retrieves link click statistics only for a specific type of messages:

- 1 - Transactional
- 2 - Marketing
- 3 - Unknown

  - `IsDeleted` (boolean)
    When true, will retrieve link click statistics only for deleted campaigns. When false, stats for deleted campaigns will be excluded from the response.

  - `IsNewsletterTool` (boolean)
    When true, will retrieve link click statistics only for campaigns created with the Legacy template builder. When false, campaigns created with the Legacy builder will be excluded from the response.

  - `IsStarred` (boolean)
    When true, will retrieve link click statistics only for starred campaigns. When false, starred campaigns will be excluded from the response.

  - `Message` (integer)
    Retrieves link click statistics only for the specified message ID.

  - `Period` (string)
    Retrieves link click statistics only for messages sent between the start of the selected period and the current timestamp.

- Day - since the start of the current day
- Week - since the start of the current week
- Month - since the start of the current month
- Year - since the start of the current year

  - `ToTS` (string)
    Retrieves link click statistics only for messages sent before the specified timestamp. Both Unix timestamp (e.g. 1514764800) and RFC3339 (2018-01-01T00:00:00) formats are accepted.

## Response 200 fields (application/json):

  - `Count` (integer)
    Indicates the number of objects in the Data array.

  - `Data` (array)
    A JSON array containing a list of objects returned by this endpoint.

  - `Data.ClickedCount` (integer)
    Number of unique (deduplicated) clicks for this link. When ActualClicks=true, will return the total number of clicks instead.

  - `Data.LinkId` (integer)
    Unique numeric ID for this link.

  - `Data.Url` (string)
    The URL of the clicked link.

  - `Total` (integer)
    Indicates the number of objects in the Data array.


## Response 400 fields

## Response 401 fields

## Response 403 fields

## Response 404 fields

## Response 429 fields

## Response 500 fields