| GET | /api/services/{ServiceGuid}/users/{UserGuid}/usage | Get a User usage report. | Get a User usage including number of Messages sent and Features used. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ServiceGuid | path | Guid | Yes | |
| UserGuid | path | Guid | Yes | |
| PeriodType | query | PeriodType | No | Defaults to Daily. |
| Period | query | DateTime | No | Defaults to yesterdays Date. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ServiceGuid | form | Guid | No | |
| PeriodType | form | PeriodType | No | Allowable Values
|
| Period | body | DateTime | No | |
| Usage | body | UserUsage | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| UserGuid | body | Guid | No | |
| EmailAddress | form | string | No | |
| IsAlias | body | Boolean | No | |
| FirstName | form | string | No | |
| LastName | form | string | No | |
| Status | form | ServiceUserStatusEnum? | No | Allowable Values
|
| CreatedOn | body | DateTime | No | |
| RegisteredOn | body | DateTime | No | |
| LastLogin | body | DateTime | No | |
| GroupName | form | string | No | |
| GroupType | form | ServiceUserGroupEnum? | No | Allowable Values
|
| GroupGuid | body | Guid | No | |
| TotalMessagesSent | body | Integer | No | |
| TotalMessagesReceived | body | Integer | No | |
| TotalAttachmentsCount | body | Integer | No | |
| TotalAttachmentsSize | body | Integer | No | |
| TotalInvitationsSent | body | Integer | No | |
| TotalInvitationsAccepted | body | Integer | No | |
| LastToolbarVersion | body | String | No | |
| InvitedByEmailAddress | body | String | No | |
| LastMsgSent | body | DateTime | No | |
| LastMsgRetrieved | body | DateTime | No | |
| LastActivity | body | DateTime | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/services/{ServiceGuid}/users/{UserGuid}/usage HTTP/1.1
Host: api.secure-messaging.com
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{
"serviceGuid": "00000000000000000000000000000000",
"periodType": "Daily",
"period": "0001-01-01T00:00:00Z",
"usage": {
"userGuid": "00000000000000000000000000000000",
"emailAddress": "String",
"isAlias": false,
"firstName": "String",
"lastName": "String",
"status": "0",
"createdOn": "0001-01-01T00:00:00Z",
"registeredOn": "0001-01-01T00:00:00Z",
"lastLogin": "0001-01-01T00:00:00Z",
"groupName": "String",
"groupType": "Professional",
"groupGuid": "00000000000000000000000000000000",
"totalMessagesSent": 0,
"totalMessagesReceived": 0,
"totalAttachmentsCount": 0,
"totalAttachmentsSize": 0,
"totalInvitationsSent": 0,
"totalInvitationsAccepted": 0,
"lastToolbarVersion": "String",
"invitedByEmailAddress": "String",
"lastMsgSent": "0001-01-01T00:00:00Z",
"lastMsgRetrieved": "0001-01-01T00:00:00Z",
"lastActivity": "0001-01-01T00:00:00Z"
},
"responseStatus": {
"errorCode": "String",
"message": "String",
"stackTrace": "String",
"errors": [
{
"errorCode": "String",
"fieldName": "String",
"message": "String",
"meta": {
"String": "String"
}
}
],
"meta": {
"String": "String"
}
}
}