Search help content
GET /api/v1/help/search
GET
/api/v1/help/search
UX-02: Full-text search across help content using PostgreSQL tsvector with ranked results.
Authorizations
Parameters
Query Parameters
q
required
Search query
string
Search query
limit
Max results
integer
Max results
Responses
200
Successful Response
Response schema for help content search.
object
results
Array<object>
A single ranked search result from full-text search.
object
id
required
Content row ID.
string format: uuid
markdown
required
Full Markdown body.
string
page_key
required
Dashboard page identifier.
string
rank
required
Ts_rank_cd relevance score.
number
snippet
required
Highlighted excerpt with tags.
string
vertical_slug
required
Vertical slug or ‘_generic’.
string
total
Number of matching results.
integer
422
Validation Error
object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string