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 retrieves detailed usage metrics for a specific organization within a given date range. It is useful for analyzing how an organization's resources or services are being utilized over time, enabling administrators or analysts to monitor activity, track trends, and generate reports based on usage data.
Practical examples include:
- Monitoring API call volumes or service consumption by an organization.
- Generating detailed usage reports for billing or auditing purposes.
- Tracking changes in usage patterns between two dates to identify growth or anomalies.
Properties
| Name | Meaning |
|---|---|
| From | The start date of the period for which to retrieve usage data. Must be in ISO8601 format (e.g., "2023-12-01"). |
| Id | The unique identifier of the organization whose usage metrics are being requested. |
| To | The end date of the period for which to retrieve usage data. Must be in ISO8601 format (e.g., "2023-12-01"). |
Output
The output JSON contains detailed usage metrics for the specified organization between the given dates. This typically includes structured data such as timestamps, usage counts, resource identifiers, or other relevant statistics depending on the external API's response.
If the node supports binary data output, it would represent downloadable reports or files related to the usage metrics, but this is not indicated in the provided code or properties.
Dependencies
- Requires an API key credential for authenticating requests to the external metrics service.
- The node sends HTTP requests with query parameters
fromandtofor date filtering, andidfor specifying the organization. - Proper configuration of the API base URL and authentication headers is necessary.
Troubleshooting
- Invalid Date Format: Ensure that the
FromandTodates are in valid ISO8601 format (e.g., "YYYY-MM-DD"). Incorrect formats may cause request failures. - Missing or Incorrect Organization ID: Providing an invalid or non-existent organization ID will result in errors or empty responses.
- Authentication Errors: Verify that the API key credential is correctly configured and has sufficient permissions.
- Date Range Issues: The
Fromdate should not be after theTodate; otherwise, the API might return errors or no data. - Network or API Downtime: Temporary connectivity issues or service outages can cause request failures.
Links and References
- Refer to the external metrics service API documentation for detailed information on the usage metrics endpoint and data schema.
- ISO8601 date format specification: https://en.wikipedia.org/wiki/ISO_8601