Skip to main content
POST
Scan Data

Authorizations

Authorization
string
header
required

Bearer token authentication. Include the token in the Authorization header as 'Bearer '

Query Parameters

include_metrics
boolean

Include metrics in the response. Default is false.

Body

application/json

The scan condition. It includes projection, filter, and limit.

filter
string | null
default:""

SQL WHERE clause to filter the results. If not specified, no filtering will be applied.

Example:

"text like '%hello%'"

limit
integer<int32> | null
default:0

Number of rows to return in the result set. If set to 0 or not specified, returns all matching rows.

Example:

"10"

projection
string | null
default:*

Columns to include in the result set. Uses SQL projection syntax (e.g. "col1, col2"). If not specified, all columns will be returned.

Example:

"id, metadata, text"

Response

Successfully retrieved the scan results.

code
integer<int32>
required

HTTP status code.

Required range: x >= 0
success
boolean
required

Whether the request was successful.

data
object
exception
object