{"id":3705,"date":"2023-08-31T06:41:33","date_gmt":"2023-08-31T05:41:33","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=3705"},"modified":"2024-03-19T13:23:58","modified_gmt":"2024-03-19T12:23:58","slug":"get-signalspam-statistics","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/methods\/statistics\/get-signalspam-statistics\/","title":{"rendered":"Get SignalSpam statistics"},"content":{"rendered":"\n

This function allows retrieving SignalSpam reports. Statistics may be filtered using one or two scopes and results can be grouped.<\/p>\n\n\n\n

Please note that this statistic are only available for the units that have SignalSpam reporting turned on.<\/p>\n\n\n\n

<\/a><\/a>Request data format<\/strong><\/h3>\n\n\n\n

Request URL parameters:<\/p>\n\n\n\n

Parameter<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
apiKey<\/td>string<\/td>Your API key, required for authentication. Required.<\/td><\/tr>
startDate<\/td>date<\/td>Start date. Optional. If not specified, unit creation date will be the start date. YYYY-MM-DD format.<\/td><\/tr>
endDate<\/td>date<\/td>End date. Optional. If not specified, current date will be taken. YYYY-MM-DD format.<\/td><\/tr>
scope<\/td>string<\/td>Filtering scope name. Optional. If not specified, no filtering will be applied.
Available scopes are:
1) Provider – (for example Orange, SFR, La Poste)
2) Ip – IP of channel (for example 11.22.33.44)<\/td><\/tr>
scopeValue<\/td>string<\/td>Filtering scope value. Required if scope was specified.<\/td><\/tr>
scope2<\/td>string<\/td>Second filtering scope name.<\/td><\/tr>
scopeValue2<\/td>string<\/td>Second filtering scope value.<\/td><\/tr>
grouping<\/td>string <\/td>Results grouping. Optional. If not specified, results will not be grouped.
Available groupings are:
1) Date
2) Month
3) Provider
4) Ip<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Examples:<\/p>\n\n\n\n

