Skip to main content

Search API

Query across all platform entities with full-text search.

GET /search

Query Parameters

ParameterTypeRequiredDescription
qstringYesSearch query
space_iduuidYesScope to specific space
entity_typesstringNoComma-separated: products,issues,meetings,users
limitintegerNoMax 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:

  • custmer matches customer
  • anlytics matches analytics

Field Weights

Different fields have different search weights:

FieldWeightDescription
Name/TitleHighPrimary identifier
DescriptionMediumSummary text
TagsMediumCategory labels
DocumentationLowLong-form content

Highlighting

Search results include highlighted matches (when available):

{
"name": "<em>Customer</em> Events",
"description": "Raw event stream for <em>customer</em> tracking"
}

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