Aggregate

Get statistics

get

Use this method to get email statistics.

Authorizations

APIKeyHeaderAPPKeyHeader

Query parameters

smtpAccountstringRequired

The name of your smtp account.

Example: 1.test.smtp

dateFromstringRequired

The start date of the range as timestamp.

dateTostringOptional

The end date of the range as timestamp.

withTagsintegerOptional

This field indicates whether the data should be aggregated by tags or not ( 1 - with aggregation, 0 - no aggregation ).

Example: 1

Responses

get

CsharpJavaPhpPythonShell

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/aggregate?smtpAccount=1.test.smtp&dateFrom=<string>&dateTo=<string>&withTags=1");

            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"
  }
}