Documentation

Deprecated

Announced Jun 1, 2020: APIs under the SkyStatus.Usage scope are scheduled for End of Life effective October 1, 2020. At that time this API will no longer be available. Please see SkyStatus.Reporting for possible alternatives.

GET /service/api/usage/gsm/{keyCode}
?billingDate={billingDate}
&continuation={continuation}

Returns usage information for a master keycode.

Request Information

URI Parameters

Name	Description	Type	Additional Information
keyCode	A master keycode for which usage information is to be retrieved.	string	Required
billingDate	The Date up to which the statistics are calculated; if not specified then the current date is used.	date	None.
continuation	A continuation token for batched requests	string	None.

URI Sample(s)

GET	https://unityapi.webrootcloudav.com/service/api/usage/gsm/3515-3EC8-3018-4DAB-A776?billingDate=2019-08-26T00:00:00.0000000Z
GET	https://unityapi.webrootcloudav.com/service/api/usage/gsm/3515-3EC8-3018-4DAB-A776?billingDate=2019-08-26T00:00:00.0000000Z&continuation=H4sIAAAAAAAEADNjYGBgyY33LEnNNWSQAnIEDBiu7z_mKGDIcBNEGTHcA1IMzBAlRgysDCAAAJrdTBY2AAAA

Body Parameters

None.

Response Information

Resource Description

Returns a list of site keycode usage statistics having the specified master key as parent. Results are returned for different time intervals

KeycodeUsage

Name	Description	Type	Additional Information
ContinuationToken	Provides a continuation token for follow-up calls if more data is available than the given batch size.	string	None.
ContinuationURI	Provides a URI for follow-up calls if more data is available than the given batch size	string	None.
Date	End date up to which usage statistics is collected	date	None.
QueryResults	Seat count statistics matching the given query parameters	Collection of UsageInfo	None.

Sample Response

{
  "QueryResults": [
    {
      "PeriodInfo": [
        {
          "Period": 1,
          "Seen": 47
        },
        {
          "Period": 7,
          "Seen": 275
        },
        {
          "Period": 30,
          "Seen": 296
        },
        {
          "Period": 90,
          "Seen": 374
        }
      ],
      "KC": "1DEE-0D50-5063-4222-ABA1"
    },
    {
      "PeriodInfo": [
        {
          "Period": 1,
          "Seen": 115
        },
        {
          "Period": 7,
          "Seen": 135
        },
        {
          "Period": 30,
          "Seen": 157
        },
        {
          "Period": 90,
          "Seen": 325
        }
      ],
      "KC": "5985-A685-0A10-4117-8018"
    }
  ],
  "ContinuationToken": null,
  "ContinuationURI": null,
  "Date": "2024-04-19T15:30:09.2198924Z"
}

<KeycodeUsage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.AgentStatus.Models">
  <ContinuationToken i:nil="true" />
  <ContinuationURI i:nil="true" />
  <Date>2024-04-19T15:30:09.2198924Z</Date>
  <QueryResults>
    <UsageInfo>
      <KC>1DEE-0D50-5063-4222-ABA1</KC>
      <PeriodInfo>
        <UsagePeriodInfo>
          <Period>1</Period>
          <Seen>47</Seen>
        </UsagePeriodInfo>
        <UsagePeriodInfo>
          <Period>7</Period>
          <Seen>275</Seen>
        </UsagePeriodInfo>
        <UsagePeriodInfo>
          <Period>30</Period>
          <Seen>296</Seen>
        </UsagePeriodInfo>
        <UsagePeriodInfo>
          <Period>90</Period>
          <Seen>374</Seen>
        </UsagePeriodInfo>
      </PeriodInfo>
    </UsageInfo>
    <UsageInfo>
      <KC>5985-A685-0A10-4117-8018</KC>
      <PeriodInfo>
        <UsagePeriodInfo>
          <Period>1</Period>
          <Seen>115</Seen>
        </UsagePeriodInfo>
        <UsagePeriodInfo>
          <Period>7</Period>
          <Seen>135</Seen>
        </UsagePeriodInfo>
        <UsagePeriodInfo>
          <Period>30</Period>
          <Seen>157</Seen>
        </UsagePeriodInfo>
        <UsagePeriodInfo>
          <Period>90</Period>
          <Seen>325</Seen>
        </UsagePeriodInfo>
      </PeriodInfo>
    </UsageInfo>
  </QueryResults>
</KeycodeUsage>