{"_id":"577cb1ca7a157c0e00205775","parentDoc":null,"user":"55dd9841cafe7221002a4c62","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"},"__v":2,"project":"55dd9f2e0efd5821000d54d9","category":{"_id":"562be0bd5a39cd0d009aff75","pages":[],"project":"55dd9f2e0efd5821000d54d9","version":"55dd9f4dab0e4d210045aae9","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-10-24T19:49:17.035Z","from_sync":false,"order":34,"slug":"transactional-email-1","title":"Transactional email"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-06T07:22:50.522Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"This method 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.\n\n**SOAP action:** [https://[region ID]-api.dotmailer.com/v2/ApiService/GetTransactionalEmailStatistics](doc:gettransactionalemailstatistics)\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Input and output parameters\",\n  \"body\": \"The input and output parameters for this method are:\\n\\n**Input parameters** \\n  * StartDate - *required; dateTime*\\n  * EndDate - *optional; dateTime*\\n  * AggregatedBy - *optional; string ('AllTime', 'Month', 'Week', 'Day')*  \\n\\n**Output parameters** \\n   * GetTransactionalEmailStatisticsResult - *array of TransactionalEmailStatistics*\\n        * TransactionalEmailStatistics\\n             * StartDate - *dateTime*\\n             * EndDate - *dateTime*\\n             * NumSent - *integer*\\n             * NumDelivered - *integer*\\n             * NumOpens - *integer*\"\n}\n[/block]\n**Example**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"using (var client = new ApiServiceClient())\\n{\\n  client.ClientCredentials.UserName.UserName = \\\"username\\\";\\n  client.ClientCredentials.UserName.Password = \\\"password\\\";\\n\\n  var startDate = new DateTime(2016, 01, 01, 00, 00, 00, DateTimeKind.Utc);\\n  var endDate = DateTime.UtcNow;\\n  var aggregatedBy = ApiAggregationPeriod.AllTime;\\n  var result = client.GetTransactionalEmailStatistics(startDate, endDate, aggregatedBy);\\n}\",\n      \"language\": \"csharp\"\n    }\n  ]\n}\n[/block]","excerpt":"Gets transactional email reporting statistics for a specified time period","slug":"gettransactionalemailstatistics","type":"basic","title":"GetTransactionalEmailStatistics"}

GetTransactionalEmailStatistics

Gets transactional email reporting statistics for a specified time period

This method 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. **SOAP action:** [https://[region ID]-api.dotmailer.com/v2/ApiService/GetTransactionalEmailStatistics](doc:gettransactionalemailstatistics) [block:callout] { "type": "info", "title": "Input and output parameters", "body": "The input and output parameters for this method are:\n\n**Input parameters** \n * StartDate - *required; dateTime*\n * EndDate - *optional; dateTime*\n * AggregatedBy - *optional; string ('AllTime', 'Month', 'Week', 'Day')* \n\n**Output parameters** \n * GetTransactionalEmailStatisticsResult - *array of TransactionalEmailStatistics*\n * TransactionalEmailStatistics\n * StartDate - *dateTime*\n * EndDate - *dateTime*\n * NumSent - *integer*\n * NumDelivered - *integer*\n * NumOpens - *integer*" } [/block] **Example** [block:code] { "codes": [ { "code": "using (var client = new ApiServiceClient())\n{\n client.ClientCredentials.UserName.UserName = \"username\";\n client.ClientCredentials.UserName.Password = \"password\";\n\n var startDate = new DateTime(2016, 01, 01, 00, 00, 00, DateTimeKind.Utc);\n var endDate = DateTime.UtcNow;\n var aggregatedBy = ApiAggregationPeriod.AllTime;\n var result = client.GetTransactionalEmailStatistics(startDate, endDate, aggregatedBy);\n}", "language": "csharp" } ] } [/block]