Click

Get email clicks

get

Use this method to get details of clicks such as date, IP, browser, operation system and more. Please remember the clicks are stored for 7 days.

Authorizations

APIKeyHeaderAPPKeyHeader

Query parameters

offsetintegeroptional

The number of items omitted from the beginning of the list. Default ‘0’.

Default: 0

limitinteger · max: 1000optional

The maximum number of items returned by request. Default ‘100’. Maximum ‘1000’.

Default: 100

dateTostringoptional

Search with date. The difference between dateTo and dateFrom cannot be more than 3 days.

Example: YYYY-MM-DD hh:mm:ii

dateFromstringoptional

Search with date. The difference between dateTo and dateFrom cannot be more than 3 days.

Example: YYYY-MM-DD hh:mm:ii

smtpAccountstringoptional

The smtp account name.

Example: 1.test.smtp

messageIdstringoptional

The unique ID of the message.

Example: [e-mail]

Responses

application/json

objectoptional

application/json

application/json

application/json

get

CsharpGoJavaNodePhpPythonRubyShell

using System.Threading.Tasks;

internal class Program
{
    private static void Main(string[] args)
    {
        string requestBody = "";

        try {
            using var client = new HttpClient{};
            using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.messageflow.com/v2.1/email/click?offset=0&limit=100&dateTo=YYYY-MM-DD hh:mm:ii&dateFrom=YYYY-MM-DD hh:mm:ii&smtpAccount=1.test.smtp&messageId=[e-mail]");

            request.Headers.Add("Authorization", "YourAuthorizationKey");
            request.Headers.Add("Application-Key", "YourApplicationKey");
            request.Content = new StringContent(requestBody, null, "application/json");

            var response = await client.SendAsync(request);
            response.EnsureSuccessStatusCode();
            string content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);

        } catch (HttpRequestException e) {
            Console.WriteLine("\n Exception Caught!\n Message :{0} ", e.Message);
        }
    }
}

{
  "meta": {
    "numberOfErrors": 0,
    "numberOfData": 1,
    "status": 200,
    "uniqId": "00d928f759"
  },
  "data": [
    {
      "messageId": "text",
      "date": "text",
      "to": "text",
      "smtpAccount": "text",
      "ip": "text",
      "browser": "text",
      "os": "text",
      "userAgent": "text",
      "link": "text"
    }
  ]
}