Query by SQL Enpoint

Overview

The Query by SQL API allows you to retrieve processed entries from an application using SQL. The application is identified by its :app_id. You can use standard SQL SELECT queries to access data across all sources within the specified app.

!This endpoint only supports data retrieval. Only the SELECT clause is allowed. Write-only or modifying queries (e.g., INSERT, UPDATE, DELETE) are not permitted.

Endpoint

POST https://api.myboardtoday.com/app/:app_id/query

Path Parameters

Parameter	Type	Required	Description
app_id	UUID	Yes	The unique identifier of the application

Headers

Header	Required	Description
x-api-key	Yes	API key used for authentication

Request Body

The request body must be a JSON object containing the following field:

Field	Type	Required	Description
query	string	Yes	The SQL query to execute. Use standard SQL syntax with the SELECT clause.

!Field names and source names are case-sensitive and must be enclosed in backticks `. Treat each source as a database table and each field as a column.

Example Request

{
  "query": "SELECT `name`, `email` FROM `user_data` WHERE `status` = 'active'"
}

Response

The response returns the query result as a JSON array of objects, where each object represents a row of data.

Example Response

[
  {
    "name": "Alice Johnson",
    "email": "alice@example.com"
  },
  {
    "name": "Bob Smith",
    "email": "bob@example.com"
  }
]

Report Bugs, Request New Features, and Win $50 Every Month

We value your precious feedback. Please contact us when you find a bug or would like to request a new feature. (In the main panel, click on the bob logo on the top left corner, then in the Dropdown menu click on “contact for bugs or new features”). Every month we will select an “opinion leader” and reward him/her with $50 in cash.