Search API
Query across all platform entities with full-text search.
Global Search
GET /search
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
q | string | Yes | Search query |
space_id | uuid | Yes | Scope to specific space |
entity_types | string | No | Comma-separated: products,issues,meetings,users |
limit | integer | No | Max results per type (default: 10) |
Example Request
curl -X GET "https://api.qarion.com/search?q=customer&space_id=SPACE_UUID" \
-H "Authorization: Bearer YOUR_API_KEY"
Response
Results are grouped by entity type:
{
"products": [
{
"id": "...",
"name": "Customer Events",
"description": "Raw event stream...",
"product_type": "table",
"score": 0.95
}
],
"issues": [
{
"id": "...",
"title": "Customer ID nulls",
"status": "open",
"score": 0.82
}
],
"meetings": [],
"users": [
{
"id": "...",
"name": "Customer Data Team",
"email": "customer-team@example.com",
"score": 0.75
}
]
}
Search Behavior
Fuzzy Matching
Search uses fuzzy matching to handle typos:
custmermatchescustomeranlyticsmatchesanalytics
Field Weights
Different fields have different search weights:
| Field | Weight | Description |
|---|---|---|
| Name/Title | High | Primary identifier |
| Description | Medium | Summary text |
| Tags | Medium | Category labels |
| Documentation | Low | Long-form content |
Highlighting
Search results include highlighted matches (when available):
{
"name": "<em>Customer</em> Events",
"description": "Raw event stream for <em>customer</em> tracking"
}
Entity-Specific Search
Products Only
GET /search?q=metrics&space_id=...&entity_types=products
Multiple Types
GET /search?q=order&space_id=...&entity_types=products,issues
Search Performance
- Results are cached for 60 seconds
- Maximum 50 results per entity type
- For large result sets, use pagination via the catalog API
Related Endpoints
- Catalog API — For filtered product listing with pagination
- Issues API — For filtered issue queries