Actions277
- User Agents Actions
- Url Filters Actions
- Users Actions
- Traffic Reports Actions
- Traffic Reports Qps Active Agents
- Traffic Reports Qps Active Users
- Traffic Reports Qps Active Collections
- Traffic Reports Top Domains
- Traffic Reports Top Categories
- Traffic Reports Top Application Categories
- Traffic Reports Top Organizations
- Traffic Reports Top Networks
- Traffic Reports Top Agents
- Traffic Reports Top Users
- Traffic Reports Top Collections
- Traffic Reports Query Logs
- Traffic Reports Total Organizations Stats
- Traffic Reports Total Domain Stats
- Traffic Reports Total Category Stats
- Traffic Reports Total Organizations Requests
- Traffic Reports Total Domain Requests
- Traffic Reports Top Organizations Requests
- Traffic Reports Total Client Stats
- Traffic Reports Total Deployments
- Traffic Reports Total Roaming Clients
- Traffic Reports Total Applications Stats
- Traffic Reports Total Applications Organizations Stats
- Traffic Reports Total Applications Networks Stats
- Traffic Reports Total Applications Agents Stats
- Traffic Reports Total Applications Users Stats
- Traffic Reports Total Applications Collections Stats
- Traffic Reports Total Requests
- Traffic Reports Total Requests Geo
- Traffic Reports Total Requests Organizations
- Traffic Reports Total Requests Agents
- Traffic Reports Total Requests Users
- Traffic Reports Total Requests Collections
- Traffic Reports Total Threats
- Traffic Reports Total Threats Organizations
- Traffic Reports Total Threats Agents
- Traffic Reports Total Threats Users
- Traffic Reports Total Threats Collections
- Traffic Reports Total Categories
- Traffic Reports Total Categories Organizations
- Traffic Reports Total Categories Agents
- Traffic Reports Total Categories Users
- Traffic Reports Total Categories Collections
- Traffic Reports Total Domains
- Traffic Reports Total Domains Organizations
- Traffic Reports Total Domains Users
- Traffic Reports Total Domains Collections
- Traffic Reports Total Collections
- Traffic Reports Total Collections Organizations
- Traffic Reports Total Collections Agents
- Traffic Reports Total Collections Users
- Traffic Reports Qps
- Traffic Reports Qps Active Organizations
- Trials Actions
- User Agent Bulk Deletes Actions
- User Agent Bulk Updates Actions
- User Agent Cleanups Actions
- User Agent Csv Exports Actions
- Policies Actions
- Policies Add Blacklist Category
- Policies Remove Blacklist Category
- Policies Add Allowed Application
- Policies Remove Allowed Application
- Policies Add Blocked Application
- Policies Remove Blocked Application
- Policies Get Permissive Mode
- Policies Index
- Policies Create
- Policies All
- Policies Show
- Policies Update
- Policies Destroy
- Policies Application
- Policies Application Update
- Policies Add Blacklist Domain
- Policies Remove Blacklist Domain
- Policies Add Whitelist Domain
- Policies Remove Whitelist Domain
- Policies Bulk Actions Actions
- Policy Ips Actions
- Scheduled Policies Actions
- Scheduled Report Previews Actions
- Scheduled Reports Actions
- Networks Actions
- Networks Lookup
- Networks Show
- Networks Update
- Networks Destroy
- Networks Bulk Create
- Networks Bulk Create Status
- Networks Index
- Networks Create
- Networks All
- Networks Msp
- Networks Msp All
- Networks Bulk Update
- Networks Bulk Update Status
- Networks Bulk Destroy
- Networks Bulk Destroy Status
- Networks Generate Secret Key
- Networks Revoke Secret Key
- Networks Rotate Secret Key
- Mac Addresses Actions
- Metrics Actions
- Network Lan Ips Actions
- Network Subnets Actions
- Organizations Actions
- Organization Users Actions
- Distributors Actions
- Distributors Msps Cancel
- Distributors Msps Reactivate
- Distributors Organizations Index
- Distributors Organizations Create
- Distributors Organizations Show
- Distributors Organizations Update
- Distributors Organizations Cancel
- Distributors Organizations Reactivate
- Distributors Organizations Add Sku
- Distributors Organizations Remove Sku
- Distributors Users Index
- Distributors Users Create
- Distributors Users Show
- Distributors Users Add Membership
- Distributors Users Update Membership
- Distributors Users Remove Membership
- Distributors Users Send Reset Password Email
- Distributors Users Reset Password Url
- Distributors Reports Usage By Organization
- Distributors Reports Usage By Sku
- Distributors Reports Covered Users Summary By Organization
- Distributors Distributors Update
- Distributors Msps Index
- Distributors Msps Create
- Distributors Msps Show
- Distributors Msps Update
- Domain Notes Actions
- Domains Actions
- Enterprise Connections Actions
- Invoices Actions
- IP Addresses Actions
- Allowed Urls Actions
- Api Key Actions
- Application Categories Actions
- Applications Actions
- Authentication Actions
- Authentication Sync Tool Actions
- Billings Actions
- Blocked Urls Actions
- Block Pages Actions
- Categories Actions
- Collection Users Actions
- Agent Local User Actions
- Agent Local User Bulk Deletes Actions
Overview
This node operation fetches a summarized report of covered users by organization from the Distributors resource. It is designed to retrieve data within a specified date range, providing insights into user coverage across organizations managed or tracked by distributors.
Common scenarios where this node would be beneficial include:
- Generating periodic reports on user coverage for management review.
- Analyzing trends in user adoption or coverage over time.
- Filtering reports based on specific organizations or MSPs (Managed Service Providers).
Practical example:
- A distributor wants to generate a monthly summary report of all covered users grouped by their organizations between December 1, 2022, and December 31, 2022, including organizations that were in trial and parent MSP organizations.
Properties
| Name | Meaning |
|---|---|
| From | Report range lower limit. Date in ISO8601 format, e.g., "2022-12-01". |
| To | Report range upper limit. Date in ISO8601 format, e.g., "2022-12-31". |
| Additional Query Parameters | Optional parameters to refine the report: |
| - Include In Trial | Boolean flag to include organizations that were in trial in the result (default: true). |
| - Include Parent Organization | Boolean flag to include MSPs' parent organizations in the result (default: true). |
| - Msp Ids | JSON array of MSP IDs to filter the report, e.g., [1,2,3]. |
| - Organization Ids | JSON array of organization IDs to filter the report, e.g., [4,5,6]. |
Output
The node outputs JSON data containing the summarized report of covered users by organization for the specified date range and filters. The structure typically includes organization identifiers, user counts, and possibly metadata about trials or parent organizations depending on query parameters.
If binary data output is supported, it would represent downloadable report files or attachments; however, based on the provided code and properties, the output is primarily JSON.
Dependencies
- Requires an API key credential for authenticating requests to the Distributors service.
- The node uses HTTP query parameters to send request data.
- No additional external dependencies are indicated beyond the API access.
Troubleshooting
- Missing or invalid date formats: Ensure the "From" and "To" dates are provided in valid ISO8601 format (e.g., "YYYY-MM-DD"). Invalid dates may cause API errors or empty results.
- Empty or malformed JSON arrays for MSP or Organization IDs: When specifying these filters, ensure valid JSON arrays are used. Malformed JSON will likely cause request failures.
- API authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
- No data returned: Check if the date range and filters actually correspond to existing data. Also, verify if the "Include In Trial" and "Include Parent Organization" flags are set as intended.
Links and References
- ISO 8601 Date Format
- Documentation for the Distributors API (not provided here, but typically available from the service provider)