Visualization of Usage

API: Internal/Beta

_Visualization gives the user the possibility to get an easy overview of their usage during a set period or for a given product category. _

Rationale

There are currently two variations of usage visualization:

  1. Usage Chart: The usage chart shows the usage over time for each product category.

Usage shown fully for product type COMPUTE for the period of week. Usage specifics for each category in the product type.

  1. Breakdown Chart: The breakdown chart shows the usage for the entire period divided into the different products used. Breakdown of different products usage in product type COMPUTE

Table of Contents

1. Remote Procedure Calls
Name Description
retrieveBreakdown No description
retrieveUsage No description
2. Data Models
Name Description
BreakdownChart No description
LineChart No description
LineChart.Line No description
LineChart.Point No description
PieChart No description
PieChart.Point No description
UsageChart No description
VisualizationRetrieveBreakdownRequest No description
VisualizationRetrieveUsageRequest No description
VisualizationRetrieveBreakdownResponse No description
VisualizationRetrieveUsageResponse No description

Remote Procedure Calls

retrieveBreakdown

API: Internal/Beta Auth: Users

Request Response Error
VisualizationRetrieveBreakdownRequest VisualizationRetrieveBreakdownResponse CommonErrorMessage

retrieveUsage

API: Internal/Beta Auth: Users

Request Response Error
VisualizationRetrieveUsageRequest VisualizationRetrieveUsageResponse CommonErrorMessage

Data Models

BreakdownChart

API: Internal/Beta

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

LineChart

API: Internal/Beta

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

LineChart.Line

API: Internal/Beta

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

LineChart.Point

API: Internal/Beta

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

PieChart

API: Internal/Beta

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

PieChart.Point

API: Internal/Beta

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

UsageChart

API: Internal/Beta

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

VisualizationRetrieveBreakdownRequest

API: Internal/Beta

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
filterStartDate: Long?
filterEndDate: Long?
filterType: ProductType?
filterProvider: String?
filterProductCategory: String?
filterAllocation: String?
filterWorkspace: String?
filterWorkspaceProject: Boolean?

VisualizationRetrieveUsageRequest

API: Internal/Beta

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
filterStartDate: Long?
filterEndDate: Long?
filterType: ProductType?
filterProvider: String?
filterProductCategory: String?
filterAllocation: String?
filterWorkspace: String?
filterWorkspaceProject: Boolean?

VisualizationRetrieveBreakdownResponse

API: Internal/Beta

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

VisualizationRetrieveUsageResponse

API: Internal/Beta

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