Reports

Overview

The Reports module in WEDA provides users with the ability to generate, manage, and utilize various reports for insights. This module allows users to create usage summary tasks, manage report subscriptions, and access detailed information about their data and operations through the WEDA Core API.

Basic Operations

Basic API URL: https://{domain}/{tenantPath}/{srp}

Operation	API	Description
Create Usage Summary Task	POST {Basic API URL}/api/v1/reports/usage-jobs	Create a new usage summary report
List Usage Summary Tasks	GET {Basic API URL}/api/v1/reports/usage-jobs	Retrieves information about all tasks, including schedule IDs and detailed settings.
Download Usage Summary Report	GET {Basic API URL}/api/v1/reports/usage-jobs/{usageJobId}/summaries	This API downloads a usage summary report for a specified task identified
Update Usage Summary Task	PUT {Basic API URL}/api/v1/reports/usage-jobs/{usageJobId}	updates an existing usage summary task
Remove Usage Summary Task	DELETE {Basic API URL}/api/v1/reports/usage-jobs/{usageJobId}	Remove an existing usage summary task

Constraints & Limitations

General

• API access requires authentication with a valid token

Create

• repeatPeriod is required and value must be Daily, Weekly, or Monthly.
• endTime is required and must be in ISO 8601 format(YYYY-MM-DD), ex. 2026-12-31.
• jobs is required and type is an string array, default value is ["ActiveDeviceCount","DataPointCount"].

Delete

• Deleting a task is irreversible.

Advanced Features

Usage Summary Task

Operation	API	Description
Get Report Detail	GET {Basic API URL}/api/v1/reports/usage-jobs/{usageJobId}	Get a usage summary task detail

Subscription

Operation	API	Description
Create Subsription	POST {Basic API URL}/api/v1/reports/subscriptions	Create a new report subscription
List Subscriptions	GET {Basic API URL}/api/v1/reports/subscriptions	Get list of subscriptions
Get Subscription Detail	GET {Basic API URL}/api/v1/reports/subscriptions/{subscriptionId}	Get a subscription detail
Update Subscription	PUT {Basic API URL}/api/v1/reports/subscriptions/{subscriptionId}	Update an existing Subscription with the provided details
Remove Subscription	DELETE {Basic API URL}/api/v1/reports/subscriptions/{subscriptionId}	Remove an existing subscription
Get Subscription Deliveries	GET {Basic API URL}/api/v1/reports/subscriptions/{subscriptionId}/deliveries	Get list of deliveries for a subscription
Update Subscription Status	PATCH {Basic API URL}/api/v1/reports/subscriptions/{subscriptionId}/status	Activate or deactivate a Subscription
Execute Subscription	POST {Basic API URL}/api/v1/reports/subscriptions/{subscriptionId}:execute	Execute a subscription

---

Last updated on Apr-8, 2026 | Version 1.0.0