Documentation

GET /service/api/status/reporting/pillr/{partnerkeycode}/customers/{customerkeycode}/endpoints
?effectiveDate={effectiveDate}
&continuation={continuation}

Returns an endpoint-level summary report for a partner keycode by a customer keycode. For each endpoint the report includes information like the endpoint's agent id, hostname, mac address and its host ip data.

Request Information

URI Parameters

Name	Description	Type	Additional Information
partnerkeycode	A partner keycode for which usage information is to be retrieved.	string	Required
customerkeycode	A customer keycode for which usage information is to be retrieved.	string	Required
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/pillr/257E-1265-D3A0-40ED-BADC/customers/8EA4-C502-01B5-4CA5-B8D0/endpoints?effectiveDate=2024-11-11T00:00:00.0000000Z&continuation=HMR1e4bMgCMpuDwd

Body Parameters

None.

Response Information

Resource Description

Returns endpoint-level usage statistics for a Pillr partner keycode and customer key code.

UsageReportPillr_Endpoint

Name	Description	Type	Additional Information
ReportInfo	Details about the returned report.	UsageReportPillr_ReportInfo_Endpoint	None.
General	General details about the returned report.	UsageReportPillr_GeneralInfo_Customer	None.
Products	Details about the returned products in the usage report.	Collection of UsageReportPillr_ProductEntry_Endpoint	None.

Sample Response

{
  "ReportInfo": {
    "ContinuationToken": "bd0M2mz4221B57Tz",
    "CustomerKey": "0b33emk3j9epuhctg3w5",
    "EffectiveDate": "2024-10-22T00:00:00Z",
    "PartnerKey": "f1t65s01mc16ey97pq2q"
  },
  "General": {
    "CustomerName": "Customer 1",
    "CustomerId": "CUST001",
    "CustomerLicenseType": "customererpillr,full",
    "PartnerName": "Partner 1",
    "PartnerId": "PART001",
    "PartnerLicenseType": "partnerpillr,full"
  },
  "Products": [
    {
      "ProductName": "Pillr Platform",
      "Endpoints": [
        {
          "AgentId": "12345678901234567890120",
          "HostName": "Host Name 0",
          "MacAddress": "00:1A:2B:3C:4D:5A",
          "HostIP": "192.168.0.0",
          "MobileNumber": null,
          "Heartbeat": null
        },
        {
          "AgentId": "123456789012345678901231",
          "HostName": "Host Name 1",
          "MacAddress": "00:1A:2B:3C:4D:5B",
          "HostIP": "192.168.0.1",
          "MobileNumber": null,
          "Heartbeat": null
        },
        {
          "AgentId": "123456789012345678901232",
          "HostName": "Host Name 2",
          "MacAddress": "01:1A:2B:3C:4D:5C",
          "HostIP": "192.168.0.2",
          "MobileNumber": null,
          "Heartbeat": null
        },
        {
          "AgentId": "123456789012345678901233",
          "HostName": "Host Name 3",
          "MacAddress": "02:1A:2B:3C:4D:5D",
          "HostIP": "192.168.0.3",
          "MobileNumber": null,
          "Heartbeat": null
        }
      ]
    },
    {
      "ProductName": "Pillr Platform Mobile",
      "Endpoints": [
        {
          "AgentId": "123456789012345678901230",
          "HostName": "Host Name 4",
          "MacAddress": null,
          "HostIP": "192.168.0.4",
          "MobileNumber": "......1234",
          "Heartbeat": null
        },
        {
          "AgentId": "123456789012345678901234",
          "HostName": "Host Name 5",
          "MacAddress": null,
          "HostIP": "192.168.0.5",
          "MobileNumber": "......2345",
          "Heartbeat": null
        },
        {
          "AgentId": "123456789012345678901235",
          "HostName": "Host Name 6",
          "MacAddress": null,
          "HostIP": "192.168.0.6",
          "MobileNumber": "......3456",
          "Heartbeat": null
        },
        {
          "AgentId": "123456789012345678901236",
          "HostName": "Host Name 7",
          "MacAddress": null,
          "HostIP": "192.168.0.7",
          "MobileNumber": "......4567",
          "Heartbeat": null
        }
      ]
    },
    {
      "ProductName": "Pillr Platform Chromebook",
      "Endpoints": [
        {
          "AgentId": "123456789012345678901237",
          "HostName": "Host Name 8",
          "MacAddress": "03:1A:2B:3C:4D:5I",
          "HostIP": "192.168.0.8",
          "MobileNumber": null,
          "Heartbeat": null
        },
        {
          "AgentId": "123456789012345678901238",
          "HostName": "Host Name 9",
          "MacAddress": "04:1A:2B:3C:4D:5J",
          "HostIP": "192.168.0.9",
          "MobileNumber": null,
          "Heartbeat": null
        },
        {
          "AgentId": "123456789012345678901239",
          "HostName": "Host Name 10",
          "MacAddress": "05:1A:2B:3C:4D:5K",
          "HostIP": "192.168.1.0",
          "MobileNumber": null,
          "Heartbeat": null
        }
      ]
    }
  ]
}

