GET /service/api/status/reporting/gsm/{gsmKey}/sites/{keyCode}/endpoints
?reportType={reportType}
&effectiveDate={effectiveDate}
&continuation={continuation}
Returns an endpoint-level summary report of endpoint usage for a GSM master keycode by a site keycode. For each endpoint the report includes information like the endpoint's hostname, machine identifier, and its activation state.
Note: This report can become quite large depending on the number of endpoints that
are managed for the given GSM site. The maximum number of returned endpoint records is limited to 10,000 to ensure that requests can complete in
reasonable time. If more endpoint records are available a continuationToken is returned as part of the ReportInfo data, which can be used to
query additional endpoint data.
Request Information
URI Parameters
| Name | Description | Type | Additional Information |
|---|---|---|---|
| gsmKey |
A master keycode for which usage information is to be retrieved. |
string |
Required |
| keyCode |
The keycode of the site for which usage information is to be retrieved. |
string |
Required |
| reportType |
The type of report to be produced. The following values are supported:
|
string |
None. |
| effectiveDate |
The date the report should refer to. If omitted, the most recent usage report will be returned. Note: Usage data will typically be generated in the course of the following day (UTC) and therefore can only be provided for dates earlier than yesterday. If, for example, this API method is called at 11:00 pm UTC, yesterday's data will not be available yet. |
date |
None. |
| continuation |
The continuation token for batched requests. |
string |
None. |
URI Sample(s)
|
GET
|
https://unityapi.webrootcloudav.com/service/api/status/reporting/gsm/3515-3EC8-3018-4DAB-A776/sites/9FD5-D6B7-0DEA-4F1F-BD33/endpoints?reportType=EndpointsSeenInLast30Days&effectiveDate=2019-08-26T00:00:00.0000000Z
|
|
GET
|
https://unityapi.webrootcloudav.com/service/api/status/reporting/gsm/3515-3EC8-3018-4DAB-A776/endpoints?reportType=EndpointsSeenInLast30Days&effectiveDate=2019-08-26T00:00:00.0000000Z&continuation=n2Lek49F3pOdYt6T
|
Body Parameters
None.
Response Information
Resource Description
Returns a list of endpoint usage statistics for the specified site keycode.
Note: The OS response field for endpoints is
provided in reports for June 20th, 2019 and later. Earlier reports do not include the operating system information
and return null for this field.
UsageReportEndpoints | Name | Description | Type | Additional Information |
|---|---|---|---|
| ReportInfo |
Details about the returned report. |
UsageReportEndpoints_ReportInfo |
None. |
| Endpoints |
A list of endpoints. |
Collection of UsageReportEndpoints_EndpointEntry |
None. |
Sample Response
{
"ReportInfo": {
"Count": 2,
"ContinuationToken": "bNTluyD1t9YpHo5d",
"SiteKeyFilter": null,
"ReportType": "EndpointsSeenInLast30Days",
"EffectiveDate": "2024-04-20T00:00:00Z",
"GSMKey": "uuo6fnvumruhwkn04nk7"
},
"Endpoints": [
{
"MachineId": "c04599bea4b26baac3ab63e381bca9af180d7c521474a81de678a17811c8df30:::9b0dad3fd8a2ba800de4125008b6fd4207af7331:::9b0dad3fd8a2ba800de4125008b6fd4207af7331",
"SiteId": "16ab3578-4179-54a3-0ef3-36628a122897",
"SiteKey": "3qt3rac86pma3fc39ajs",
"HostName": "NODEYSVUCIZK35",
"FriendlyHostName": "FRIENDLY-NODEYSVUCIZK35",
"LastSeen": "2024-04-18T22:13:09.081251Z",
"DeviceType": "MAC",
"OS": "Windows Server 2016 (Build 14393) 64bit",
"IsHidden": false,
"IsDeactivated": false,
"IsTrial": false,
"ActivationStatusTime": "2024-04-10T04:53:09.081251Z"
},
{
"MachineId": "531083a760058ade287f4b64d4f1616dfca062bce159cb1d6b92ceeadc234805:::936bfd70db025c7231bb7400e02af7760ff945d8:::936bfd70db025c7231bb7400e02af7760ff945d8",
"SiteId": "1cc925ae-4639-2987-0abc-6c3b6a895eb4",
"SiteKey": "jblaah3n5mfn38y4cnhx",
"HostName": "NODEDVSIW0ZJ5G",
"FriendlyHostName": "FRIENDLY-NODEDVSIW0ZJ5G",
"LastSeen": "2024-04-20T00:40:09.081251Z",
"DeviceType": "MAC",
"OS": "Windows Server 2016 (Build 14393) 64bit",
"IsHidden": true,
"IsDeactivated": false,
"IsTrial": true,
"ActivationStatusTime": "2024-04-06T11:42:09.081251Z"
}
]
}
<StatusReporting.UsageReportEndpoints xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.AgentStatus.Models">
<Endpoints>
<StatusReporting.UsageReportEndpoints_EndpointEntry>
<ActivationStatusTime>2024-04-10T04:53:09.081251Z</ActivationStatusTime>
<DeviceType>MAC</DeviceType>
<FriendlyHostName>FRIENDLY-NODEYSVUCIZK35</FriendlyHostName>
<HostName>NODEYSVUCIZK35</HostName>
<IsDeactivated>false</IsDeactivated>
<IsHidden>false</IsHidden>
<IsTrial>false</IsTrial>
<LastSeen>2024-04-18T22:13:09.081251Z</LastSeen>
<MachineId>c04599bea4b26baac3ab63e381bca9af180d7c521474a81de678a17811c8df30:::9b0dad3fd8a2ba800de4125008b6fd4207af7331:::9b0dad3fd8a2ba800de4125008b6fd4207af7331</MachineId>
<OS>Windows Server 2016 (Build 14393) 64bit</OS>
<SiteId>16ab3578-4179-54a3-0ef3-36628a122897</SiteId>
<SiteKey>3qt3rac86pma3fc39ajs</SiteKey>
</StatusReporting.UsageReportEndpoints_EndpointEntry>
<StatusReporting.UsageReportEndpoints_EndpointEntry>
<ActivationStatusTime>2024-04-06T11:42:09.081251Z</ActivationStatusTime>
<DeviceType>MAC</DeviceType>
<FriendlyHostName>FRIENDLY-NODEDVSIW0ZJ5G</FriendlyHostName>
<HostName>NODEDVSIW0ZJ5G</HostName>
<IsDeactivated>false</IsDeactivated>
<IsHidden>true</IsHidden>
<IsTrial>true</IsTrial>
<LastSeen>2024-04-20T00:40:09.081251Z</LastSeen>
<MachineId>531083a760058ade287f4b64d4f1616dfca062bce159cb1d6b92ceeadc234805:::936bfd70db025c7231bb7400e02af7760ff945d8:::936bfd70db025c7231bb7400e02af7760ff945d8</MachineId>
<OS>Windows Server 2016 (Build 14393) 64bit</OS>
<SiteId>1cc925ae-4639-2987-0abc-6c3b6a895eb4</SiteId>
<SiteKey>jblaah3n5mfn38y4cnhx</SiteKey>
</StatusReporting.UsageReportEndpoints_EndpointEntry>
</Endpoints>
<ReportInfo>
<EffectiveDate>2024-04-20T00:00:00Z</EffectiveDate>
<GSMKey>uuo6fnvumruhwkn04nk7</GSMKey>
<ReportType>EndpointsSeenInLast30Days</ReportType>
<ContinuationToken>bNTluyD1t9YpHo5d</ContinuationToken>
<Count>2</Count>
<SiteKeyFilter i:nil="true" />
</ReportInfo>
</StatusReporting.UsageReportEndpoints>