Create a single dimension
POST
/
v1
/
dimensions
cURL
curl -X POST 'https://api.growthbook.io/api/v1/dimensions' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"name":"User Country","datasourceId":"ds_123abc","identifierType":"user","query":"SELECT country FROM users"}'import requests
url = "https://api.growthbook.io/api/v1/dimensions"
payload = {
"name": "<string>",
"datasourceId": "<string>",
"identifierType": "<string>",
"query": "<string>",
"description": "<string>",
"owner": "<string>",
"nullLabel": "<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>',
datasourceId: '<string>',
identifierType: '<string>',
query: '<string>',
description: '<string>',
owner: '<string>',
nullLabel: '<string>'
})
};
fetch('https://api.growthbook.io/api/v1/dimensions', 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://api.growthbook.io/api/v1/dimensions",
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>',
'datasourceId' => '<string>',
'identifierType' => '<string>',
'query' => '<string>',
'description' => '<string>',
'owner' => '<string>',
'nullLabel' => '<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://api.growthbook.io/api/v1/dimensions"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"datasourceId\": \"<string>\",\n \"identifierType\": \"<string>\",\n \"query\": \"<string>\",\n \"description\": \"<string>\",\n \"owner\": \"<string>\",\n \"nullLabel\": \"<string>\"\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://api.growthbook.io/api/v1/dimensions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"datasourceId\": \"<string>\",\n \"identifierType\": \"<string>\",\n \"query\": \"<string>\",\n \"description\": \"<string>\",\n \"owner\": \"<string>\",\n \"nullLabel\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/dimensions")
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 \"datasourceId\": \"<string>\",\n \"identifierType\": \"<string>\",\n \"query\": \"<string>\",\n \"description\": \"<string>\",\n \"owner\": \"<string>\",\n \"nullLabel\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"dimension": {
"id": "<string>",
"dateCreated": "<string>",
"dateUpdated": "<string>",
"owner": "<string>",
"datasourceId": "<string>",
"identifierType": "<string>",
"name": "<string>",
"query": "<string>",
"ownerEmail": "<string>",
"description": "<string>",
"timing": "none",
"nullLabel": "<string>",
"managedBy": ""
}
}{
"confirmation": {
"id": "<string>",
"status": "pending",
"actions": [
{
"action": "feature.create",
"environments": [
"<string>"
]
}
],
"summary": "<string>",
"url": "<string>",
"expiresAt": "<string>",
"response": {
"status": 123,
"body": "<unknown>"
},
"note": "<string>"
},
"message": "<string>"
}Authorizations
bearerAuthbasicAuth
Pass your API key as the Bearer token. See Authentication.
Body
application/json
What the query returns and how the value at a unit's first exposure is resolved. none (default): one value per unit, resolved with MAX(value). rowTimestamp: timestamped rows; the query also returns a timestamp column and the latest row at or before first exposure is used. validityRange: validity ranges; the query also returns start_timestamp and end_timestamp (NULL = still valid) columns and the row valid at first exposure is used. Only supported for SQL Data Sources.
Available options:
none, rowTimestamp, validityRange Was this page helpful?
⌘I
cURL
curl -X POST 'https://api.growthbook.io/api/v1/dimensions' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{"name":"User Country","datasourceId":"ds_123abc","identifierType":"user","query":"SELECT country FROM users"}'import requests
url = "https://api.growthbook.io/api/v1/dimensions"
payload = {
"name": "<string>",
"datasourceId": "<string>",
"identifierType": "<string>",
"query": "<string>",
"description": "<string>",
"owner": "<string>",
"nullLabel": "<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>',
datasourceId: '<string>',
identifierType: '<string>',
query: '<string>',
description: '<string>',
owner: '<string>',
nullLabel: '<string>'
})
};
fetch('https://api.growthbook.io/api/v1/dimensions', 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://api.growthbook.io/api/v1/dimensions",
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>',
'datasourceId' => '<string>',
'identifierType' => '<string>',
'query' => '<string>',
'description' => '<string>',
'owner' => '<string>',
'nullLabel' => '<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://api.growthbook.io/api/v1/dimensions"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"datasourceId\": \"<string>\",\n \"identifierType\": \"<string>\",\n \"query\": \"<string>\",\n \"description\": \"<string>\",\n \"owner\": \"<string>\",\n \"nullLabel\": \"<string>\"\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://api.growthbook.io/api/v1/dimensions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"datasourceId\": \"<string>\",\n \"identifierType\": \"<string>\",\n \"query\": \"<string>\",\n \"description\": \"<string>\",\n \"owner\": \"<string>\",\n \"nullLabel\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/dimensions")
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 \"datasourceId\": \"<string>\",\n \"identifierType\": \"<string>\",\n \"query\": \"<string>\",\n \"description\": \"<string>\",\n \"owner\": \"<string>\",\n \"nullLabel\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"dimension": {
"id": "<string>",
"dateCreated": "<string>",
"dateUpdated": "<string>",
"owner": "<string>",
"datasourceId": "<string>",
"identifierType": "<string>",
"name": "<string>",
"query": "<string>",
"ownerEmail": "<string>",
"description": "<string>",
"timing": "none",
"nullLabel": "<string>",
"managedBy": ""
}
}{
"confirmation": {
"id": "<string>",
"status": "pending",
"actions": [
{
"action": "feature.create",
"environments": [
"<string>"
]
}
],
"summary": "<string>",
"url": "<string>",
"expiresAt": "<string>",
"response": {
"status": 123,
"body": "<unknown>"
},
"note": "<string>"
},
"message": "<string>"
}
