Reports

API change history

Message key performance indicators and individual subscriber interactions can be reported through the Reports API. This is a complementary report to the /v2/subscribers//emails/ report. Bulk message open and click events peak about 12 hours after delivery and decreases in activity significantly after 4 to 6 days. Wait several days after delivery to request a report to capture the most event information. Reports are retained for 7 days, then they must be requested again.

/master-events - POST

This method creates a request for a master based event report. In this request you can specify a master, a date range and the events you want to report on. The report will always return the summary statistics (KPIs) for a master. If you include no parameters besides the template id, the report will return only the KPIs for the last seven days.

Try it

Request

Request URL

Request headers

  • string
  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

{
  "filters": {
    "masterId": "string",
    "period": "string",
    "unsubscribes": true,
    "opens": true,
    "clicks": true,
    "bounces": true
  }
}
{
  "type": "object",
  "properties": {
    "filters": {
      "type": "object",
      "properties": {
        "masterId": {
          "type": "string"
        },
        "period": {
          "type": "string"
        },
        "unsubscribes": {
          "type": "boolean"
        },
        "opens": {
          "type": "boolean"
        },
        "clicks": {
          "type": "boolean"
        },
        "bounces": {
          "type": "boolean"
        }
      }
    }
  }
}

Responses

202 Accepted

Auto generated using Swagger Inspector

Representations

{
  "request": {
    "id": "string",
    "time": "string",
    "user": "string",
    "uri": "string"
  },
  "response": {},
  "lastUpdate": "string",
  "state": "string",
  "id": "string",
  "message": "string",
  "events": [
    {
      "state": "string",
      "time": "string",
      "message": "string"
    }
  ]
}
{
  "type": "object",
  "properties": {
    "request": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "time": {
          "type": "string"
        },
        "user": {
          "type": "string"
        },
        "uri": {
          "type": "string"
        }
      }
    },
    "response": {},
    "lastUpdate": {
      "type": "string"
    },
    "state": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "message": {
      "type": "string"
    },
    "events": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "state": {
            "type": "string"
          },
          "time": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  }
}

Code samples

@ECHO OFF

curl -v -X POST "https://api.test.yesmail.com/v2/reports/master-events"
-H "Api-User: "
-H "Content-Type: application/json"
-H "api-key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Api-User", "");
            client.DefaultRequestHeaders.Add("api-key", "{subscription key}");

            var uri = "https://api.test.yesmail.com/v2/reports/master-events?" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.test.yesmail.com/v2/reports/master-events");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Api-User", "");
            request.setHeader("Content-Type", "application/json");
            request.setHeader("api-key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://api.test.yesmail.com/v2/reports/master-events?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Api-User","");
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("api-key","{subscription key}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.test.yesmail.com/v2/reports/master-events";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"" forHTTPHeaderField:@"Api-User"];
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"api-key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.test.yesmail.com/v2/reports/master-events');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Api-User' => '',
    'Content-Type' => 'application/json',
    'api-key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Api-User': '',
    'Content-Type': 'application/json',
    'api-key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('api.test.yesmail.com')
    conn.request("POST", "/v2/reports/master-events?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Api-User': '',
    'Content-Type': 'application/json',
    'api-key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('api.test.yesmail.com')
    conn.request("POST", "/v2/reports/master-events?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.test.yesmail.com/v2/reports/master-events')


request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Api-User'] = ''
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['api-key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body