Get comprehensive dashboard metrics - Lerian

Get comprehensive dashboard metrics

curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/reports/contexts/{contextId}/dashboard/metrics \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://matcher.sandbox.lerian.net/v1/reports/contexts/{contextId}/dashboard/metrics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://matcher.sandbox.lerian.net/v1/reports/contexts/{contextId}/dashboard/metrics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://matcher.sandbox.lerian.net/v1/reports/contexts/{contextId}/dashboard/metrics"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "breakdowns": {
    "agedBreaks": [
      {
        "bucket": "0-24h",
        "value": 15
      }
    ],
    "byAge": [
      {
        "bucket": "0-24h",
        "value": 15
      }
    ],
    "byReason": {},
    "byRule": [
      {
        "count": 1250,
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Exact Amount Match"
      }
    ],
    "bySeverity": {}
  },
  "summary": {
    "criticalExposure": "15000.00",
    "matchRate": 94.4,
    "oldestExceptionAgeHours": 72.5,
    "pendingExceptions": 4,
    "totalMatches": 11800,
    "totalTransactions": 12500
  },
  "trends": {
    "dates": [
      "<string>"
    ],
    "exceptions": [
      123
    ],
    "ingestion": [
      123
    ],
    "matchRates": [
      123
    ],
    "matches": [
      123
    ]
  },
  "updatedAt": "2025-01-15T10:30:00Z"
}

GET

/

v1

/

reports

/

contexts

/

{contextId}

/

dashboard

/

metrics

Get comprehensive dashboard metrics

curl --request GET \
  --url https://matcher.sandbox.lerian.net/v1/reports/contexts/{contextId}/dashboard/metrics \
  --header 'Authorization: Bearer <token>'

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://matcher.sandbox.lerian.net/v1/reports/contexts/{contextId}/dashboard/metrics"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://matcher.sandbox.lerian.net/v1/reports/contexts/{contextId}/dashboard/metrics', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://matcher.sandbox.lerian.net/v1/reports/contexts/{contextId}/dashboard/metrics"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

{
  "breakdowns": {
    "agedBreaks": [
      {
        "bucket": "0-24h",
        "value": 15
      }
    ],
    "byAge": [
      {
        "bucket": "0-24h",
        "value": 15
      }
    ],
    "byReason": {},
    "byRule": [
      {
        "count": 1250,
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Exact Amount Match"
      }
    ],
    "bySeverity": {}
  },
  "summary": {
    "criticalExposure": "15000.00",
    "matchRate": 94.4,
    "oldestExceptionAgeHours": 72.5,
    "pendingExceptions": 4,
    "totalMatches": 11800,
    "totalTransactions": 12500
  },
  "trends": {
    "dates": [
      "<string>"
    ],
    "exceptions": [
      123
    ],
    "ingestion": [
      123
    ],
    "matchRates": [
      123
    ],
    "matches": [
      123
    ]
  },
  "updatedAt": "2025-01-15T10:30:00Z"
}

Autorizaciones

Authorization

string

header

requerido

Bearer token authentication (format: "Bearer {token}")

Encabezados

X-Request-Id

string

A unique identifier for tracing the request across services.

Parámetros de ruta

contextId

string<uuid>

requerido

The unique identifier of the reconciliation context. Context ID

Parámetros de consulta

date_from

string<date>

Start date (YYYY-MM-DD) Start date (YYYY-MM-DD), inclusive. Optional: defaults to 30 days before date_to. Window may not exceed 90 days.

date_to

string<date>

End date (YYYY-MM-DD) End date (YYYY-MM-DD), inclusive. Optional: defaults to tomorrow (UTC). Window may not exceed 90 days.

source_id

string<uuid>

Source ID filter

Respuesta

Indicates that the request was successful and the response contains the expected data.

breakdowns

object

requerido

Categorical aggregations of exceptions and matches.

Show child attributes

summary

object

requerido

Executive summary metrics.

Show child attributes

trends

object

requerido

Time-series trend data across the window.

Show child attributes

updatedAt

string<date-time>

requerido

Timestamp when these metrics were computed (RFC 3339, UTC).

Ejemplo:

"2025-01-15T10:30:00Z"