{
  "opencollection": "1.0.0",
  "info": {
    "name": "SigNoz alerts metrics API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "metrics",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List metric names",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}{base_path}/api/v2/metrics",
            "params": [
              {
                "name": "start",
                "value": "",
                "type": "query"
              },
              {
                "name": "end",
                "value": "",
                "type": "query"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              },
              {
                "name": "searchText",
                "value": "",
                "type": "query"
              },
              {
                "name": "source",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint returns a list of distinct metric names within the specified time range"
        },
        {
          "info": {
            "name": "Get metric alerts",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}{base_path}/api/v2/metrics/:metric_name/alerts",
            "params": [
              {
                "name": "metric_name",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint returns associated alerts for a specified metric"
        },
        {
          "info": {
            "name": "Get metric attributes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}{base_path}/api/v2/metrics/:metric_name/attributes",
            "params": [
              {
                "name": "start",
                "value": "",
                "type": "query"
              },
              {
                "name": "end",
                "value": "",
                "type": "query"
              },
              {
                "name": "metric_name",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint returns attribute keys and their unique values for a specified metric"
        },
        {
          "info": {
            "name": "Get metric dashboards",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}{base_path}/api/v2/metrics/:metric_name/dashboards",
            "params": [
              {
                "name": "metric_name",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint returns associated dashboards for a specified metric"
        },
        {
          "info": {
            "name": "Get metric highlights",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}{base_path}/api/v2/metrics/:metric_name/highlights",
            "params": [
              {
                "name": "metric_name",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint returns highlights like number of datapoints, totaltimeseries, active time series, last received time for a specified metric"
        },
        {
          "info": {
            "name": "Get metric metadata",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}{base_path}/api/v2/metrics/:metric_name/metadata",
            "params": [
              {
                "name": "metric_name",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint returns metadata information like metric description, unit, type, temporality, monotonicity for a specified metric"
        },
        {
          "info": {
            "name": "Update metric metadata",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{host}:{port}{base_path}/api/v2/metrics/:metric_name/metadata",
            "params": [
              {
                "name": "metric_name",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint helps to update metadata information like metric description, unit, type, temporality, monotonicity for a specified metric"
        },
        {
          "info": {
            "name": "Inspect raw metric data points",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{host}:{port}{base_path}/api/v2/metrics/inspect",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Returns raw time series data points for a metric within a time range (max 30 minutes). Each series includes labels and timestamp/value pairs."
        },
        {
          "info": {
            "name": "Check if non-SigNoz metrics have been received",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}{base_path}/api/v2/metrics/onboarding",
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "Lightweight endpoint that checks if any non-SigNoz metrics have been ingested, used for onboarding status detection"
        },
        {
          "info": {
            "name": "Get metrics statistics",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{host}:{port}{base_path}/api/v2/metrics/stats",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint provides list of metrics with their number of samples and timeseries for the given time range"
        },
        {
          "info": {
            "name": "Get metrics treemap",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{host}:{port}{base_path}/api/v2/metrics/treemap",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint returns a treemap visualization showing the proportional distribution of metrics by sample count or time series count"
        }
      ]
    }
  ],
  "bundled": true
}