Show sent email statistics (POST /)
Shows statistics of the emails a user has sent.
Data points are shown for the send result over the last two weeks.
Each data point contains statistics for a 15-minute interval.
Request Headers
Refer to "Common API request headers".
Request Parameters
Action
Name of the API to run.
"GetSendStatistics"
Data Type | Cardinality |
---|---|
String | 1..1 |
Version
API version.
"v1.0" (optional)
Data Type | Cardinality |
---|---|
String | 0..1 |
Request Elements
n/a
HTTP status
Status
Returns the status of the request.
- 200:
- Normal completion
- 400:
- Request parameter error
- 401:
- Authentication error
- 403:
- Access denied
- 500:
- Internal error
Data Type | Cardinality |
---|---|
Int | 1..1 |
Response elements (normal completion)
GetSendStatisticsResponse
Envelope of the response.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
- | 1..1 | None | GetSendStatisticsResult ResponseMetadata |
GetSendStatisticsResult
Envelope of the result.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
- | 1..1 | GetSendStatisticsResponse | SendDataPoints |
SendDataPoints
Envelope of the list of email statistics.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
- | 1..1 | GetSendStatisticsResult | member |
member
Envelope of email statistics.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
- | 0..n | SendDataPoints | DeliveryAttempts Timestamp Rejects Bounces Complaints |
DeliveryAttempts
The number of emails stored in the send queue.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Long | 1..1 | member | None |
Timestamp
The time when statistics were obtained (start time).
The date format is "YYYY-MM-DDThh:mm:ss.SSSZ".
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
DateTime | 1..1 | member | None |
Rejects
The number of discarded emails.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Long | 1..1 | member | None |
Bounces
The number of bounced emails.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Long | 1..1 | member | None |
Complaints
The number of complaint emails.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
Long | 1..1 | member | None |
ResponseMetadata
Envelope of the metadata.
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
- | 1..1 | GetSendStatisticsResponse | RequestId |
RequestId
ID that uniquely identifies the request.
This is required when contacting support staff to troubleshoot an issue.
UUID format (example: 647cd254-e0d1-44a9-af61-1d6d86ea6b77)
Data Type | Cardinality | Parent Element | Child Element(s) |
---|---|---|---|
xsd:string | 1..1 | ResponseMetadata | None |
Example of Request
POST / HTTP/1.1
Date: Fri, 06 Jun 2014 11:00:37 AM GMT
Content-Length: ...
Host: mail.jp-east-1.tps5.fujitsu.com
Content-Type: application/x-www-form-urlencoded; charset=utf-8
X-Auth-Token: MIIFvgY...
Action=GetSendStatistics
Example of Response
HTTP/1.1 200 OK
Date: Fri, 06 Jun 2014 11:00:38 GMT
Content-Length: ...
Content-Type: application/xml
x-fj-request-id: d96bd874-9bf2-11e1-8ee7-c98a0037a2b6
<?xml version="1.0" encoding="UTF-8"?>
<GetSendStatisticsResponse>
<GetSendStatisticsResult>
<SendDataPoints>
<member>
<DeliveryAttempts>8</DeliveryAttempts>
<Timestamp>2011-08-03T19:23:00Z</Timestamp>
<Rejects>0</Rejects>
<Bounces>0</Bounces>
<Complaints>0</Complaints>
</member>
<member>
<DeliveryAttempts>7</DeliveryAttempts>
<Timestamp>2011-08-03T06:53:00Z</Timestamp>
<Rejects>0</Rejects>
<Bounces>0</Bounces>
<Complaints>0</Complaints>
</member>
-
-
-
</GetSendStatisticsResult>
<ResponseMetadata>
<RequestId>d96bd874-9bf2-11e1-8ee7-c98a0037a2b6</RequestId>
</ResponseMetadata>
</GetSendStatisticsResponse>