CCC API v8.4.0.0

<back to all web services

GetServicesUsage

The following routes are available for this service:
GET/api/services/usageGets Service usage report.A paged list of Services and the level of daily usage including number of Users, Messages sent and Features used. Includes all Services except those whose Status is Blocked or Provisioning.
GetServicesUsage Parameters:
NameParameterData TypeRequiredDescription
PagequeryIntegerNoThe Page number being requested. Defaults to 1.
PageSizequeryIntegerNoThe Page Size returned by the operation. Defaults to 25.
PartnerGuidqueryGuidNo
ResellerGuidqueryGuidNo
ServiceGuidqueryGuidNo
CreatedAfterDateTimequeryDateTimeNoSearch for any services created after or on this date / time (UTC). If left null, this param is excluded from the Search.
CreatedBeforeDateTimequeryDateTimeNoSearch for any services created before or on this date / time (UTC). If left null, this param is excluded from the Search.
PeriodTypequeryPeriodTypeNoIndicates the scope of data to be returned. Defaults to Daily.
PeriodqueryDateTimeNoLimit the usage data returned to the specified period. Any time value passed in this parameter will be ignored.
ServiceUsagePagedResponse Parameters:
NameParameterData TypeRequiredDescription
PageSizebodyIntegerNo
TotalPagesbodyIntegerNo
TotalItemsbodyIntegerNo
CurrentPagebodyIntegerNo
ResultsbodyServiceUsage[]No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ServiceUsage Parameters:
NameParameterData TypeRequiredDescription
ServiceGuidbodyGuidNo
NameformstringNo
StatusformServiceStatusNo

Allowable Values

  • Blocked
  • AccountCancelled
  • AccountSuspended
  • Provisioning
  • TrialExpired
  • TrialActive
  • DemoAccount
  • CertifiedSecure
ServiceCodeformstringNo
ReferenceIdformstringNo
PrimaryDomainformstringNo
CreatedOnbodyDateTimeNo
TrialEndDatebodyDateTimeNo
EffectiveDatebodyDateTimeNo
InitialTermformintNo
CollectionGuidbodyGuidNo
CollectionNameformstringNo
ClientGuidbodyGuidNo
ContactbodyContactInfoNo
CompanybodyCompanyNo
PeriodTypeformPeriodTypeNo

Allowable Values

  • Daily
  • Monthly
PeriodbodyDateTimeNo
TotalUserCountbodyIntegerNo
ProUserCountbodyIntegerNo
GuestUserCountbodyIntegerNo
DisabledUserCountbodyIntegerNo
UnregisteredUserCountbodyIntegerNo
FeatureUsageSecureMessagingGatewaybodyIntegerNo
FeatureUsageSecureMessagingPlusbodyIntegerNo
FeatureUsageDataLeakPreventionbodyIntegerNo
FeatureUsageSecureLargeFilesbodyIntegerNo
FeatureUsageSecureFormsbodyIntegerNo
TotalMessageCountbodyIntegerNo
TotalAttachmentCountbodyIntegerNo
AttachmentStorageUsagebodyIntegerNo
ContactInfo Parameters:
NameParameterData TypeRequiredDescription
NamebodyStringYes
EmailbodyStringYes
PhoneNumberbodyStringYes
Company Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
AddressformstringNo
CityformstringNo
StateProvinceformstringNo
PostalCodeformstringNo
CountryformstringNo
WebsiteformstringNo

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

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/services/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": [
    {
      "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
    }
  ],
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  }
}