API Reference

Execute Custom SQL Query

post
https://api.triplewhale.com/api/v2/orcabase/api/sql

Run custom SQL queries for structured data retrieval. The response returns the query results in a JSON format.

Body Params
string
required

The shop domain for which you are requesting data (e.g., example.myshopify.com).

string
required

The SQL query string to execute. Include dynamic @startDate AND @endDate parameters in your query string, and provide specific start and end values in the request body via period.startDate and period.endDate.

string

The currency for data aggregation (e.g., USD, EUR). Defaults to the currency provided during user account registration.

period
object
required

The date range for the query period.

Responses

Updated 4 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago