Skip to content
First requestVisit website ↗
Navigation

Execute an analytics query

POST
https://api.channelautomation.com/api/analytics/execute

Authorization

  • bearerAuth
    optional
    bearerAuth
  • apiKey
    optional
    apiKey

Request body JSON required

  • sql_query
    string
    required

    The SQL query to execute (SELECT only)

Returns

200

Query executed successfully

JSON
  • success
    optional
    boolean
  • data
    optional
    array of
    object
  • metadata
    optional
    object
    • execution_time_ms
      optional
      integer
    • row_count
      optional
      integer

400

Invalid query or missing workspace ID
JSON
  • error
    optional
    string
  • details
    optional
    string

500

Query execution failed
JSON
  • error
    optional
    string
  • details
    optional
    string

Type to search…

↑↓ navigate↵ selectEsc close