Skip to main content
POST
db.rows.select

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
table
string
required

Table name: letters, digits and underscores, starting with a letter or underscore (max 63).

Pattern: ^[A-Za-z_][A-Za-z0-9_]{0,62}$
schema
string
default:public

Database schema the table is in. Default "public".

Pattern: ^[A-Za-z_][A-Za-z0-9_]{0,62}$
columns
string[]

Columns to return, 1 to 100. All columns when omitted.

Required array length: 1 - 100 elements

Column name.

Pattern: ^[A-Za-z_][A-Za-z0-9_]{0,62}$
filters
object[]

Conditions every row must meet (AND), up to 20.

Maximum array length: 20
order
object[]

Sort order, up to 5 columns.

Required array length: 1 - 5 elements
limit
number
default:100

Rows per page, 1 to 1000. Default 100.

Required range: 1 <= x <= 1000
cursor
string

The nextCursor of the previous page, to get the next one.

Required string length: 1 - 16
Pattern: ^\d{1,9}$

Response

The result

results
object[]
required

The rows, as { column: value }.

nextCursor
string

Pass as cursor for the next page; absent on the last page.

truncated
boolean

Present when rows were dropped to stay under 1 MB; continue with nextCursor.