Metrics

patch

https://app.financekey.com/OData/Metrics({key})

The Metric table defines various metrics (quantifiable measurements) that should be collected and retained by the system. Metrics are executed on all defined Client Environments and are stored in the FinanceKey header application in the associated table 'Metric Results'

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

metricId

int32

MetricId is an int data type field in the Metric table used to store the unique ID for each record in the Metric table. It is used to uniquely identify each record in the table and is required when referencing records from the Metric table.

name

string

required

length between 1 and 128

The Name of data type nvarchar with a maximum length of 128 field in the Metric table is used to store a variable-length character string of up to 128 characters. The data used in this field is most commonly up to 25 characters but can exceed the maximum length if needed. The characters can be from any language that supports the Unicode Standard, including English and non-English characters.

description

string

required

length between 1 and 450

The Description field in the Metric table is an nvarchar data type with a maximum length of 450 characters. It is used to store general information about the Metric object and is intended to provide users with additional context or helpful descriptions.

comment

string | null

Miscellaneous notes and information for the entry or record.

viewPropertyId

int32

The ViewPropertyId field of type int in the Metric table is a foreign key referencing the Id field in the ViewProperty table. It is used to link a metric to its related view property.

groupByPropertyId

int32 | null

The GroupByPropertyId field in the Metric table stores the id of a group of metrics. This group might refer to a specific property, page, or any other factor that makes sense for grouping metrics. This allows for differentiation between different metric groups that can be easily accessed with the GroupByPropertyId.

scheduleId

int32

ScheduleId is an int data type field in the Metric table, which is used to store the ID of the metric schedule associated with a specific metric. A metric schedule specifies the start and end dates for a metric, as well as the intervals (e.g. hourly, daily, etc.) of when the metric should be collected.

activityStampId

int32

ActivityStampId is an integer field in the Metric table that is used to record and track a foreign key reference for related audit activities. This allows an efficient query of all activities related to a particular Metric.

aggregateOperatorId

string | null

AggregateOperatorId is an nvarchar field of maximum length 32 in the Metric table. It represents the ID of the aggregation operator used to calculate the metric for the entry in the Metric table.

factor

double

required

The multiplier that should be applied to the result sets for display on dashboards etc.

format

string

required

length between 1 and 8

The formatting that should be applied to the results for presentation in the UI on dashboards and charts.

Headers

content-type

string

enum

Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

200

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here!