Skip to main content
GET
/
api
/
v1
/
metric-configs
/
{configId}
Get metric config
curl --request GET \
  --url https://api.logfleet.io/api/v1/metric-configs/{configId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "version": 123,
  "enabled": true,
  "scope": {
    "type": "all",
    "locations": [
      "<string>"
    ],
    "tags": [
      "<string>"
    ]
  },
  "metrics": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "config_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "namespace": "<string>",
      "description": "<string>",
      "enabled": true,
      "type": "counter",
      "source_field": "<string>",
      "filter": {
        "field": "<string>",
        "operator": "eq",
        "value": "<string>",
        "conditions": "<array>",
        "logic": "and"
      },
      "tags": [
        {
          "name": "<string>",
          "source": "field",
          "value": "<string>"
        }
      ],
      "counter_opts": {
        "increment_by": "<string>"
      },
      "gauge_opts": {
        "value_field": "<string>"
      },
      "histogram_opts": {
        "value_field": "<string>",
        "buckets": [
          123
        ]
      },
      "cardinality": {
        "max_tag_cardinality": 1000,
        "on_limit_exceeded": "drop"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization
string
header
required

JWT token obtained from /auth/login

Path Parameters

configId
string<uuid>
required

Metric config ID

Response

Metric config

id
string<uuid>
organization_id
string<uuid>
name
string
description
string
version
integer
enabled
boolean
scope
object
metrics
object[]
created_at
string<date-time>
updated_at
string<date-time>
created_by
string<uuid>