Search API Overview

The Informer Search API provides unified search across multiple content types within a tenant. All routes are prefixed with /api.

Features

• Universal Search - Search across datasets, reports, templates, jobs, and other content types
• Driver-Based - Extensible search architecture with type-specific drivers
• Discovery - Automatic discovery of searchable content types

Search Drivers

The search system uses drivers to handle different content types. Each driver implements search for a specific entity type (datasets, reports, users, etc.).

Authentication

All Search API endpoints require authentication via session cookies or API tokens.

Endpoint

GET /api/search

Discover available search drivers and perform searches.

Authentication: Required (session)

Query Parameters:

Parameter	Type	Description
q	string	Search query (optional, empty string allowed)

Response:

Returns HAL response with available search drivers and results (if query provided).

Example Request:

GET /api/search?q=sales

Example Response:

{
  "_links": {
    "self": { "href": "/api/search?q=sales" }
  },
  "_embedded": {
    "inf:datasets": {
      "results": [
        {
          "id": "ds-123",
          "name": "Sales Data",
          "description": "Quarterly sales figures",
          "type": "dataset"
        }
      ]
    },
    "inf:reports": {
      "results": [
        {
          "id": "rpt-456",
          "name": "Sales Report",
          "description": "Monthly sales analysis",
          "type": "report"
        }
      ]
    }
  }
}

Notes:

• Without a query parameter, returns discovery information about available search drivers
• With a query parameter, executes search across all registered drivers
• Results are grouped by content type in embedded sections
• Each driver determines which fields are searched and how results are ranked

Search Tips

• Use simple keywords for best results
• Search is case-insensitive
• Partial matches are supported
• Results are relevance-ranked within each content type