curl --request POST \
--url https://charts.basedash.com/api/public/organizations/{orgId}/models \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"databaseConnectionId": "<string>",
"sqlQuery": "<string>",
"referenceName": "<string>",
"description": "<string>",
"measures": [
{
"name": "<string>",
"sql": "<string>",
"description": "<string>",
"synonyms": []
}
],
"segments": [
{
"name": "<string>",
"sql": "<string>",
"description": "<string>",
"synonyms": []
}
],
"defaultTimeColumn": "<string>",
"synonyms": [
"<string>"
],
"grain": "<string>",
"keyColumns": [
"<string>"
],
"relationships": [
{
"targetModelId": "<string>",
"sourceColumn": "<string>",
"targetColumn": "<string>"
}
],
"usageGuidance": "<string>",
"columnSynonyms": [
{
"name": "<string>",
"synonyms": [
"<string>"
]
}
]
}
'import requests
url = "https://charts.basedash.com/api/public/organizations/{orgId}/models"
payload = {
"name": "<string>",
"databaseConnectionId": "<string>",
"sqlQuery": "<string>",
"referenceName": "<string>",
"description": "<string>",
"measures": [
{
"name": "<string>",
"sql": "<string>",
"description": "<string>",
"synonyms": []
}
],
"segments": [
{
"name": "<string>",
"sql": "<string>",
"description": "<string>",
"synonyms": []
}
],
"defaultTimeColumn": "<string>",
"synonyms": ["<string>"],
"grain": "<string>",
"keyColumns": ["<string>"],
"relationships": [
{
"targetModelId": "<string>",
"sourceColumn": "<string>",
"targetColumn": "<string>"
}
],
"usageGuidance": "<string>",
"columnSynonyms": [
{
"name": "<string>",
"synonyms": ["<string>"]
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
databaseConnectionId: '<string>',
sqlQuery: '<string>',
referenceName: '<string>',
description: '<string>',
measures: [{name: '<string>', sql: '<string>', description: '<string>', synonyms: []}],
segments: [{name: '<string>', sql: '<string>', description: '<string>', synonyms: []}],
defaultTimeColumn: '<string>',
synonyms: ['<string>'],
grain: '<string>',
keyColumns: ['<string>'],
relationships: [
{targetModelId: '<string>', sourceColumn: '<string>', targetColumn: '<string>'}
],
usageGuidance: '<string>',
columnSynonyms: [{name: '<string>', synonyms: ['<string>']}]
})
};
fetch('https://charts.basedash.com/api/public/organizations/{orgId}/models', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'databaseConnectionId' => '<string>',
'sqlQuery' => '<string>',
'referenceName' => '<string>',
'description' => '<string>',
'measures' => [
[
'name' => '<string>',
'sql' => '<string>',
'description' => '<string>',
'synonyms' => [
]
]
],
'segments' => [
[
'name' => '<string>',
'sql' => '<string>',
'description' => '<string>',
'synonyms' => [
]
]
],
'defaultTimeColumn' => '<string>',
'synonyms' => [
'<string>'
],
'grain' => '<string>',
'keyColumns' => [
'<string>'
],
'relationships' => [
[
'targetModelId' => '<string>',
'sourceColumn' => '<string>',
'targetColumn' => '<string>'
]
],
'usageGuidance' => '<string>',
'columnSynonyms' => [
[
'name' => '<string>',
'synonyms' => [
'<string>'
]
]
]
]),
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"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"databaseConnectionId\": \"<string>\",\n \"sqlQuery\": \"<string>\",\n \"referenceName\": \"<string>\",\n \"description\": \"<string>\",\n \"measures\": [\n {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"description\": \"<string>\",\n \"synonyms\": []\n }\n ],\n \"segments\": [\n {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"description\": \"<string>\",\n \"synonyms\": []\n }\n ],\n \"defaultTimeColumn\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"grain\": \"<string>\",\n \"keyColumns\": [\n \"<string>\"\n ],\n \"relationships\": [\n {\n \"targetModelId\": \"<string>\",\n \"sourceColumn\": \"<string>\",\n \"targetColumn\": \"<string>\"\n }\n ],\n \"usageGuidance\": \"<string>\",\n \"columnSynonyms\": [\n {\n \"name\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://charts.basedash.com/api/public/organizations/{orgId}/models")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"databaseConnectionId\": \"<string>\",\n \"sqlQuery\": \"<string>\",\n \"referenceName\": \"<string>\",\n \"description\": \"<string>\",\n \"measures\": [\n {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"description\": \"<string>\",\n \"synonyms\": []\n }\n ],\n \"segments\": [\n {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"description\": \"<string>\",\n \"synonyms\": []\n }\n ],\n \"defaultTimeColumn\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"grain\": \"<string>\",\n \"keyColumns\": [\n \"<string>\"\n ],\n \"relationships\": [\n {\n \"targetModelId\": \"<string>\",\n \"sourceColumn\": \"<string>\",\n \"targetColumn\": \"<string>\"\n }\n ],\n \"usageGuidance\": \"<string>\",\n \"columnSynonyms\": [\n {\n \"name\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://charts.basedash.com/api/public/organizations/{orgId}/models")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"databaseConnectionId\": \"<string>\",\n \"sqlQuery\": \"<string>\",\n \"referenceName\": \"<string>\",\n \"description\": \"<string>\",\n \"measures\": [\n {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"description\": \"<string>\",\n \"synonyms\": []\n }\n ],\n \"segments\": [\n {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"description\": \"<string>\",\n \"synonyms\": []\n }\n ],\n \"defaultTimeColumn\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"grain\": \"<string>\",\n \"keyColumns\": [\n \"<string>\"\n ],\n \"relationships\": [\n {\n \"targetModelId\": \"<string>\",\n \"sourceColumn\": \"<string>\",\n \"targetColumn\": \"<string>\"\n }\n ],\n \"usageGuidance\": \"<string>\",\n \"columnSynonyms\": [\n {\n \"name\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ]\n }\n ]\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>",
"synonyms": [
"<string>"
],
"sampleValues": [
"<string>"
]
}
],
"measures": [
{
"name": "<string>",
"sql": "<string>",
"description": "<string>",
"synonyms": []
}
],
"segments": [
{
"name": "<string>",
"sql": "<string>",
"description": "<string>",
"synonyms": []
}
],
"defaultTimeColumn": "<string>",
"synonyms": [
"<string>"
],
"grain": "<string>",
"keyColumns": [
"<string>"
],
"relationships": [
{
"targetModelId": "<string>",
"sourceColumn": "<string>",
"targetColumn": "<string>",
"cardinality": "many_to_one"
}
],
"usageGuidance": "<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>"
}
}Create a model
Creates a new model within an organization. Requires admin access to the organization.
curl --request POST \
--url https://charts.basedash.com/api/public/organizations/{orgId}/models \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"databaseConnectionId": "<string>",
"sqlQuery": "<string>",
"referenceName": "<string>",
"description": "<string>",
"measures": [
{
"name": "<string>",
"sql": "<string>",
"description": "<string>",
"synonyms": []
}
],
"segments": [
{
"name": "<string>",
"sql": "<string>",
"description": "<string>",
"synonyms": []
}
],
"defaultTimeColumn": "<string>",
"synonyms": [
"<string>"
],
"grain": "<string>",
"keyColumns": [
"<string>"
],
"relationships": [
{
"targetModelId": "<string>",
"sourceColumn": "<string>",
"targetColumn": "<string>"
}
],
"usageGuidance": "<string>",
"columnSynonyms": [
{
"name": "<string>",
"synonyms": [
"<string>"
]
}
]
}
'import requests
url = "https://charts.basedash.com/api/public/organizations/{orgId}/models"
payload = {
"name": "<string>",
"databaseConnectionId": "<string>",
"sqlQuery": "<string>",
"referenceName": "<string>",
"description": "<string>",
"measures": [
{
"name": "<string>",
"sql": "<string>",
"description": "<string>",
"synonyms": []
}
],
"segments": [
{
"name": "<string>",
"sql": "<string>",
"description": "<string>",
"synonyms": []
}
],
"defaultTimeColumn": "<string>",
"synonyms": ["<string>"],
"grain": "<string>",
"keyColumns": ["<string>"],
"relationships": [
{
"targetModelId": "<string>",
"sourceColumn": "<string>",
"targetColumn": "<string>"
}
],
"usageGuidance": "<string>",
"columnSynonyms": [
{
"name": "<string>",
"synonyms": ["<string>"]
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
databaseConnectionId: '<string>',
sqlQuery: '<string>',
referenceName: '<string>',
description: '<string>',
measures: [{name: '<string>', sql: '<string>', description: '<string>', synonyms: []}],
segments: [{name: '<string>', sql: '<string>', description: '<string>', synonyms: []}],
defaultTimeColumn: '<string>',
synonyms: ['<string>'],
grain: '<string>',
keyColumns: ['<string>'],
relationships: [
{targetModelId: '<string>', sourceColumn: '<string>', targetColumn: '<string>'}
],
usageGuidance: '<string>',
columnSynonyms: [{name: '<string>', synonyms: ['<string>']}]
})
};
fetch('https://charts.basedash.com/api/public/organizations/{orgId}/models', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'databaseConnectionId' => '<string>',
'sqlQuery' => '<string>',
'referenceName' => '<string>',
'description' => '<string>',
'measures' => [
[
'name' => '<string>',
'sql' => '<string>',
'description' => '<string>',
'synonyms' => [
]
]
],
'segments' => [
[
'name' => '<string>',
'sql' => '<string>',
'description' => '<string>',
'synonyms' => [
]
]
],
'defaultTimeColumn' => '<string>',
'synonyms' => [
'<string>'
],
'grain' => '<string>',
'keyColumns' => [
'<string>'
],
'relationships' => [
[
'targetModelId' => '<string>',
'sourceColumn' => '<string>',
'targetColumn' => '<string>'
]
],
'usageGuidance' => '<string>',
'columnSynonyms' => [
[
'name' => '<string>',
'synonyms' => [
'<string>'
]
]
]
]),
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"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"databaseConnectionId\": \"<string>\",\n \"sqlQuery\": \"<string>\",\n \"referenceName\": \"<string>\",\n \"description\": \"<string>\",\n \"measures\": [\n {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"description\": \"<string>\",\n \"synonyms\": []\n }\n ],\n \"segments\": [\n {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"description\": \"<string>\",\n \"synonyms\": []\n }\n ],\n \"defaultTimeColumn\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"grain\": \"<string>\",\n \"keyColumns\": [\n \"<string>\"\n ],\n \"relationships\": [\n {\n \"targetModelId\": \"<string>\",\n \"sourceColumn\": \"<string>\",\n \"targetColumn\": \"<string>\"\n }\n ],\n \"usageGuidance\": \"<string>\",\n \"columnSynonyms\": [\n {\n \"name\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ]\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://charts.basedash.com/api/public/organizations/{orgId}/models")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"databaseConnectionId\": \"<string>\",\n \"sqlQuery\": \"<string>\",\n \"referenceName\": \"<string>\",\n \"description\": \"<string>\",\n \"measures\": [\n {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"description\": \"<string>\",\n \"synonyms\": []\n }\n ],\n \"segments\": [\n {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"description\": \"<string>\",\n \"synonyms\": []\n }\n ],\n \"defaultTimeColumn\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"grain\": \"<string>\",\n \"keyColumns\": [\n \"<string>\"\n ],\n \"relationships\": [\n {\n \"targetModelId\": \"<string>\",\n \"sourceColumn\": \"<string>\",\n \"targetColumn\": \"<string>\"\n }\n ],\n \"usageGuidance\": \"<string>\",\n \"columnSynonyms\": [\n {\n \"name\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ]\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://charts.basedash.com/api/public/organizations/{orgId}/models")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"databaseConnectionId\": \"<string>\",\n \"sqlQuery\": \"<string>\",\n \"referenceName\": \"<string>\",\n \"description\": \"<string>\",\n \"measures\": [\n {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"description\": \"<string>\",\n \"synonyms\": []\n }\n ],\n \"segments\": [\n {\n \"name\": \"<string>\",\n \"sql\": \"<string>\",\n \"description\": \"<string>\",\n \"synonyms\": []\n }\n ],\n \"defaultTimeColumn\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ],\n \"grain\": \"<string>\",\n \"keyColumns\": [\n \"<string>\"\n ],\n \"relationships\": [\n {\n \"targetModelId\": \"<string>\",\n \"sourceColumn\": \"<string>\",\n \"targetColumn\": \"<string>\"\n }\n ],\n \"usageGuidance\": \"<string>\",\n \"columnSynonyms\": [\n {\n \"name\": \"<string>\",\n \"synonyms\": [\n \"<string>\"\n ]\n }\n ]\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>",
"synonyms": [
"<string>"
],
"sampleValues": [
"<string>"
]
}
],
"measures": [
{
"name": "<string>",
"sql": "<string>",
"description": "<string>",
"synonyms": []
}
],
"segments": [
{
"name": "<string>",
"sql": "<string>",
"description": "<string>",
"synonyms": []
}
],
"defaultTimeColumn": "<string>",
"synonyms": [
"<string>"
],
"grain": "<string>",
"keyColumns": [
"<string>"
],
"relationships": [
{
"targetModelId": "<string>",
"sourceColumn": "<string>",
"targetColumn": "<string>",
"cardinality": "many_to_one"
}
],
"usageGuidance": "<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>
Path Parameters
Organization ID
Body
Human-readable model name
1 - 100Data source ID
SQL query that defines the reusable dataset
1 - 100000Stable SQL reference name for the model
1 - 100Model description
10000Ordered reusable aggregate expressions
50Show child attributes
Show child attributes
Ordered reusable predicate expressions
50Show child attributes
Show child attributes
Default date result column, or null for no default
1 - 256Alternative names for the model
201 - 100What one row in the model represents
10000Columns that uniquely identify a row
101 - 256Relationships from this model to other models
50Show child attributes
Show child attributes
Guidance about when and how to use the model
10000Alternative names for model result columns
Show child attributes
Show child attributes
Response
Model created successfully
Show child attributes
Show child attributes
Was this page helpful?