Package com.lantanagroup.link.api.controller

Class MetricController

java.lang.Object

com.lantanagroup.link.api.controller.BaseController

com.lantanagroup.link.api.controller.MetricController

@RestController
@RequestMapping("/api/metric")
public class MetricController
extends BaseController

Field Summary

Fields inherited from class com.lantanagroup.link.api.controller.BaseController

config, ctx

Constructor Summary

Constructors

Constructor	Description
MetricController()

Method Summary

Modifier and Type	Method	Description
MetricsReportResponse	getMetricReport(String period, String tenantId, String reportId)	Returns calculated metrics based on the supplied reporting period and optional parameters.

Methods inherited from class com.lantanagroup.link.api.controller.BaseController

setConfig, setCtx

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MetricController

public MetricController()

Method Details

getMetricReport

@GetMapping("/{period}")
public MetricsReportResponse getMetricReport(@PathVariable
 String period,
 @RequestParam(name="tenantId",required=false)
 String tenantId,
 @RequestParam(name="reportId",required=false)
 String reportId)

Returns calculated metrics based on the supplied reporting period and optional parameters.

Parameters:

period - - the reporting period for the metrics

reportId - - filter metrics by a specific report

tenantId - - filter metrics by the specific tenant

Returns:

Returns a MetricsReportResponse

Throws:

org.springframework.web.server.ResponseStatusException - Thrown when an invalid period has been supplied