Update a model
curl --request PATCH \
--url https://charts.basedash.com/api/public/organizations/{orgId}/models/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"referenceName": "<string>",
"description": "<string>",
"sqlQuery": "<string>",
"measures": [
{
"name": "<string>",
"sql": "<string>",
"description": "<string>"
}
],
"segments": [
{
"name": "<string>",
"sql": "<string>",
"description": "<string>"
}
],
"defaultTimeColumn": "<string>",
"verified": true
}
'import requests
url = "https://charts.basedash.com/api/public/organizations/{orgId}/models/{id}"
payload = {
"name": "<string>",
"referenceName": "<string>",
"description": "<string>",
"sqlQuery": "<string>",
"measures": [
{
"name": "<string>",
"sql": "<string>",
"description": "<string>"
}
],
"segments": [
{
"name": "<string>",
"sql": "<string>",
"description": "<string>"
}
],
"defaultTimeColumn": "<string>",
"verified": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
referenceName: '<string>',
description: '<string>',
sqlQuery: '<string>',
measures: [{name: '<string>', sql: '<string>', description: '<string>'}],
segments: [{name: '<string>', sql: '<string>', description: '<string>'}],
defaultTimeColumn: '<string>',
verified: true
})
};
fetch('https://charts.basedash.com/api/public/organizations/{orgId}/models/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://charts.basedash.com/api/public/organizations/{orgId}/models/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'referenceName' => '<string>',
'description' => '<string>',
'sqlQuery' => '<string>',
'measures' => [
[
'name' => '<string>',
'sql' => '<string>',
'description' => '<string>'
]
],
'segments' => [
[
'name' => '<string>',
'sql' => '<string>',
'description' => '<string>'
]
],
'defaultTimeColumn' => '<string>',
'verified' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://charts.basedash.com/api/public/organizations/{orgId}/models/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"referenceName\": \"<string>\",\n \"description\": \"<string>\",\n \"sqlQuery\": \"<string>\",\n \"measures\": [\n {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"segments\": [\n {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"defaultTimeColumn\": \"<string>\",\n \"verified\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://charts.basedash.com/api/public/organizations/{orgId}/models/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"referenceName\": \"<string>\",\n \"description\": \"<string>\",\n \"sqlQuery\": \"<string>\",\n \"measures\": [\n {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"segments\": [\n {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"defaultTimeColumn\": \"<string>\",\n \"verified\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://charts.basedash.com/api/public/organizations/{orgId}/models/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"referenceName\": \"<string>\",\n \"description\": \"<string>\",\n \"sqlQuery\": \"<string>\",\n \"measures\": [\n {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"segments\": [\n {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"defaultTimeColumn\": \"<string>\",\n \"verified\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"referenceName": "<string>",
"description": "<string>",
"sqlQuery": "<string>",
"organizationId": "<string>",
"databaseConnectionId": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z",
"verifiedByMemberId": "<string>",
"columns": [
{
"name": "<string>",
"type": "array",
"nullable": true,
"example": "<string>",
"description": "<string>",
"sampleValues": [
"<string>"
]
}
],
"measures": [
{
"name": "<string>",
"sql": "<string>",
"description": "<string>"
}
],
"segments": [
{
"name": "<string>",
"sql": "<string>",
"description": "<string>"
}
],
"defaultTimeColumn": "<string>",
"warnings": [
{
"code": "base_sql_contains_group_by",
"message": "<string>",
"field": "sqlQuery",
"name": "<string>"
}
]
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}{
"error": {
"title": "RateLimitExceeded",
"detail": "<string>",
"retryAfterMs": 123
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}Models
Update a model
Updates an existing model. Requires admin access to the organization.
PATCH
/
api
/
public
/
organizations
/
{orgId}
/
models
/
{id}
Update a model
curl --request PATCH \
--url https://charts.basedash.com/api/public/organizations/{orgId}/models/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"referenceName": "<string>",
"description": "<string>",
"sqlQuery": "<string>",
"measures": [
{
"name": "<string>",
"sql": "<string>",
"description": "<string>"
}
],
"segments": [
{
"name": "<string>",
"sql": "<string>",
"description": "<string>"
}
],
"defaultTimeColumn": "<string>",
"verified": true
}
'import requests
url = "https://charts.basedash.com/api/public/organizations/{orgId}/models/{id}"
payload = {
"name": "<string>",
"referenceName": "<string>",
"description": "<string>",
"sqlQuery": "<string>",
"measures": [
{
"name": "<string>",
"sql": "<string>",
"description": "<string>"
}
],
"segments": [
{
"name": "<string>",
"sql": "<string>",
"description": "<string>"
}
],
"defaultTimeColumn": "<string>",
"verified": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
referenceName: '<string>',
description: '<string>',
sqlQuery: '<string>',
measures: [{name: '<string>', sql: '<string>', description: '<string>'}],
segments: [{name: '<string>', sql: '<string>', description: '<string>'}],
defaultTimeColumn: '<string>',
verified: true
})
};
fetch('https://charts.basedash.com/api/public/organizations/{orgId}/models/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://charts.basedash.com/api/public/organizations/{orgId}/models/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'referenceName' => '<string>',
'description' => '<string>',
'sqlQuery' => '<string>',
'measures' => [
[
'name' => '<string>',
'sql' => '<string>',
'description' => '<string>'
]
],
'segments' => [
[
'name' => '<string>',
'sql' => '<string>',
'description' => '<string>'
]
],
'defaultTimeColumn' => '<string>',
'verified' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://charts.basedash.com/api/public/organizations/{orgId}/models/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"referenceName\": \"<string>\",\n \"description\": \"<string>\",\n \"sqlQuery\": \"<string>\",\n \"measures\": [\n {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"segments\": [\n {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"defaultTimeColumn\": \"<string>\",\n \"verified\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://charts.basedash.com/api/public/organizations/{orgId}/models/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"referenceName\": \"<string>\",\n \"description\": \"<string>\",\n \"sqlQuery\": \"<string>\",\n \"measures\": [\n {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"segments\": [\n {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"defaultTimeColumn\": \"<string>\",\n \"verified\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://charts.basedash.com/api/public/organizations/{orgId}/models/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"referenceName\": \"<string>\",\n \"description\": \"<string>\",\n \"sqlQuery\": \"<string>\",\n \"measures\": [\n {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"segments\": [\n {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"defaultTimeColumn\": \"<string>\",\n \"verified\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"name": "<string>",
"referenceName": "<string>",
"description": "<string>",
"sqlQuery": "<string>",
"organizationId": "<string>",
"databaseConnectionId": "<string>",
"verifiedAt": "2023-11-07T05:31:56Z",
"verifiedByMemberId": "<string>",
"columns": [
{
"name": "<string>",
"type": "array",
"nullable": true,
"example": "<string>",
"description": "<string>",
"sampleValues": [
"<string>"
]
}
],
"measures": [
{
"name": "<string>",
"sql": "<string>",
"description": "<string>"
}
],
"segments": [
{
"name": "<string>",
"sql": "<string>",
"description": "<string>"
}
],
"defaultTimeColumn": "<string>",
"warnings": [
{
"code": "base_sql_contains_group_by",
"message": "<string>",
"field": "sqlQuery",
"name": "<string>"
}
]
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}{
"error": {
"title": "RateLimitExceeded",
"detail": "<string>",
"retryAfterMs": 123
}
}{
"error": {
"title": "<string>",
"detail": "<string>"
}
}Authorizations
API key authentication using Bearer token format: Bearer <basedash_api_key>
Body
application/json
Human-readable model name
Required string length:
1 - 100Stable SQL reference name for the model
Required string length:
1 - 100Model description
Maximum string length:
10000SQL query that defines the reusable dataset
Required string length:
1 - 100000Ordered reusable aggregate expressions
Maximum array length:
50Show child attributes
Show child attributes
Ordered reusable predicate expressions
Maximum array length:
50Show child attributes
Show child attributes
Default date result column, or null for no default
Required string length:
1 - 256Whether the model is verified
Response
Model updated successfully
Show child attributes
Show child attributes
Was this page helpful?