| GET | /api/services/{ServiceGuid}/serviceusage | Gets Service usage data for a Service. See GetServicesUsage for aggregated version of this operation. | The level of daily service usage including number of Users, Messages sent and Features used. If the service is in Blocked or Provisioning state, the report fails. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ServiceGuid | path | Guid | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ServiceGuid | body | Guid | No | |
| Name | form | string | No | |
| Status | form | ServiceStatus | No | Allowable Values
|
| ServiceCode | form | string | No | |
| ReferenceId | form | string | No | |
| PrimaryDomain | form | string | No | |
| CreatedOn | body | DateTime | No | |
| TrialEndDate | body | DateTime | No | |
| EffectiveDate | body | DateTime | No | |
| InitialTerm | form | int | No | |
| CollectionGuid | body | Guid | No | |
| CollectionName | form | string | No | |
| ClientGuid | body | Guid | No | |
| Contact | body | ContactInfo | No | |
| Company | body | Company | No | |
| PeriodType | form | PeriodType | No | Allowable Values
|
| Period | body | DateTime | No | |
| TotalUserCount | body | Integer | No | |
| ProUserCount | body | Integer | No | |
| GuestUserCount | body | Integer | No | |
| DisabledUserCount | body | Integer | No | |
| UnregisteredUserCount | body | Integer | No | |
| FeatureUsageSecureMessagingGateway | body | Integer | No | |
| FeatureUsageSecureMessagingPlus | body | Integer | No | |
| FeatureUsageDataLeakPrevention | body | Integer | No | |
| FeatureUsageSecureLargeFiles | body | Integer | No | |
| FeatureUsageSecureForms | body | Integer | No | |
| TotalMessageCount | body | Integer | No | |
| TotalAttachmentCount | body | Integer | No | |
| AttachmentStorageUsage | body | Integer | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | body | String | Yes | |
| body | String | Yes | ||
| PhoneNumber | body | String | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| Address | form | string | No | |
| City | form | string | No | |
| StateProvince | form | string | No | |
| PostalCode | form | string | No | |
| Country | form | string | No | |
| Website | form | string | 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}/serviceusage HTTP/1.1
Host: api.secure-messaging.com
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{
"responseStatus": {
"errorCode": "String",
"message": "String",
"stackTrace": "String",
"errors": [
{
"errorCode": "String",
"fieldName": "String",
"message": "String",
"meta": {
"String": "String"
}
}
],
"meta": {
"String": "String"
}
},
"serviceGuid": "00000000000000000000000000000000",
"name": "String",
"status": "Blocked",
"serviceCode": "String",
"referenceId": "String",
"primaryDomain": "String",
"createdOn": "0001-01-01T00:00:00Z",
"trialEndDate": "0001-01-01T00:00:00Z",
"effectiveDate": "0001-01-01T00:00:00Z",
"initialTerm": 0,
"collectionGuid": "00000000000000000000000000000000",
"collectionName": "String",
"clientGuid": "00000000000000000000000000000000",
"contact": {
"name": "String",
"email": "String",
"phoneNumber": "String"
},
"company": {
"name": "String",
"address": "String",
"city": "String",
"stateProvince": "String",
"postalCode": "String",
"country": "String",
"website": "String"
},
"periodType": "Daily",
"period": "0001-01-01T00:00:00Z",
"totalUserCount": 0,
"proUserCount": 0,
"guestUserCount": 0,
"disabledUserCount": 0,
"unregisteredUserCount": 0,
"featureUsageSecureMessagingGateway": 0,
"featureUsageSecureMessagingPlus": 0,
"featureUsageDataLeakPrevention": 0,
"featureUsageSecureLargeFiles": 0,
"featureUsageSecureForms": 0,
"totalMessageCount": 0,
"totalAttachmentCount": 0,
"attachmentStorageUsage": 0
}