<StatusReporting.UsageReportPillr_Endpoint xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.AgentStatus.Models">
  <General>
    <PartnerId>PART001</PartnerId>
    <PartnerLicenseType>partnerpillr,full</PartnerLicenseType>
    <PartnerName>Partner 1</PartnerName>
    <CustomerId>CUST001</CustomerId>
    <CustomerLicenseType>customererpillr,full</CustomerLicenseType>
    <CustomerName>Customer 1</CustomerName>
  </General>
  <Products>
    <StatusReporting.UsageReportPillr_ProductEntry_Endpoint>
      <Endpoints>
        <StatusReporting.UsageReportPillr_EndpointEntry>
          <AgentId>12345678901234567890120</AgentId>
          <Heartbeat i:nil="true" />
          <HostIP>192.168.0.0</HostIP>
          <HostName>Host Name 0</HostName>
          <MacAddress>00:1A:2B:3C:4D:5A</MacAddress>
          <MobileNumber i:nil="true" />
        </StatusReporting.UsageReportPillr_EndpointEntry>
        <StatusReporting.UsageReportPillr_EndpointEntry>
          <AgentId>123456789012345678901231</AgentId>
          <Heartbeat i:nil="true" />
          <HostIP>192.168.0.1</HostIP>
          <HostName>Host Name 1</HostName>
          <MacAddress>00:1A:2B:3C:4D:5B</MacAddress>
          <MobileNumber i:nil="true" />
        </StatusReporting.UsageReportPillr_EndpointEntry>
        <StatusReporting.UsageReportPillr_EndpointEntry>
          <AgentId>123456789012345678901232</AgentId>
          <Heartbeat i:nil="true" />
          <HostIP>192.168.0.2</HostIP>
          <HostName>Host Name 2</HostName>
          <MacAddress>01:1A:2B:3C:4D:5C</MacAddress>
          <MobileNumber i:nil="true" />
        </StatusReporting.UsageReportPillr_EndpointEntry>
        <StatusReporting.UsageReportPillr_EndpointEntry>
          <AgentId>123456789012345678901233</AgentId>
          <Heartbeat i:nil="true" />
          <HostIP>192.168.0.3</HostIP>
          <HostName>Host Name 3</HostName>
          <MacAddress>02:1A:2B:3C:4D:5D</MacAddress>
          <MobileNumber i:nil="true" />
        </StatusReporting.UsageReportPillr_EndpointEntry>
      </Endpoints>
      <ProductName>Pillr Platform</ProductName>
    </StatusReporting.UsageReportPillr_ProductEntry_Endpoint>
    <StatusReporting.UsageReportPillr_ProductEntry_Endpoint>
      <Endpoints>
        <StatusReporting.UsageReportPillr_EndpointEntry>
          <AgentId>123456789012345678901230</AgentId>
          <Heartbeat i:nil="true" />
          <HostIP>192.168.0.4</HostIP>
          <HostName>Host Name 4</HostName>
          <MacAddress i:nil="true" />
          <MobileNumber>......1234</MobileNumber>
        </StatusReporting.UsageReportPillr_EndpointEntry>
        <StatusReporting.UsageReportPillr_EndpointEntry>
          <AgentId>123456789012345678901234</AgentId>
          <Heartbeat i:nil="true" />
          <HostIP>192.168.0.5</HostIP>
          <HostName>Host Name 5</HostName>
          <MacAddress i:nil="true" />
          <MobileNumber>......2345</MobileNumber>
        </StatusReporting.UsageReportPillr_EndpointEntry>
        <StatusReporting.UsageReportPillr_EndpointEntry>
          <AgentId>123456789012345678901235</AgentId>
          <Heartbeat i:nil="true" />
          <HostIP>192.168.0.6</HostIP>
          <HostName>Host Name 6</HostName>
          <MacAddress i:nil="true" />
          <MobileNumber>......3456</MobileNumber>
        </StatusReporting.UsageReportPillr_EndpointEntry>
        <StatusReporting.UsageReportPillr_EndpointEntry>
          <AgentId>123456789012345678901236</AgentId>
          <Heartbeat i:nil="true" />
          <HostIP>192.168.0.7</HostIP>
          <HostName>Host Name 7</HostName>
          <MacAddress i:nil="true" />
          <MobileNumber>......4567</MobileNumber>
        </StatusReporting.UsageReportPillr_EndpointEntry>
      </Endpoints>
      <ProductName>Pillr Platform Mobile</ProductName>
    </StatusReporting.UsageReportPillr_ProductEntry_Endpoint>
    <StatusReporting.UsageReportPillr_ProductEntry_Endpoint>
      <Endpoints>
        <StatusReporting.UsageReportPillr_EndpointEntry>
          <AgentId>123456789012345678901237</AgentId>
          <Heartbeat i:nil="true" />
          <HostIP>192.168.0.8</HostIP>
          <HostName>Host Name 8</HostName>
          <MacAddress>03:1A:2B:3C:4D:5I</MacAddress>
          <MobileNumber i:nil="true" />
        </StatusReporting.UsageReportPillr_EndpointEntry>
        <StatusReporting.UsageReportPillr_EndpointEntry>
          <AgentId>123456789012345678901238</AgentId>
          <Heartbeat i:nil="true" />
          <HostIP>192.168.0.9</HostIP>
          <HostName>Host Name 9</HostName>
          <MacAddress>04:1A:2B:3C:4D:5J</MacAddress>
          <MobileNumber i:nil="true" />
        </StatusReporting.UsageReportPillr_EndpointEntry>
        <StatusReporting.UsageReportPillr_EndpointEntry>
          <AgentId>123456789012345678901239</AgentId>
          <Heartbeat i:nil="true" />
          <HostIP>192.168.1.0</HostIP>
          <HostName>Host Name 10</HostName>
          <MacAddress>05:1A:2B:3C:4D:5K</MacAddress>
          <MobileNumber i:nil="true" />
        </StatusReporting.UsageReportPillr_EndpointEntry>
      </Endpoints>
      <ProductName>Pillr Platform Chromebook</ProductName>
    </StatusReporting.UsageReportPillr_ProductEntry_Endpoint>
  </Products>
  <ReportInfo>
    <EffectiveDate>2024-10-22T00:00:00Z</EffectiveDate>
    <PartnerKey>f1t65s01mc16ey97pq2q</PartnerKey>
    <CustomerKey>0b33emk3j9epuhctg3w5</CustomerKey>
    <ContinuationToken>bd0M2mz4221B57Tz</ContinuationToken>
  </ReportInfo>
</StatusReporting.UsageReportPillr_Endpoint>

GET /service/api/status/reporting/pillr/{partnerkeycode}/customers/{customerkeycode}/endpoints ?effectiveDate={effectiveDate} &continuation={continuation}