v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB

Metrics

Retrieves a set of metrics

Retrieves a Metrics resource.

get/metrics

Query parameters

startstring date-time

YYYY-MM-DD

endstring date-time

YYYY-MM-DD

refreshstring

If refresh is set, data will be fetched from the source application even when cached data is available

Response

Metrics resource

endstring date nullable

startstring date nullable

metricsobject nullable

sourcesstring[] nullable

timestampstring date-time nullable

isReconciledboolean

lastReconciledstring date nullable

Example response

{
  "end": "2021-04-31",
  "start": "2021-01-31",
  "metrics": {
    "gross_income": {
      "label": "Gross Income",
      "format": "\"$\"#,##0.00",
      "series": {
        "2022-01-31": 25973.45,
        "2022-02-28": 22573.45,
        "2022-03-31": 68001.9,
        "2022-04-30": 30973.45,
        "2022-05-31": 50973.45,
        "2022-06-30": 0
      },
      "comment": "",
      "description": ""
    },
    "current_ratio": {
      "label": "Current Ratio",
      "format": "0.00",
      "series": {
        "2022-01-31": 6.444373122980516,
        "2022-02-28": 6.467820283927578,
        "2022-03-31": 3.022120085091376,
        "2022-04-30": 3.07833126725232,
        "2022-05-31": 3.2018274290984268,
        "2022-06-30": 1.6669570820900634
      },
      "comment": "",
      "description": ""
    }
  },
  "sources": [
    "quickbooks",
    "chargebee",
    "salesforce"
  ],
  "timestamp": "2022-03-16T00:39:31+00:00",
  "lastReconciled": "2021-01-31"
}