visualization

« Previous section Next section »

UCloud Developer Guide / Accounting and Project Management / Accounting / Visualization of Usage

Visualization of Usage

Visualization gives the user access to an overview of their usage during a set period or for a given product category.

Usage chart

The usage chart shows the usage over time for each product category.

Figure 1: Full usage shown for product type COMPUTE for the period of a week.

Figure 2: Usage specifics for each category in the product type.

Breakdown chart

The breakdown chart shows the usage for the entire period divided into the different products used.

Figure 3: Breakdown of different products usage in product type COMPUTE

Table of Contents

1. Remote Procedure Calls

2. Data Models

Remote Procedure Calls

retrieveBreakdown

Retrieve breakdown charts of usage for the entire period.

Request	Response	Error
VisualizationRetrieveBreakdownRequest	VisualizationRetrieveBreakdownResponse	CommonErrorMessage

retrieveUsage

Retrieve charts of usage over time.

Request	Response	Error
VisualizationRetrieveUsageRequest	VisualizationRetrieveUsageResponse	CommonErrorMessage

Data Models

BreakdownChart

data class BreakdownChart(
    val type: ProductType,
    val chargeType: ChargeType,
    val unit: ProductPriceUnit,
    val chart: PieChart,
)

Properties

---

LineChart

data class LineChart(
    val lines: List<LineChart.Line>,
)

Properties

---

LineChart.Line

data class Line(
    val name: String,
    val points: List<LineChart.Point>,
)

Properties

---

LineChart.Point

data class Point(
    val timestamp: Long,
    val value: Double,
)

Properties

---

PieChart

data class PieChart(
    val points: List<PieChart.Point>,
)

Properties

---

PieChart.Point

data class Point(
    val name: String,
    val value: Double,
)

Properties

---

UsageChart

data class UsageChart(
    val type: ProductType,
    val periodUsage: Long,
    val chargeType: ChargeType,
    val unit: ProductPriceUnit,
    val chart: LineChart,
)

Properties

---

VisualizationRetrieveBreakdownRequest

data class VisualizationRetrieveBreakdownRequest(
    val filterStartDate: Long?,
    val filterEndDate: Long?,
    val filterType: ProductType?,
    val filterProvider: String?,
    val filterProductCategory: String?,
    val filterAllocation: String?,
    val filterWorkspace: String?,
    val filterWorkspaceProject: Boolean?,
)

Properties

---

VisualizationRetrieveUsageRequest

data class VisualizationRetrieveUsageRequest(
    val filterStartDate: Long?,
    val filterEndDate: Long?,
    val filterType: ProductType?,
    val filterProvider: String?,
    val filterProductCategory: String?,
    val filterAllocation: String?,
    val filterWorkspace: String?,
    val filterWorkspaceProject: Boolean?,
)

Properties

---

VisualizationRetrieveBreakdownResponse

data class VisualizationRetrieveBreakdownResponse(
    val charts: List<BreakdownChart>,
)

Properties

---

VisualizationRetrieveUsageResponse

data class VisualizationRetrieveUsageResponse(
    val charts: List<UsageChart>,
)

Properties

---