Benchmark service

Benchmark service is a collection of indicators that analyze transaction data. They allow clients to quickly get a global idea of the data set, quickly answering generic questions, such as:

• What is a user's average monthly balance?
• How many transactions are reversed and what is the total amount of these transactions?
• How many days of the data set have a positive balance?
• The total sum of taxes paid?

And much more. The underlying calculations can also be returned with the call.

Calling the Benchmark Service

Endpoint:      https://linx.invers.nl:8100/api/linx/benchmark
Method:        POST

Header:        ApiKey:       string      (required)
               X-Request-ID: string      (required)
               ClientId:     string      (optional)
               InputHash:    string      (optional)

Body:          Data:         byte[]      (required)

Errors:        400, 403 or 500

Information

The output has many properties, which are explained in the tables below.

Result

In the returned JSON object there are several fields containing meta data on the analysis. In the result field, the actual analysis can be found. It contains an array of objects, each object containing an Indicator, a Value and a Measurements. Below are a number of tables describing the possible values each field can hold.

Indicator

Field	Type	Description
id	Integer	Identifier of the indicator
customerId	GUID
name	String	Name of the indicator
description	string	Description of the indicator
includeInternals	bool
includeTransactions	bool
threshold	Integer
lowerBound	Integer
upperBound	Integer

Value

Field	Type	Description
name	String	Name of the value
value	Integer	Contains the actual value of the indicator
unit	String	Describes the context of the value
transactions	Array of Transactions	Contains the transactions relating to this indicator. Can be empty.

Measurements

Measurements contains an array of objects. Each object consists of the following structure:

Field	Type	Description
name	String	Describes the measurement of the indicator
value	Integer	Contains the actual value of the measurement
unit	String	Describes the context of the measurement value
transactions	Array of Transactions	Contains the transactions used for this measurement. Can be empty.

Output (Example)

The output below contains some example objects as output

[
    {
        "$type": "LinX.Sdk.Proxy.Entities.BenchmarkResult, LinX.Platform.Sdk.Proxy",
        "id": 2,
        "name": "Kredietwaardigheid (Invers)",
        "description": "Meten van kreditwaardigheid",
        "contract": "NL00KNAB0123456789",
        "result": [
            {
                "indicator": {
                    "id": 1,
                    "customerId": "redacted",
                    "name": "Aantal maanden",
                    "description": "Aantal maanden waarop deze download betrekking op heeft",
                    "includeInternals": false,
                    "includeTransactions": false,
                    "threshold": 6,
                    "lowerBound": 6,
                    "upperBound": 24
                },
                "value": {
                    "name": "Aantal maanden",
                    "value": 3,
                    "unit": "count",
                    "transactions": []
                },
                "measurements": [
                    {
                        "name": "januari",
                        "value": 0,
                        "unit": "count",
                        "transactions": []
                    },
                    {
                        "name": "Mean",
                        "value": 0,
                        "unit": "value",
                        "transactions": []
                    },
                    {
                        "name": "StandardDeviation",
                        "value": 0,
                        "unit": "value",
                        "transactions": []
                    }
                ]
            }
        ]
    }
]