Skip to main content
GET
https://your-rootprint-host
/
api
/
search
/
logs
Search logs with a search API key
curl --request GET \
  --url https://your-rootprint-host/api/search/logs \
  --header 'Authorization: Bearer <token>'
{
  "hits": [
    {}
  ],
  "numHits": 123,
  "elapsedTimeMicros": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.rootprint.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Authentication

Use a search API key from Administration → API keys. Each search API key is scoped to one index, and this endpoint searches that index only. 
Authorization: Bearer <search-api-key>

Authorizations

​
Authorization
string
header
default:Bearer rootprint_search_token
required

Search token generated in the Rootprint admin panel.

Query Parameters

​
q
string

Quickwit query string.

​
limit
integer

Maximum number of hits to return.

Required range: 1 <= x <= 1000
​
offset
integer

Zero-based result offset.

Required range: x >= 0
​
startTs
number

Inclusive start timestamp in seconds since Unix epoch.

​
endTs
number

Inclusive end timestamp in seconds since Unix epoch.

​
sortOrder
enum<string>

Timestamp sort order.

Available options:
asc,
desc
​
countAll
boolean

When true, ask Quickwit for the total hit count.

Response

Search results.

​
hits
object[]
required
​
numHits
integer
required
​
elapsedTimeMicros
integer
required