{
  "opencollection": "1.0.0",
  "info": {
    "name": "openobserve Actions Search API",
    "version": "0.90.0"
  },
  "items": [
    {
      "info": {
        "name": "Search",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Search data with SQL",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/:org_id/_search",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Stream type. one of: logs, metrics, traces. Defaults to logs."
              },
              {
                "name": "is_ui_histogram",
                "value": "",
                "type": "query",
                "description": "Whether to return histogram data for UI (default: false)"
              },
              {
                "name": "is_multi_stream_search",
                "value": "",
                "type": "query",
                "description": "Indicate is search is for multi stream (default: false)"
              },
              {
                "name": "validate",
                "value": "",
                "type": "query",
                "description": "Validate query fields against stream schema and User-Defined Schema (UDS). When enabled, returns error if queried fields are not in schema or not allowed by UDS (default: false)"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Executes SQL queries against log streams with support for complex search patterns, time range filtering, aggregations, and histogram generation. Supports advanced features like multi-stream searches, caching, and UI optimizations for dashboard visualizations."
        },
        {
          "info": {
            "name": "Search query history",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/:org_id/_search_history",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Retrieves historical search queries and their execution details"
        },
        {
          "info": {
            "name": "Search partition data",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/:org_id/_search_partition",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Stream type. Must be one of: logs, metrics, traces. Defaults to logs if not specified."
              },
              {
                "name": "enable_align_histogram",
                "value": "",
                "type": "query",
                "description": "Enable align histogram"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Executes search queries on partitioned log data with specified parameters"
        },
        {
          "info": {
            "name": "Stream search results",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/:org_id/_search_stream",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "is_ui_histogram",
                "value": "",
                "type": "query",
                "description": "Whether to return histogram data for UI"
              },
              {
                "name": "is_multi_stream_search",
                "value": "",
                "type": "query",
                "description": "Indicate is search is for multi stream"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Executes a search query and streams the results back in real-time using HTTP/2 server-sent events. This is ideal for large result sets or long-running queries where you want to receive data as it becomes available rather than waiting for the complete response. Results are streamed as JSON objects separated by newlines."
        },
        {
          "info": {
            "name": "Get field values with HTTP/2 streaming",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/:org_id/_values_stream",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Retrieves field values from logs using HTTP/2 streaming for real-time results"
        },
        {
          "info": {
            "name": "Search around specific log entry",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/:org_id/:stream_name/_around",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "stream_name",
                "value": "",
                "type": "path",
                "description": "stream_name name"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Stream type. Must be one of: logs, metrics, traces. Defaults to logs if not specified."
              },
              {
                "name": "key",
                "value": "",
                "type": "query",
                "description": "around key"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "around size"
              },
              {
                "name": "regions",
                "value": "",
                "type": "query",
                "description": "regions, split by comma"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "timeout, seconds"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Searches for log entries around a specific key (timestamp or record identifier) within a stream. Returns logs before and after the specified key, useful for investigating context around specific events or errors."
        },
        {
          "info": {
            "name": "Search around specific log record",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/:org_id/:stream_name/_around",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "stream_name",
                "value": "",
                "type": "path",
                "description": "stream_name name"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "around size"
              },
              {
                "name": "regions",
                "value": "",
                "type": "query",
                "description": "regions, split by comma"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "timeout, seconds"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Advanced version of around search that accepts a full log record in the request body instead of just a key. Searches for log entries around the specified record, providing better context matching based on the complete record data."
        },
        {
          "info": {
            "name": "Get distinct field values",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/:org_id/:stream_name/_values",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "stream_name",
                "value": "",
                "type": "path",
                "description": "stream_name name"
              },
              {
                "name": "type",
                "value": "",
                "type": "query",
                "description": "Stream type. Must be one of: logs, metrics, traces. Defaults to logs if not specified."
              },
              {
                "name": "fields",
                "value": "",
                "type": "query",
                "description": "fields, split by comma"
              },
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "filter, eg: a=b"
              },
              {
                "name": "keyword",
                "value": "",
                "type": "query",
                "description": "keyword, eg: abc"
              },
              {
                "name": "size",
                "value": "",
                "type": "query",
                "description": "size"
              },
              {
                "name": "from",
                "value": "",
                "type": "query",
                "description": "from"
              },
              {
                "name": "start_time",
                "value": "",
                "type": "query",
                "description": "start time"
              },
              {
                "name": "end_time",
                "value": "",
                "type": "query",
                "description": "end time"
              },
              {
                "name": "regions",
                "value": "",
                "type": "query",
                "description": "regions, split by comma"
              },
              {
                "name": "timeout",
                "value": "",
                "type": "query",
                "description": "timeout, seconds"
              },
              {
                "name": "no_count",
                "value": "",
                "type": "query",
                "description": "no need count, true of false"
              }
            ],
            "auth": {
              "type": "apikey",
              "key": "Authorization",
              "value": "{{Authorization}}",
              "placement": "header"
            }
          },
          "docs": "Retrieves the top N distinct values for specified fields within a stream and time range. Supports filtering, keyword search, and frequency counting. Essential for building dynamic filters, dropdowns, and understanding data cardinality in dashboards and analytics."
        }
      ]
    }
  ],
  "bundled": true
}