Update a saved query

PUT

https://api.channelautomation.com/api/analytics/saved-queries/{id}

Authorization

bearerAuth
optional
bearerAuth

apiKey
optional
apiKey

Path parameters

id
string
required
Saved query ID

format: uuid

Request body JSON required

name
optional
string
description
optional
string
query_config
optional
object
sql_query
optional
string
visualization_config
optional
object
is_shared
optional
boolean

Returns

200

Query updated 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

Invalid request or workspace required

JSON

error
optional
string
details
optional
string

403

Not authorized to edit this query

JSON

error
optional
string
details
optional
string

404

Query not found

JSON

error
optional
string
details
optional
string

500

Server error

JSON

error
optional
string
details
optional
string

Update a saved query

curl --request PUT \
  --url 'https://api.channelautomation.com/api/analytics/saved-queries/<id>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "string",
  "description": "string",
  "query_config": {},
  "sql_query": "string",
  "visualization_config": {},
  "is_shared": true
}
'

const url = 'https://api.channelautomation.com/api/analytics/saved-queries/<id>';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'string',
    description: 'string',
    query_config: {},
    sql_query: 'string',
    visualization_config: {},
    is_shared: true
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/analytics/saved-queries/<id>"

payload = {
    "name": "string",
    "description": "string",
    "query_config": {},
    "sql_query": "string",
    "visualization_config": {},
    "is_shared": True
}
headers = {"Content-Type": "application/json"}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "workspace_id": "string",
  "user_email": "string",
  "name": "string",
  "description": "string",
  "query_config": {},
  "sql_query": "string",
  "visualization_config": {},
  "is_shared": true,
  "execution_count": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}

{
  "error": "string",
  "details": "string"
}