Embedded Files
API Documentation V2
This function allows retrieving SignalSpam reports. Statistics may be filtered using one or two scopes and results can be grouped.
Please note that this statistic are only available for the units that have SignalSpam reporting turned on.
Request data format
Request data format
Request URL parameters:
Examples:
https://api.esv2.com/v2/Api/SignalSpamStatistics?apiKey=YOUR_API_KEY_HERE&startDate=2015-10-12&endDate=2015-10-18&grouping=Date
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
Response
Response
Response Data element:
SignalSpam element children:
Example
Example
Request:
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
OK response:
<ApiResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Data>
<SignalSpamStatistics>
<SignalSpamStatistic>
<IsSummaryRow>true</IsSummaryRow>
<Date xsi:nil="true"/>
<Delivered>0</Delivered>
<Complaints>1332</Complaints>
<ComplaintRate>0.00</ComplaintRate>
<Spamtraps>1110</Spamtraps>
</SignalSpamStatistic>
<SignalSpamStatistic>
<Date>2015-10-18</Date>
<Delivered>0</Delivered>
<Complaints>0</Complaints>
<ComplaintRate>0.00</ComplaintRate>
<Spamtraps>0</Spamtraps>
</SignalSpamStatistic>
<SignalSpamStatistic>
<Date>2015-10-17</Date>
<Delivered>0</Delivered>
<Complaints>0</Complaints>
<ComplaintRate>0.00</ComplaintRate>
<Spamtraps>0</Spamtraps>
</SignalSpamStatistic>
<SignalSpamStatistic>
<Date>2015-10-16</Date>
<Delivered>0</Delivered>
<Complaints>0</Complaints>
<ComplaintRate>0.00</ComplaintRate>
<Spamtraps>0</Spamtraps>
</SignalSpamStatistic>
<SignalSpamStatistic>
<Date>2015-10-15</Date>
<Delivered>0</Delivered>
<Complaints>0</Complaints>
<ComplaintRate>0.00</ComplaintRate>
<Spamtraps>0</Spamtraps>
</SignalSpamStatistic>
<SignalSpamStatistic>
<Date>2015-10-14</Date>
<Delivered>0</Delivered>
<Complaints>888</Complaints>
<ComplaintRate>0.00</ComplaintRate>
<Spamtraps>333</Spamtraps>
</SignalSpamStatistic>
<SignalSpamStatistic>
<Date>2015-10-13</Date>
<Delivered>0</Delivered>
<Complaints>333</Complaints>
<ComplaintRate>0.00</ComplaintRate>
<Spamtraps>222</Spamtraps>
</SignalSpamStatistic>
<SignalSpamStatistic>
<Date>2015-10-12</Date>
<Delivered>0</Delivered>
<Complaints>111</Complaints>
<ComplaintRate>0.00</ComplaintRate>
<Spamtraps>555</Spamtraps>
</SignalSpamStatistic>
</SignalSpamStatistics>
</Data>
</ApiResponse>
Report abuse