14. Statistics
Content of this chapter
This chapter contains web service methods concerning statistics.
14.1. MailingSummaryStatisticJob (only EMM)
Namespace: http://agnitas.org/ws/schemas
Starts a job for the statistic „Mailing Summary“. This web service only returns the ID of the job. The results can be retrieved from the web service MailingSummaryStatisticResult.
If this web service is retrieved several times with the same parameters within a certain time period, then the same job ID is returned.
The indication of the target groups is optional.
14.1.1. Request elements
| Elements | Data type | Description |
|---|---|---|
| mailingID | {http://www.w3.org/2001/XMLSchema}int | ID of the mailing, the summary should be generated for. |
| targetGroups | {http://www.w3.org/2001/XMLSchema}TargetG | List of the target groups, a summary is generated for (optional) |
Optional elements:
| Element | Default behavior, if not specified |
|---|---|
| targetGroups | Statistics is evaluated for all recipients of the mailing |
14.1.2. Response elements
| Element | Data type | Description |
|---|---|---|
| statisticJobID | {http://www.w3.org/2001/XMLSchema}int | ID of the job for the given parameters |
14.1.3. SOAP Faults
SOAP faults are returned, if there are errors in the processing of the request.
14.2. MailingSummaryStatisticResult (only EMM)
Namespace: http://agnitas.org/ws/schemas
Retrieves the statistical data of the job, which has been initiated from the web service MailingSummaryStatisticsJob.
14.2.1. Request elements
| Element | Data type | Description |
|---|---|---|
| statisticJobID | {http://www.w3.org/2001/XMLSchema}int | ID of the job, the statistical data should be retrieved for |
14.2.2. Response elements
| Elements | Data type | Description |
|---|---|---|
| statisticJobStatus | {http://www.w3.org/2001/XMLSchema}int | Status code of the jobs (1 = queued, 2 = completed, 3 = error) |
| statisticJobStatusDescription | {http://www.w3.org/2001/XMLSchema}string | Textual description of the status |
| timestamp | {http://www.w3.org/2001/XMLSchema}dateTime | Timestamp of the jobs |
| items | List of items of the type: {http://agnitas.org/ws/schemas}GroupStatisticInfo |
Statistic data |
The elements timestamp and items are only included, if the job has been finished successfully (statisticJobStatus = 2). The timestamp has the format YYYY-MM-DDThh:mm:ss (optional with time zone).
Items additionally contains an item, which contains the statistic data of all recipients (without target groups).
Data type {http://agnitas.org/ws/schemas}GroupStatisticInfo
| Elements | Data type | Description |
|---|---|---|
| targetGroupId | {http://www.w3.org/2001/XMLSchema}int | ID of the target groups for the included statistic data |
| items | Lists of elements of the type {http://agnitas.org/ws/schemas}StatisticEntry |
Statistic data for the target group |
The target group ID can be 0. That means that the statistic data have been determined for all recipients.
Data type {http://agnitas.org/ws/schemas}StatisticEntry
| Elements | Data type | Description |
|---|---|---|
| token | {http://www.w3.org/2001/XMLSchema}string | Sign of the dataset |
| Value | {http://agnitas.org/ws/schemas}StatisticValue | Statistic data of this dataset |
This data type provides the statistic values for a certain sign (e.g. all openers). The list of the signs follows at the end of the description of this web service.
Data type {http://agnitas.org/ws/schemas}StatisticValue
| Elements | Data type | Description |
|---|---|---|
| value | {http://www.w3.org/2001/XMLSchema}int | Absolut value |
| quotien | {http://agnitas.org/ws/schemas}decimal | Relative value |
List of the statistic signs
| Elements | Default behavior, if not specified |
|---|---|
| statistic.mails.sent | Number of sent emails |
| statistic.mails.delivered | Number of emails delivered |
| statistic.Opt_Outs | Number of opt-outs |
| statistic.bounces.hardbounce | Number of hardbounces |
| statistic.bounces.softbounce.undeliverable | Number of softbounces (undeliverable) |
| statistic.opener.measure | Number of openers (measured) |
| statistic.opener.invisible | Number of openers (invisible) |
| statistic.opener.total | Number of openers (total) |
| statistic.opener.pc | Number of openers (PC) |
| statistic.opener.tablet | Number of openers (tablet) |
| statistic.opener.mobile | Number of openers (mobil) |
| statistic.opener.smarttv | Number of openers (Smart TV) |
| statistic.opener.multiple | Number of openers (multiple devices) |
| statistic.clicker | Number of clicker (total) |
| statistic.clicker.pc | Number of clicker (PC) |
| statistic.clicker.tablet | Number of clicker (tablet) |
| statistic.clicker.mobile | Number of clicker (mobil) |
| statistic.clicker.smarttv | Number of clicker (Smart TV) |
| statistic.clicker.multiple | Number of clicker (multiple devices) |
Depending on the settings of the account different data may not be available.