Sign in

v2

latestOpenAPI 3.0.02026-08-073221853.1 MB
Metrics
Metrics

Read Single Metric Value

get/console/v1/metrics

Query parameters

idstring required

The unique identifier of the metric with format <metric_id>::<type>

datestring required
Example:2024-01-01

Expected valid date in the form of YYYY-MM-DD

Response

Get metric data on given date response

messagestring required

A simple string explaining the result of the operation.

Example response

{
  "message": "Metric read successfully.",
  "data": [
    {
      "value": 0,
      "unit_type": "overall",
      "numerator": null,
      "denominator": null,
      "metric_name": "TestMetricCapi",
      "metric_type": "sum"
    },
    {
      "value": 0,
      "unit_type": "userID",
      "numerator": null,
      "denominator": null,
      "metric_name": "TestMetricCapi",
      "metric_type": "sum"
    }
  ]
}