GET /service/api/status/reporting/pillr/{partnerkeycode}
?effectiveDate={effectiveDate}
Returns a partner-level summary usage report for a partner keycode. Besides general information like the partner's name and the product license status the report includes high watermark data.
Request Information
URI Parameters
Name | Description | Type | Additional Information |
---|---|---|---|
partnerkeycode |
A partner 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. |
URI Sample(s)
GET
|
https://unityapi.webrootcloudav.com/service/api/status/reporting/pillr/5826-E901-C907-435E-BAF4?effectiveDate=2024-11-11T00:00:00.0000000Z
|
Body Parameters
None.
Response Information
Resource Description
Returns partner-level usage statistics for a Pillr partner keycode.
UsageReportPillr_PartnerName | Description | Type | Additional Information |
---|---|---|---|
ReportInfo |
Details about the returned report. |
UsageReportPillr_ReportInfo |
None. |
General |
General details about the returned report. |
UsageReportPillr_GeneralInfo |
None. |
Products |
Product details for a given partner key. |
Collection of UsageReportPillr_ProductEntry |
None. |
Sample Response
{ "ReportInfo": { "EffectiveDate": "2024-10-29T00:00:00Z", "PartnerKey": "3lg84p05vlve7m7be0zc" }, "General": { "PartnerName": "Partner 1", "PartnerId": "PART001", "PartnerLicenseType": "partnerpillr,full" }, "Products": [ { "ProductName": "Pillr Platform", "Licenses": [ { "Status": "Active", "HighWatermarkEndpoints": 325, "HighWatermarkGigabytes": 0.0 }, { "Status": "Trial", "HighWatermarkEndpoints": 218, "HighWatermarkGigabytes": 0.0 }, { "Status": "NFR", "HighWatermarkEndpoints": 129, "HighWatermarkGigabytes": 0.0 } ] }, { "ProductName": "Pillr Platform Mobile", "Licenses": [ { "Status": "Active", "HighWatermarkEndpoints": 25, "HighWatermarkGigabytes": 0.0 }, { "Status": "Trial", "HighWatermarkEndpoints": 18, "HighWatermarkGigabytes": 0.0 } ] }, { "ProductName": "Pillr Platform Chromebook", "Licenses": [ { "Status": "Active", "HighWatermarkEndpoints": 15, "HighWatermarkGigabytes": 0.0 }, { "Status": "Trial", "HighWatermarkEndpoints": 7, "HighWatermarkGigabytes": 0.0 } ] }, { "ProductName": "Pillr Compliance Storage", "Licenses": [ { "Status": "Active", "HighWatermarkEndpoints": 10, "HighWatermarkGigabytes": 12.3 }, { "Status": "Trial", "HighWatermarkEndpoints": 12, "HighWatermarkGigabytes": 1.1 } ] } ] }
<StatusReporting.UsageReportPillr_Partner 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> </General> <Products> <StatusReporting.UsageReportPillr_ProductEntry> <Licenses> <StatusReporting.UsageReportPillr_LicenseEntry> <HighWatermarkEndpoints>325</HighWatermarkEndpoints> <HighWatermarkGigabytes>0</HighWatermarkGigabytes> <Status>Active</Status> </StatusReporting.UsageReportPillr_LicenseEntry> <StatusReporting.UsageReportPillr_LicenseEntry> <HighWatermarkEndpoints>218</HighWatermarkEndpoints> <HighWatermarkGigabytes>0</HighWatermarkGigabytes> <Status>Trial</Status> </StatusReporting.UsageReportPillr_LicenseEntry> <StatusReporting.UsageReportPillr_LicenseEntry> <HighWatermarkEndpoints>129</HighWatermarkEndpoints> <HighWatermarkGigabytes>0</HighWatermarkGigabytes> <Status>NFR</Status> </StatusReporting.UsageReportPillr_LicenseEntry> </Licenses> <ProductName>Pillr Platform</ProductName> </StatusReporting.UsageReportPillr_ProductEntry> <StatusReporting.UsageReportPillr_ProductEntry> <Licenses> <StatusReporting.UsageReportPillr_LicenseEntry> <HighWatermarkEndpoints>25</HighWatermarkEndpoints> <HighWatermarkGigabytes>0</HighWatermarkGigabytes> <Status>Active</Status> </StatusReporting.UsageReportPillr_LicenseEntry> <StatusReporting.UsageReportPillr_LicenseEntry> <HighWatermarkEndpoints>18</HighWatermarkEndpoints> <HighWatermarkGigabytes>0</HighWatermarkGigabytes> <Status>Trial</Status> </StatusReporting.UsageReportPillr_LicenseEntry> </Licenses> <ProductName>Pillr Platform Mobile</ProductName> </StatusReporting.UsageReportPillr_ProductEntry> <StatusReporting.UsageReportPillr_ProductEntry> <Licenses> <StatusReporting.UsageReportPillr_LicenseEntry> <HighWatermarkEndpoints>15</HighWatermarkEndpoints> <HighWatermarkGigabytes>0</HighWatermarkGigabytes> <Status>Active</Status> </StatusReporting.UsageReportPillr_LicenseEntry> <StatusReporting.UsageReportPillr_LicenseEntry> <HighWatermarkEndpoints>7</HighWatermarkEndpoints> <HighWatermarkGigabytes>0</HighWatermarkGigabytes> <Status>Trial</Status> </StatusReporting.UsageReportPillr_LicenseEntry> </Licenses> <ProductName>Pillr Platform Chromebook</ProductName> </StatusReporting.UsageReportPillr_ProductEntry> <StatusReporting.UsageReportPillr_ProductEntry> <Licenses> <StatusReporting.UsageReportPillr_LicenseEntry> <HighWatermarkEndpoints>10</HighWatermarkEndpoints> <HighWatermarkGigabytes>12.3</HighWatermarkGigabytes> <Status>Active</Status> </StatusReporting.UsageReportPillr_LicenseEntry> <StatusReporting.UsageReportPillr_LicenseEntry> <HighWatermarkEndpoints>12</HighWatermarkEndpoints> <HighWatermarkGigabytes>1.1</HighWatermarkGigabytes> <Status>Trial</Status> </StatusReporting.UsageReportPillr_LicenseEntry> </Licenses> <ProductName>Pillr Compliance Storage</ProductName> </StatusReporting.UsageReportPillr_ProductEntry> </Products> <ReportInfo> <EffectiveDate>2024-10-29T00:00:00Z</EffectiveDate> <PartnerKey>3lg84p05vlve7m7be0zc</PartnerKey> </ReportInfo> </StatusReporting.UsageReportPillr_Partner>