Create a single population
POST
/
v1
/
populations
cURL
curl -X POST 'https://api.growthbook.io/api/v1/populations' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v1/populations"
payload = {
"name": "<string>",
"datasource": "<string>",
"userIdTypes": ["<string>"],
"steps": [
{
"source": {
"type": "factTable",
"factTableId": "<string>"
},
"rowFilters": [
{
"column": "<string>",
"values": ["<string>"]
}
],
"aggregateFilter": "<string>",
"aggregateFilterColumn": "<string>"
}
],
"description": "<string>",
"owner": "<string>",
"projects": ["<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>',
datasource: '<string>',
userIdTypes: ['<string>'],
steps: [
{
source: {type: 'factTable', factTableId: '<string>'},
rowFilters: [{column: '<string>', values: ['<string>']}],
aggregateFilter: '<string>',
aggregateFilterColumn: '<string>'
}
],
description: '<string>',
owner: '<string>',
projects: ['<string>']
})
};
fetch('https://api.growthbook.io/api/v1/populations', 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/populations",
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>',
'datasource' => '<string>',
'userIdTypes' => [
'<string>'
],
'steps' => [
[
'source' => [
'type' => 'factTable',
'factTableId' => '<string>'
],
'rowFilters' => [
[
'column' => '<string>',
'values' => [
'<string>'
]
]
],
'aggregateFilter' => '<string>',
'aggregateFilterColumn' => '<string>'
]
],
'description' => '<string>',
'owner' => '<string>',
'projects' => [
'<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/populations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"datasource\": \"<string>\",\n \"userIdTypes\": [\n \"<string>\"\n ],\n \"steps\": [\n {\n \"source\": {\n \"type\": \"factTable\",\n \"factTableId\": \"<string>\"\n },\n \"rowFilters\": [\n {\n \"column\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"aggregateFilter\": \"<string>\",\n \"aggregateFilterColumn\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"owner\": \"<string>\",\n \"projects\": [\n \"<string>\"\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://api.growthbook.io/api/v1/populations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"datasource\": \"<string>\",\n \"userIdTypes\": [\n \"<string>\"\n ],\n \"steps\": [\n {\n \"source\": {\n \"type\": \"factTable\",\n \"factTableId\": \"<string>\"\n },\n \"rowFilters\": [\n {\n \"column\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"aggregateFilter\": \"<string>\",\n \"aggregateFilterColumn\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"owner\": \"<string>\",\n \"projects\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/populations")
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 \"datasource\": \"<string>\",\n \"userIdTypes\": [\n \"<string>\"\n ],\n \"steps\": [\n {\n \"source\": {\n \"type\": \"factTable\",\n \"factTableId\": \"<string>\"\n },\n \"rowFilters\": [\n {\n \"column\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"aggregateFilter\": \"<string>\",\n \"aggregateFilterColumn\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"owner\": \"<string>\",\n \"projects\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"population": {
"id": "<string>",
"dateCreated": "2023-11-07T05:31:56Z",
"dateUpdated": "2023-11-07T05:31:56Z",
"projects": [
"<string>"
],
"owner": "<string>",
"name": "<string>",
"description": "<string>",
"datasource": "<string>",
"userIdTypes": [
"<string>"
],
"steps": [
{
"source": {
"type": "factTable",
"factTableId": "<string>"
},
"rowFilters": [
{
"operator": "=",
"column": "<string>",
"values": [
"<string>"
]
}
],
"windowSettings": {
"type": "conversion",
"delayValue": 123,
"delayUnit": "weeks",
"windowValue": 123,
"windowUnit": "weeks"
},
"aggregateFilter": "<string>",
"aggregateFilterColumn": "<string>"
}
],
"ownerEmail": "<string>"
}
}{
"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
If using Bearer auth, pass the Secret Key as the token:
curl https://api.growthbook.io/api/v1/features -H "Authorization: Bearer secret_abc123DEF456"
Body
application/json
Create a Population
Minimum string length:
1Id of the Data Source
Identifier types the Population can be joined on. Every step's fact table must support all of them
Minimum array length:
1Steps a unit must complete, in order, to be included. Currently limited to 1 step with support for multiple steps coming soon.
Required array length:
1 elementShow child attributes
Show child attributes
The userId or email address of the owner. If an email address is provided, it will be used to look up the userId of the matching organization member. If an ID is provided, it will be validated as existing in the organization. When omitted, it defaults to the requesting member: a personal access token's owner, or the member an organization API key assumes. An organization API key acting as itself must send it, or the request fails with a 400.
Response
Resource created
Show child attributes
Show child attributes
Was this page helpful?
⌘I
cURL
curl -X POST 'https://api.growthbook.io/api/v1/populations' \
-H 'Authorization: Bearer YOUR_API_KEY'import requests
url = "https://api.growthbook.io/api/v1/populations"
payload = {
"name": "<string>",
"datasource": "<string>",
"userIdTypes": ["<string>"],
"steps": [
{
"source": {
"type": "factTable",
"factTableId": "<string>"
},
"rowFilters": [
{
"column": "<string>",
"values": ["<string>"]
}
],
"aggregateFilter": "<string>",
"aggregateFilterColumn": "<string>"
}
],
"description": "<string>",
"owner": "<string>",
"projects": ["<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>',
datasource: '<string>',
userIdTypes: ['<string>'],
steps: [
{
source: {type: 'factTable', factTableId: '<string>'},
rowFilters: [{column: '<string>', values: ['<string>']}],
aggregateFilter: '<string>',
aggregateFilterColumn: '<string>'
}
],
description: '<string>',
owner: '<string>',
projects: ['<string>']
})
};
fetch('https://api.growthbook.io/api/v1/populations', 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/populations",
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>',
'datasource' => '<string>',
'userIdTypes' => [
'<string>'
],
'steps' => [
[
'source' => [
'type' => 'factTable',
'factTableId' => '<string>'
],
'rowFilters' => [
[
'column' => '<string>',
'values' => [
'<string>'
]
]
],
'aggregateFilter' => '<string>',
'aggregateFilterColumn' => '<string>'
]
],
'description' => '<string>',
'owner' => '<string>',
'projects' => [
'<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/populations"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"datasource\": \"<string>\",\n \"userIdTypes\": [\n \"<string>\"\n ],\n \"steps\": [\n {\n \"source\": {\n \"type\": \"factTable\",\n \"factTableId\": \"<string>\"\n },\n \"rowFilters\": [\n {\n \"column\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"aggregateFilter\": \"<string>\",\n \"aggregateFilterColumn\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"owner\": \"<string>\",\n \"projects\": [\n \"<string>\"\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://api.growthbook.io/api/v1/populations")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"datasource\": \"<string>\",\n \"userIdTypes\": [\n \"<string>\"\n ],\n \"steps\": [\n {\n \"source\": {\n \"type\": \"factTable\",\n \"factTableId\": \"<string>\"\n },\n \"rowFilters\": [\n {\n \"column\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"aggregateFilter\": \"<string>\",\n \"aggregateFilterColumn\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"owner\": \"<string>\",\n \"projects\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.growthbook.io/api/v1/populations")
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 \"datasource\": \"<string>\",\n \"userIdTypes\": [\n \"<string>\"\n ],\n \"steps\": [\n {\n \"source\": {\n \"type\": \"factTable\",\n \"factTableId\": \"<string>\"\n },\n \"rowFilters\": [\n {\n \"column\": \"<string>\",\n \"values\": [\n \"<string>\"\n ]\n }\n ],\n \"aggregateFilter\": \"<string>\",\n \"aggregateFilterColumn\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"owner\": \"<string>\",\n \"projects\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"population": {
"id": "<string>",
"dateCreated": "2023-11-07T05:31:56Z",
"dateUpdated": "2023-11-07T05:31:56Z",
"projects": [
"<string>"
],
"owner": "<string>",
"name": "<string>",
"description": "<string>",
"datasource": "<string>",
"userIdTypes": [
"<string>"
],
"steps": [
{
"source": {
"type": "factTable",
"factTableId": "<string>"
},
"rowFilters": [
{
"operator": "=",
"column": "<string>",
"values": [
"<string>"
]
}
],
"windowSettings": {
"type": "conversion",
"delayValue": 123,
"delayUnit": "weeks",
"windowValue": 123,
"windowUnit": "weeks"
},
"aggregateFilter": "<string>",
"aggregateFilterColumn": "<string>"
}
],
"ownerEmail": "<string>"
}
}{
"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>"
}