<\/path><\/path><\/svg><\/span>
https:\/\/api.esv2.com\/v2\/Api\/SignalSpamStatistics?apiKey=YOUR_API_KEY_HERE&startDate=2015-10-12&endDate=2015-10-18&grouping=Date<\/span><\/span>\n<\/span>\nhttps:\/\/api.esv2.com\/v2\/Api\/SignalSpamStatistics?apiKey=YOUR_API_KEY_HERE&startDate=2015-10-12&endDate=2015-10-18&scope=Provider&scopeValue=SFR&grouping=Date<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Response<\/strong><\/h3>\n\n\n\n
Response Data element:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
SignalSpamStatistics<\/td>array[complex]<\/td>Array of SignalSpamStatistics elements.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
SignalSpam element children:<\/p>\n\n\n\n
Element\/attribute<\/th>Type<\/th>Notes<\/th><\/tr><\/thead>
IsSummaryRow<\/td>int<\/td>If set to true, marks the summary row of statistic table (values are sums of all other rows).<\/td><\/tr>
Date<\/td>string<\/td>Date. Returned only if grouping by date was requested.<\/td><\/tr>
Month<\/td>date<\/td>Month represented as date period. Returned only if grouping by months was requested.
Example: 2010-01-01 : 2010-01-31<\/td><\/tr>
Provider<\/td>int<\/td>Provider name. Returned only if grouping by providers was requested<\/td><\/tr>
Ip<\/td>int<\/td>Channel IP address. Returned only if grouping by IPs was requested.<\/td><\/tr>
Delivered<\/td>int<\/td>Number of delivered emails.<\/td><\/tr>
Complaints<\/td>int<\/td>Number of spam complaints.<\/td><\/tr>
ComplaintsRate<\/td>int<\/td>Rate of spam complaints.<\/td><\/tr>
Spamtraps<\/td>int<\/td>Number of spam trap hits.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
Example<\/strong><\/h3>\n\n\n\n
Request:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
GET https:\/\/api.esv2.com\/v2\/Api\/SignalSpamStatistics?apiKey=YOUR_API_KEY_HERE&startDate=2015-10-12&endDate=2015-10-18&scope=Provider&scopeValue=SFR&grouping=Date HTTP\/1.1<\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
OK response:<\/p>\n\n\n\n
<\/path><\/path><\/svg><\/span>
<<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsd<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span>><\/span><\/span>\n   <\/span><<\/span>Data<\/span>><\/span><\/span>\n      <\/span><<\/span>SignalSpamStatistics<\/span>><\/span><\/span>\n         <\/span><<\/span>SignalSpamStatistic<\/span>><\/span><\/span>\n            <\/span><<\/span>IsSummaryRow<\/span>><\/span>true<\/span><\/<\/span>IsSummaryRow<\/span>><\/span><\/span>\n            <\/span><<\/span>Date<\/span> <\/span>xsi<\/span>:<\/span>nil<\/span>=<\/span>"<\/span>true<\/span>"<\/span>\/><\/span><\/span>\n            <\/span><<\/span>Delivered<\/span>><\/span>0<\/span><\/<\/span>Delivered<\/span>><\/span><\/span>\n            <\/span><<\/span>Complaints<\/span>><\/span>1332<\/span><\/<\/span>Complaints<\/span>><\/span><\/span>\n            <\/span><<\/span>ComplaintRate<\/span>><\/span>0.00<\/span><\/<\/span>ComplaintRate<\/span>><\/span><\/span>\n            <\/span><<\/span>Spamtraps<\/span>><\/span>1110<\/span><\/<\/span>Spamtraps<\/span>><\/span><\/span>\n         <\/span><\/<\/span>SignalSpamStatistic<\/span>><\/span><\/span>\n         <\/span><<\/span>SignalSpamStatistic<\/span>><\/span><\/span>\n            <\/span><<\/span>Date<\/span>><\/span>2015-10-18<\/span><\/<\/span>Date<\/span>><\/span><\/span>\n            <\/span><<\/span>Delivered<\/span>><\/span>0<\/span><\/<\/span>Delivered<\/span>><\/span><\/span>\n            <\/span><<\/span>Complaints<\/span>><\/span>0<\/span><\/<\/span>Complaints<\/span>><\/span><\/span>\n            <\/span><<\/span>ComplaintRate<\/span>><\/span>0.00<\/span><\/<\/span>ComplaintRate<\/span>><\/span><\/span>\n            <\/span><<\/span>Spamtraps<\/span>><\/span>0<\/span><\/<\/span>Spamtraps<\/span>><\/span><\/span>\n         <\/span><\/<\/span>SignalSpamStatistic<\/span>><\/span><\/span>\n         <\/span><<\/span>SignalSpamStatistic<\/span>><\/span><\/span>\n            <\/span><<\/span>Date<\/span>><\/span>2015-10-17<\/span><\/<\/span>Date<\/span>><\/span><\/span>\n            <\/span><<\/span>Delivered<\/span>><\/span>0<\/span><\/<\/span>Delivered<\/span>><\/span><\/span>\n            <\/span><<\/span>Complaints<\/span>><\/span>0<\/span><\/<\/span>Complaints<\/span>><\/span><\/span>\n            <\/span><<\/span>ComplaintRate<\/span>><\/span>0.00<\/span><\/<\/span>ComplaintRate<\/span>><\/span><\/span>\n            <\/span><<\/span>Spamtraps<\/span>><\/span>0<\/span><\/<\/span>Spamtraps<\/span>><\/span><\/span>\n         <\/span><\/<\/span>SignalSpamStatistic<\/span>><\/span><\/span>\n         <\/span><<\/span>SignalSpamStatistic<\/span>><\/span><\/span>\n            <\/span><<\/span>Date<\/span>><\/span>2015-10-16<\/span><\/<\/span>Date<\/span>><\/span><\/span>\n            <\/span><<\/span>Delivered<\/span>><\/span>0<\/span><\/<\/span>Delivered<\/span>><\/span><\/span>\n            <\/span><<\/span>Complaints<\/span>><\/span>0<\/span><\/<\/span>Complaints<\/span>><\/span><\/span>\n            <\/span><<\/span>ComplaintRate<\/span>><\/span>0.00<\/span><\/<\/span>ComplaintRate<\/span>><\/span><\/span>\n            <\/span><<\/span>Spamtraps<\/span>><\/span>0<\/span><\/<\/span>Spamtraps<\/span>><\/span><\/span>\n         <\/span><\/<\/span>SignalSpamStatistic<\/span>><\/span><\/span>\n         <\/span><<\/span>SignalSpamStatistic<\/span>><\/span><\/span>\n            <\/span><<\/span>Date<\/span>><\/span>2015-10-15<\/span><\/<\/span>Date<\/span>><\/span><\/span>\n            <\/span><<\/span>Delivered<\/span>><\/span>0<\/span><\/<\/span>Delivered<\/span>><\/span><\/span>\n            <\/span><<\/span>Complaints<\/span>><\/span>0<\/span><\/<\/span>Complaints<\/span>><\/span><\/span>\n            <\/span><<\/span>ComplaintRate<\/span>><\/span>0.00<\/span><\/<\/span>ComplaintRate<\/span>><\/span><\/span>\n            <\/span><<\/span>Spamtraps<\/span>><\/span>0<\/span><\/<\/span>Spamtraps<\/span>><\/span><\/span>\n         <\/span><\/<\/span>SignalSpamStatistic<\/span>><\/span><\/span>\n         <\/span><<\/span>SignalSpamStatistic<\/span>><\/span><\/span>\n            <\/span><<\/span>Date<\/span>><\/span>2015-10-14<\/span><\/<\/span>Date<\/span>><\/span><\/span>\n            <\/span><<\/span>Delivered<\/span>><\/span>0<\/span><\/<\/span>Delivered<\/span>><\/span><\/span>\n            <\/span><<\/span>Complaints<\/span>><\/span>888<\/span><\/<\/span>Complaints<\/span>><\/span><\/span>\n            <\/span><<\/span>ComplaintRate<\/span>><\/span>0.00<\/span><\/<\/span>ComplaintRate<\/span>><\/span><\/span>\n            <\/span><<\/span>Spamtraps<\/span>><\/span>333<\/span><\/<\/span>Spamtraps<\/span>><\/span><\/span>\n         <\/span><\/<\/span>SignalSpamStatistic<\/span>><\/span><\/span>\n         <\/span><<\/span>SignalSpamStatistic<\/span>><\/span><\/span>\n            <\/span><<\/span>Date<\/span>><\/span>2015-10-13<\/span><\/<\/span>Date<\/span>><\/span><\/span>\n            <\/span><<\/span>Delivered<\/span>><\/span>0<\/span><\/<\/span>Delivered<\/span>><\/span><\/span>\n            <\/span><<\/span>Complaints<\/span>><\/span>333<\/span><\/<\/span>Complaints<\/span>><\/span><\/span>\n            <\/span><<\/span>ComplaintRate<\/span>><\/span>0.00<\/span><\/<\/span>ComplaintRate<\/span>><\/span><\/span>\n            <\/span><<\/span>Spamtraps<\/span>><\/span>222<\/span><\/<\/span>Spamtraps<\/span>><\/span><\/span>\n         <\/span><\/<\/span>SignalSpamStatistic<\/span>><\/span><\/span>\n         <\/span><<\/span>SignalSpamStatistic<\/span>><\/span><\/span>\n            <\/span><<\/span>Date<\/span>><\/span>2015-10-12<\/span><\/<\/span>Date<\/span>><\/span><\/span>\n            <\/span><<\/span>Delivered<\/span>><\/span>0<\/span><\/<\/span>Delivered<\/span>><\/span><\/span>\n            <\/span><<\/span>Complaints<\/span>><\/span>111<\/span><\/<\/span>Complaints<\/span>><\/span><\/span>\n            <\/span><<\/span>ComplaintRate<\/span>><\/span>0.00<\/span><\/<\/span>ComplaintRate<\/span>><\/span><\/span>\n            <\/span><<\/span>Spamtraps<\/span>><\/span>555<\/span><\/<\/span>Spamtraps<\/span>><\/span><\/span>\n         <\/span><\/<\/span>SignalSpamStatistic<\/span>><\/span><\/span>\n      <\/span><\/<\/span>SignalSpamStatistics<\/span>><\/span><\/span>\n   <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n","protected":false},"author":5,"featured_media":0,"parent":3699,"menu_order":282,"template":"","format":"standard","emp-category":[],"class_list":["post-3705","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3705","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es"}],"about":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/types\/es"}],"author":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/users\/5"}],"version-history":[{"count":2,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3705\/revisions"}],"predecessor-version":[{"id":8834,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3705\/revisions\/8834"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3699"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=3705"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=3705"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}