Get SignalSpam statistics - ExpertSender Help Center

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 URL parameters:

Parameter	Type	Notes
apiKey	string	Your API key, required for authentication. Required.
startDate	date	Start date. Optional. If not specified, unit creation date will be the start date. YYYY-MM-DD format.
endDate	date	End date. Optional. If not specified, current date will be taken. YYYY-MM-DD format.
scope	string	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)
scopeValue	string	Filtering scope value. Required if scope was specified.
scope2	string	Second filtering scope name.
scopeValue2	string	Second filtering scope value.
grouping	string	Results grouping. Optional. If not specified, results will not be grouped. Available groupings are: 1) Date 2) Month 3) Provider 4) Ip

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 Data element:

Element/attribute	Type	Notes
SignalSpamStatistics	array[complex]	Array of SignalSpamStatistics elements.

SignalSpam element children:

Element/attribute	Type	Notes
IsSummaryRow	int	If set to true, marks the summary row of statistic table (values are sums of all other rows).
Date	string	Date. Returned only if grouping by date was requested.
Month	date	Month represented as date period. Returned only if grouping by months was requested. Example: 2010-01-01 : 2010-01-31
Provider	int	Provider name. Returned only if grouping by providers was requested
Ip	int	Channel IP address. Returned only if grouping by IPs was requested.
Delivered	int	Number of delivered emails.
Complaints	int	Number of spam complaints.
ComplaintsRate	int	Rate of spam complaints.
Spamtraps	int	Number of spam trap hits.

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>