GET | /api/services/{ServiceGuid}/users/usage | Gets Users usage report. | EXPERIMENTAL: A paged list of ServiceUsers and the level of daily usage including number of Messages sent and Features used. This API call depends on a technology that is in the process of being deployed. Results may not be accurate. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ServiceGuid | path | Guid | Yes | |
Page | query | Integer | No | The Page number being requested. Defaults to 1. |
PageSize | query | Integer | No | The Page Size returned by the operation. Defaults to 25. |
PeriodType | query | PeriodType | No | Indicates the scope of data to be returned. Defaults to Daily. |
Period | query | DateTime | No | Limit the usage data returned to the specified period. Any time value passed in this parameter will be ignored. Defaults to yesterdays Date. |
UserStatus | query | ServiceUserStatusEnum | No | If a value is provided, filters the Users to be returned.Allowable Values
|
UserGroupType | query | ServiceUserGroupEnum | No | If a value is provided, filters the Users to be returned.Allowable Values
|
UserGroupGuid | query | Guid | Yes | If a value is provided, filters the Users to be returned. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PageSize | body | Integer | No | |
TotalPages | body | Integer | No | |
TotalItems | body | Integer | No | |
CurrentPage | body | Integer | No | |
Results | body | UserUsage[] | No | |
PeriodType | form | PeriodType | No | Allowable Values
|
Period | body | DateTime | No | |
ServiceGuid | body | Guid | 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/usage HTTP/1.1 Host: api.secure-messaging.com Accept: application/json
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length { "pageSize": 0, "totalPages": 0, "totalItems": 0, "currentPage": 0, "results": [ { "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" } ], "periodType": "Daily", "period": "0001-01-01T00:00:00Z", "serviceGuid": "00000000000000000000000000000000", "responseStatus": { "errorCode": "String", "message": "String", "stackTrace": "String", "errors": [ { "errorCode": "String", "fieldName": "String", "message": "String", "meta": { "String": "String" } } ], "meta": { "String": "String" } } }