Skip to content
First requestVisit website ↗
Navigation

Save a new query

POST
https://api.channelautomation.com/api/analytics/saved-queries

Authorization

  • bearerAuth
    optional
    bearerAuth
  • apiKey
    optional
    apiKey

Request body JSON required

  • name
    string
    required

    Name of the saved query

  • query_config
    object
    required

    Query builder configuration

  • sql_query
    string
    required

    Generated SQL query

  • description
    optional
    string

    Optional description of the query

  • visualization_config
    optional
    object

    Chart/visualization configuration

  • is_shared
    optional
    boolean

    Whether to share with workspace team

    default: false

Returns

201

Query saved successfully

JSON
  • id
    optional
    string
    format: uuid
  • workspace_id
    optional
    string
  • user_email
    optional
    string
  • name
    optional
    string
  • description
    optional
    string
  • query_config
    optional
    object
  • sql_query
    optional
    string
  • visualization_config
    optional
    object
  • is_shared
    optional
    boolean
  • execution_count
    optional
    integer
  • created_at
    optional
    string
    format: date-time
  • updated_at
    optional
    string
    format: date-time

400

Missing required fields or invalid workspace
JSON
  • error
    optional
    string
  • details
    optional
    string

500

Server error
JSON
  • error
    optional
    string
  • details
    optional
    string

Type to search…

↑↓ navigate↵ selectEsc close