Skip to main content
GET
/
api
/
data
/
{view_name}
Retrieves data from view
curl --request GET \
  --url https://api.example.com/api/data/{view_name} \
  --header 'Authorization-PSK: <api-key>'
{
  "start": 123,
  "row_count": 123,
  "columns": [
    "<string>"
  ],
  "next_start": 123,
  "data": [
    [
      "<unknown>"
    ]
  ]
}

Authorizations

​
Authorization-PSK
string
header
required

Path Parameters

​
view_name
string
required

Name of the database view to retrieve data from.

Query Parameters

​
filter
string | null

Optional filter expression to apply to the view query.

​
order
string | null

Optional ordering clause for the result set.

​
start
integer
default:0

Starting offset for paginated results.

​
limit
integer
default:100

Maximum number of records to return.

​
psk
string | null

Pre-shared key used to authorize access.

Response

Data retrieved successfully.

​
start
integer
required

The starting offset that is used for pagination when returning a subset of the dataset.

​
row_count
integer
required

The number of rows included in the current response.

​
columns
string[]
required

A list of column names representing the structure of the returned dataset.

​
next_start
integer | null

The offset value for the next page of data, if additional results are available.

​
data
any[][] | null

The actual tabular data returned, where each inner list represents a row of values.