Druva MSP icon

Druva MSP

Interact with the Druva MSP API
Join our community

Actions39

Overview

The "Get Itemized Tenant Consumption" operation under the "Report - Usage" resource retrieves detailed usage consumption data for tenants. This node is useful for MSPs or administrators who want to analyze tenant-level consumption metrics over specific time periods, filtered by various criteria such as customers, editions, products, product modules, and usage descriptions.

Typical use cases include:

  • Generating detailed billing reports for tenants based on their actual usage.
  • Monitoring consumption trends across different customers or product editions.
  • Filtering usage data to focus on particular products or service modules.
  • Analyzing usage within custom date ranges or predefined relative periods (e.g., last 30 days, current quarter).

For example, an MSP could use this node to get all itemized consumption data for tenants in the "Enterprise" edition during the previous month, filtered to only include certain products, helping with accurate invoicing or capacity planning.

Properties

Name Meaning
Date Selection Method Choose how to filter the report by date: "All Dates" (no date filter), "Specific Dates" (custom start and end dates), or "Relative Date Range" (predefined periods like current month, last 30 days, etc.).
Start Date The start date of the usage report period (required if "Specific Dates" is selected).
End Date The end date of the usage report period (required if "Specific Dates" is selected).
Date Range Select a predefined relative date range for the report period (used if "Relative Date Range" is selected). Options include current/previous month, quarter, year, last 30/60/90 days, last 6/12 months, year to date.
Filter by Customers Boolean flag to enable filtering results by specific customer IDs.
Customer IDs List of customer IDs to include in the report (required if filtering by customers).
Filter by Edition Names Boolean flag to enable filtering results by specific edition names.
Edition Names List of edition names to include in the report (Business, Enterprise, Elite) (required if filtering by edition names).
Filter by Products Boolean flag to enable filtering results by specific product IDs.
Product IDs List of product IDs to include in the report (required if filtering by products).
Filter by Product Modules Boolean flag to enable filtering results by specific product module IDs.
Product Module IDs List of product module IDs to include in the report (required if filtering by product modules).
Filter by Usage Descriptions Boolean flag to enable filtering results by specific usage descriptions.
Usage Descriptions List of usage descriptions to include in the report (e.g., Active Users, Cloud Storage, Unlimited Storage) (required if filtering by usage descriptions).
Return All Whether to return all matching results or limit the number of returned items.
Limit Maximum number of results to return if not returning all (minimum 1).

Output

The node outputs JSON data containing the itemized tenant consumption records matching the specified filters and date range. Each record typically includes details such as tenant identifiers, usage metrics, product/module information, and timestamps corresponding to the consumption period.

If binary data were involved (not indicated here), it would represent associated files or attachments related to the report, but this operation focuses on structured JSON usage data.

Dependencies

  • Requires an API key credential for authenticating with the Druva MSP API.
  • The node interacts with the Druva MSP REST API endpoint at https://apis.druva.com.
  • Some input properties dynamically load options via API calls (e.g., customer IDs, product IDs, product module IDs).
  • Proper permissions and API access are necessary to retrieve usage reports.

Troubleshooting

  • Common Issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Selecting filters without providing required values (e.g., enabling "Filter by Customers" but not specifying any customer IDs) will likely result in errors.
    • Date range conflicts or invalid date formats can cause request failures.
    • API rate limits or network issues may interrupt data retrieval.

  • Error Messages:

    • Errors related to missing parameters usually indicate that required fields for the chosen filters or date selection method were not set.
    • API errors might return messages about unauthorized access or resource not found; verify credentials and resource availability.
    • If the node throws an error about an unimplemented resource or operation, ensure the correct resource and operation names are used.

  • Resolution Tips:

    • Double-check all required inputs based on the selected filters.
    • Ensure the API key has sufficient permissions.
    • Use smaller date ranges or enable pagination if large datasets cause timeouts.
    • Review logs for detailed error messages.

Links and References

  • Druva MSP API Documentation (general reference for endpoints and data structures)
  • n8n Documentation on Custom Nodes and Credentials
  • Usage Reporting Best Practices for MSP Billing and Analytics

Discussion