Druva MSP icon

Druva MSP

Interact with the Druva MSP API

Actions79

Report - Usage → Get Global Usage Report

AI-generated

Overview

This node operation fetches a global usage report from the Druva MSP API. It allows users to retrieve detailed usage data filtered by various criteria such as account name, customer name, editions, tenant type, product modules, service plan, MSP global ID, and MSP name. This operation is useful for MSP administrators or analysts who need to generate comprehensive usage reports for monitoring, billing, or auditing purposes.

Use Case Examples

  1. Generate a global usage report filtered by a specific account name to analyze usage patterns for that account.
  2. Retrieve usage data for tenants subscribed to specific editions like Business or Enterprise to understand product adoption.
  3. Filter the report by product modules such as Microsoft 365 or Google Workspace to see module-specific usage statistics.

Properties

Name Meaning
Filter by Account Name Whether to filter results by account name (boolean). If true, the 'Account Name' property must be provided for exact match filtering.
Account Name Account name to filter by (exact match). Required if 'Filter by Account Name' is true.
Filter by Customer Name Whether to filter results by customer name (boolean). If true, the 'Customer Name' property must be provided for exact match filtering.
Customer Name Customer name to filter by (exact match). Required if 'Filter by Customer Name' is true.
Filter by Editions Whether to filter results by edition (boolean). If true, the 'Editions' property must be provided to specify which editions to include.
Editions Editions to include in the report. Required if 'Filter by Editions' is true.
Filter by Tenant Type Whether to filter results by tenant type (boolean). If true, the 'Tenant Type' property must be provided to specify the tenant type.
Tenant Type Tenant type to filter by. Required if 'Filter by Tenant Type' is true.
Filter by Product Modules Whether to filter results by product module (boolean). If true, the 'Product Modules' property must be provided to specify which modules to include.
Product Modules Product modules to include in the report. Required if 'Filter by Product Modules' is true.
Filter by Service Plan Whether to filter results by service plan name (boolean). If true, the 'Service Plan' property must be provided for exact match filtering.
Service Plan Service plan name to filter by (exact match). Required if 'Filter by Service Plan' is true.
Filter by MSP Global ID Whether to filter results by a specific MSP global ID (boolean). If true, the 'MSP Global ID' property must be provided for exact match filtering.
MSP Global ID MSP global ID to filter by (exact match). Required if 'Filter by MSP Global ID' is true.
Filter by MSP Name Whether to filter results by a specific MSP name (boolean). If true, the 'MSP Name' property must be provided for exact match filtering.
MSP Name MSP name to filter by (exact match). Required if 'Filter by MSP Name' is true.
Return All Whether to return all results or only up to a given limit (boolean).
Limit Maximum number of results to return if 'Return All' is false.
Wrap Output Items When enabled, wraps all output items into a single item containing an array to prevent the next node from executing multiple times.
Wrapper Property Name The property name to use for the wrapped array of items in the output. Default is 'items'. Only applicable if 'Wrap Output Items' is true.

Output

JSON

  • accountName - The account name associated with the usage report entry.
  • customerName - The customer name associated with the usage report entry.
  • edition - The edition of the product or service in the usage report entry.
  • tenantType - The type of tenant (e.g., Commercial, Evaluation) in the usage report entry.
  • productModule - The product module included in the usage report entry.
  • servicePlan - The service plan name associated with the usage report entry.
  • mspGlobalId - The MSP global ID associated with the usage report entry.
  • mspName - The MSP name associated with the usage report entry.
  • usageData - Detailed usage data metrics included in the report entry.

Dependencies

  • Druva MSP API
  • an API key credential for authentication

Troubleshooting

  • Ensure that all required filter fields are provided when their corresponding filter boolean is set to true, otherwise the API request may fail or return incomplete data.
  • If the node throws an error about an unimplemented resource, verify that the resource name is correctly set to 'reportUsage' and the operation to 'getGlobalReport'.
  • If the API returns errors related to authentication, check that the API key credential is correctly configured and valid.
  • When using the 'Wrap Output Items' option, ensure the wrapper property name is set correctly to avoid issues in downstream nodes.

Discussion