{
  "opencollection": "1.0.0",
  "info": {
    "name": "SigNoz alerts dashboard API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "dashboard",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get public dashboard",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}{base_path}/api/v1/dashboards/:id/public",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint returns public sharing config for a dashboard"
        },
        {
          "info": {
            "name": "Create public dashboard",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://{host}:{port}{base_path}/api/v1/dashboards/:id/public",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint creates public sharing config and enables public sharing of the dashboard"
        },
        {
          "info": {
            "name": "Update public dashboard",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://{host}:{port}{base_path}/api/v1/dashboards/:id/public",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint updates the public sharing config for a dashboard"
        },
        {
          "info": {
            "name": "Delete public dashboard",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://{host}:{port}{base_path}/api/v1/dashboards/:id/public",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "SigNoz-Api-Key",
              "value": "{{SigNoz-Api-Key}}",
              "placement": "header"
            }
          },
          "docs": "This endpoint deletes the public sharing config and disables the public sharing of a dashboard"
        },
        {
          "info": {
            "name": "Get public dashboard data",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}{base_path}/api/v1/public/dashboards/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This endpoint returns the sanitized dashboard data for public access"
        },
        {
          "info": {
            "name": "Get query range result",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://{host}:{port}{base_path}/api/v1/public/dashboards/:id/widgets/:idx/query_range",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path"
              },
              {
                "name": "idx",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "This endpoint return query range results for a widget of public dashboard"
        }
      ]
    }
  ],
  "bundled": true
}