Skip to content

List knowledge base query logs

GET
/knowledge-bases/{knowledgeBaseId}/query-logs

Returns paginated query logs for a knowledge base with optional filtering. Logs include query text, type (basic or stream), results count, performance metrics, and timestamps. Useful for analytics, debugging, and understanding usage patterns.

knowledgeBaseId
required

Unique identifier for the knowledge base to retrieve

string

Unique identifier for the knowledge base to retrieve

page

Page number (1-indexed)

integer
default: 1 >= 1

Page number (1-indexed)

pageSize

Results per page (max 100)

integer
default: 20 >= 1 <= 100

Results per page (max 100)

queryType

Filter by query type: basic (vector search), stream (LazyGraphRAG), or hybrid (RRF fusion)

string
Allowed values: basic stream hybrid

Filter by query type: basic (vector search), stream (LazyGraphRAG), or hybrid (RRF fusion)

hasResults

Filter by whether queries returned any results

string
Allowed values: true false

Filter by whether queries returned any results

startDate

Filter queries from this date (ISO 8601)

string format: date-time

Filter queries from this date (ISO 8601)

endDate

Filter queries until this date (ISO 8601)

string format: date-time

Filter queries until this date (ISO 8601)

Query logs retrieved successfully

object
items
required

Query log entries

Array<object>
object
kbQueryLogId
required

Unique identifier for this query log

string
knowledgeBaseId
required

Parent knowledge base ID

string
queryText
required

The search query text

string
queryType
required

Query type (basic, stream, or hybrid)

string
Allowed values: basic stream hybrid
resultsCount
required

Number of results returned

integer
topScore
required

Best similarity score (lower = better)

number
nullable
durationMs
required

Total query duration in milliseconds

integer
hasResults
required

Whether query returned any results

boolean
createdAt
required

When the query was executed (ISO 8601)

string format: date-time
total
required

Total count matching filters

integer
page
required

Current page number

integer
pageSize
required

Results per page

integer

Bad Request - Validation error or invalid input

object
error
required
string
code
string
details
nullable
retryable
boolean

Unauthorized - Authentication required or invalid token

object
error
required
string
code
string
details
nullable
retryable
boolean

Forbidden - Insufficient permissions

object
error
required
string
code
string
details
nullable
retryable
boolean

Not Found - Resource does not exist

object
error
required
string
code
string
details
nullable
retryable
boolean