Valuekeep Developers - Web API Reference

Requests | Indicator

Overview


URL api/{tenantKey}/{orgKey}/requests/indicators
Methods Supported GET

All Operations

This service includes the following operations:

All Resources

This service uses the following resources:

GET Operations

GET Get Indicator Summary By Code

Custom operation 'GetIndicatorSummaryByCode'.

The following elements are required:

company (string) Company.
code (string) Code.

Response:

When successful, the response body contains a resource of type 'IndicatorSummary'. See IndicatorSummary.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /requests/indicators/getIndicatorSummaryByCode/{company}/{code}

GET Kpi Chart

Custom operation 'KpiChart'.

The following elements are required:

company (string) Company.
code (string) Code.
referenceDate (DateTime?) ReferenceDate.

Response:

When successful, the response body contains a list of resources of type 'KpiChartData'. See KpiChartData.

Response status codes:

200 OK. The operation was completed successfully.
400 BadRequest. The request parameters are invalid.

Resource URL:

GET /requests/indicators/kpiChart/{company}/{code}

Resources


IndicatorSummary

The following elements are optional:

value (decimal) Value.
homologValue (string) Homolog Value.
variation (decimal) Variation.
trend (int) Trend.
valueType (string) Value Type.
valueFractionDigits (int) Value Fraction Digits.
currencySymbol (string) Currency Symbol.
result (int) Result.


KpiChartData

The following elements are required:

period (string) Period.

The following elements are optional:

value (decimal) Value.
homologous (decimal) Homologous.
forecast (decimal) Forecast.