{"_id":"577cb1b61cf3cb0e0048e554","__v":0,"editedParams2":true,"project":"55dd9f2e0efd5821000d54d9","user":"55dd9841cafe7221002a4c62","category":{"_id":"55f036c08563861700a33769","version":"55dd9f4dab0e4d210045aae9","__v":1,"pages":["5601545b3aa0520d00da0ccd"],"project":"55dd9f2e0efd5821000d54d9","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-09-09T13:40:16.609Z","from_sync":false,"order":17,"slug":"transactional-email","title":"Transactional email"},"version":{"_id":"55dd9f4dab0e4d210045aae9","__v":39,"project":"55dd9f2e0efd5821000d54d9","createdAt":"2015-08-26T11:13:17.024Z","releaseDate":"2015-08-26T11:13:17.024Z","categories":["55dd9f4dab0e4d210045aaea","55ddb5fa9067202b00ddff6f","55e0472c6bad670d0081f213","55e04764a44fae0d00214671","55e047a9a44fae0d00214672","55e047b258c5460d0076a9a7","55e95e337fc27b2d00d32cf2","55e979bda7ca823900ad549a","55edb8c18dcb210d0056900b","55f0365c8563861700a33765","55f03677d58f9b1900acf996","55f036938eeefc23001ea5de","55f036a38563861700a33767","55f036c08563861700a33769","55f036d02911b72100482cd7","55f036e92911b72100482cd9","55f036fa8563861700a3376b","55f0370ee507711900e58c69","55f0371df6101b1900c70700","55f0374f2911b72100482cdb","55f0375e2911b72100482cdc","560eb0f659cb8d0d0015cd52","560eb25239fad419002ae1e0","561fb64d4d67490d00804b2a","562b9f775a39cd0d009aff22","562ba0505a39cd0d009aff23","562ba149d56bc30d00f0cb18","562ba595f68a5f0d007b1f3b","562ba78fd56bc30d00f0cb1b","562ba8b95a39cd0d009aff27","562baadf6562140d001501d2","562bab37f68a5f0d007b1f3d","562bc1bf9ebc950d000f7523","562bc99ced4bea0d00c11dfa","562bd29c1b98640d00714520","562bd5875a39cd0d009aff60","562bdfabff2da50d002c0aaf","562be0bd5a39cd0d009aff75","57a0b476d8313e1900454439"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"editedParams":true,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-06T07:22:30.783Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n  \"startDate\": \"2016-02-23T00:00:00\",\n  \"endDate\": \"2016-05-11T23:59:59\",\n  \"numSent\": 59,\n  \"numDelivered\": 59,\n  \"numOpens\": 6,\n  \"numClicks\": 0,\n  \"numIspComplaints\": 0,\n  \"numBounces\": 0\n}","language":"json","status":200}]},"settings":"","examples":{"codes":[{"code":"var url = \"/v2/email/stats/since-date/2016-01-01\";\n\nusing (var httpClient = new HttpClient())\n{\n  httpClient.BaseAddress = new Uri(\"https://api.dotmailer.com\");\n  var credentials = Encoding.ASCII.GetBytes(\"username:password\");\n  httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(\"Basic\", Convert.ToBase64String\n\n(credentials));\n  var result = httpClient.GetAsync(url).Result;\n}","language":"csharp"}]},"method":"get","auth":"required","params":[{"_id":"577cb1b61cf3cb0e0048e557","ref":"","in":"path","required":true,"desc":"The date from which transactional email reporting statistics will be returned, which needs to go within the URL","default":"","type":"datetime","name":"Date"},{"_id":"577cb1b61cf3cb0e0048e556","ref":"","in":"query","required":false,"desc":"The end date up to which transactional email reporting statistics will be returned (inclusive), which needs to go within the URL","default":"","type":"datetime","name":"EndDate"},{"_id":"577cb1b61cf3cb0e0048e555","ref":"","in":"query","required":false,"desc":"The data aggregation period for transactional email reporting statistics, which needs to go within the URL","default":"'AllTime', 'Month', 'Week', 'Day'","type":"string","name":"AggregatedBy"}],"url":"/v2/email/stats/since-date/[Date]?endDate=[EndDate]&aggregatedBy=[AggregatedBy]"},"isReference":false,"order":2,"body":"This operation retrieves your transactional email reporting statistics (number sent, delivered, opens, clicks, ISP complaints and bounces) for a specified time period. \n\nThis time period can be set with a specific end date, or statistics can be aggregated by all time, week, month or day.","excerpt":"Gets transactional email reporting statistics for a specified time period","slug":"get-transactional-email-statistics","type":"endpoint","title":"Get transactional email statistics"}

getGet transactional email statistics

Gets transactional email reporting statistics for a specified time period

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

Date:
required
datetime
The date from which transactional email reporting statistics will be returned, which needs to go within the URL

Query Params

EndDate:
datetime
The end date up to which transactional email reporting statistics will be returned (inclusive), which needs to go within the URL
AggregatedBy:
string'AllTime', 'Month', 'Week', 'Day'
The data aggregation period for transactional email reporting statistics, which needs to go within the URL

Examples


Result Format


Documentation

This operation retrieves your transactional email reporting statistics (number sent, delivered, opens, clicks, ISP complaints and bounces) for a specified time period. This time period can be set with a specific end date, or statistics can be aggregated by all time, week, month or day.