LYlytics
Metric

Metric

Fetch metrics by providing the arguments in the query-parameters

curl "$LIOAPI/api/metric?keyspace=segsize&metric=web&name=my-metric" -s -H "Authorization: $LIOKEY" | jq '.'
get/api/metric/

Request

  • Base URL
    https://api.lytics.io
  • URL
    https://api.lytics.io/api/metric/
  • Auth
    API key in header Authorization

Query parameters

account_idstring

Your Lytics account ID.

namestring

Name of the metric to return

dimensionstring required

Value of supported dimension (segment, experience, stream, etc)

dimension_idstring required

ID for the specific item within dimension such as a segment ID. Tip: If the type is a segment you can use all_segments as the dimension id to get all segments for the account.

dimension_typestring required

Type of metric to be returned (size, converted, etc)

aggregationstring

Aggregation to apply to metrics (sum, max, min)

intervalstring

Duration to roll-up metrics (2h for roll-up into two-hour buckets). Intervals smaller than two hours are not recommended.

include_empty_rowsboolean

Passing true will include zero values in the response for every interval whether metrics were logged during that period or not.

smoothboolean

Smooth metrics using a moving-average function

start_datestring

Fetch metrics after this date; both dates and relative-dates are supported

end_datestring

Fetch metrics before this date; both dates and relative-dates are supported

rangestring

Time string used to calculate range from now (e.g "2h" will return the last 2 hours). This parameter cannot be used in conjunction with start_date and/or end_date)

Response

OK

messagestring
statusnumber

Example response

{
  "data": [
    {
      "name": "sample-request",
      "dimension": "segsize",
      "dimension_id": "abc123",
      "dimension_type": "size",
      "range": "2d",
      "aggregation": "max",
      "interval": "2h",
      "is_cached": true,
      "values": [
        {
          "value": 0,
          "ts": "1525231674371"
        },
        {
          "value": 100,
          "ts": "1525238874371"
        },
        {
          "value": 200,
          "ts": "1525246074371"
        },
        {
          "value": 300,
          "ts": "1525253274371"
        },
        {
          "value": 400,
          "ts": "1525260474371"
        },
        {
          "value": 500,
          "ts": "1525267674371"
        },
        {
          "value": 600,
          "ts": "1525274874371"
        },
        {
          "value": 700,
          "ts": "1525282074371"
        },
        {
          "value": 800,
          "ts": "1525289274371"
        },
        {
          "value": 900,
          "ts": "1525296474371"
        }
      ]
    }
  ],
  "message": "success",
  "status": 200
}

Changes

No recorded changes to this operation across all 1 revision of this API.