Create a workspace
curl --request POST \
--url https://api.example.com/api/v1/workspaces \
--header 'Content-Type: application/json' \
--cookie geo.session= \
--data '
{
"brand": "<string>",
"displayName": "<string>",
"domains": [
"<string>"
],
"languages": [],
"regions": [
"<string>"
],
"competitors": [
{
"name": "<string>",
"domains": [
"<unknown>"
],
"aliases": [
"<string>"
],
"ambiguous": true
}
],
"gscProperty": "<string>",
"ga4Property": "<string>",
"activeSetSize": 160,
"quotas": {
"discovery": 0.5,
"problem_solution": "<unknown>",
"use_case": "<unknown>",
"comparison": "<unknown>",
"expert": "<unknown>",
"brand_research": "<unknown>"
}
}
'import requests
url = "https://api.example.com/api/v1/workspaces"
payload = {
"brand": "<string>",
"displayName": "<string>",
"domains": ["<string>"],
"languages": [],
"regions": ["<string>"],
"competitors": [
{
"name": "<string>",
"domains": ["<unknown>"],
"aliases": ["<string>"],
"ambiguous": True
}
],
"gscProperty": "<string>",
"ga4Property": "<string>",
"activeSetSize": 160,
"quotas": {
"discovery": 0.5,
"problem_solution": "<unknown>",
"use_case": "<unknown>",
"comparison": "<unknown>",
"expert": "<unknown>",
"brand_research": "<unknown>"
}
}
headers = {
"cookie": "geo.session=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {cookie: 'geo.session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
brand: '<string>',
displayName: '<string>',
domains: ['<string>'],
languages: [],
regions: ['<string>'],
competitors: [
{
name: '<string>',
domains: ['<unknown>'],
aliases: ['<string>'],
ambiguous: true
}
],
gscProperty: '<string>',
ga4Property: '<string>',
activeSetSize: 160,
quotas: {
discovery: 0.5,
problem_solution: '<unknown>',
use_case: '<unknown>',
comparison: '<unknown>',
expert: '<unknown>',
brand_research: '<unknown>'
}
})
};
fetch('https://api.example.com/api/v1/workspaces', 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.example.com/api/v1/workspaces",
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([
'brand' => '<string>',
'displayName' => '<string>',
'domains' => [
'<string>'
],
'languages' => [
],
'regions' => [
'<string>'
],
'competitors' => [
[
'name' => '<string>',
'domains' => [
'<unknown>'
],
'aliases' => [
'<string>'
],
'ambiguous' => true
]
],
'gscProperty' => '<string>',
'ga4Property' => '<string>',
'activeSetSize' => 160,
'quotas' => [
'discovery' => 0.5,
'problem_solution' => '<unknown>',
'use_case' => '<unknown>',
'comparison' => '<unknown>',
'expert' => '<unknown>',
'brand_research' => '<unknown>'
]
]),
CURLOPT_COOKIE => "geo.session=",
CURLOPT_HTTPHEADER => [
"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.example.com/api/v1/workspaces"
payload := strings.NewReader("{\n \"brand\": \"<string>\",\n \"displayName\": \"<string>\",\n \"domains\": [\n \"<string>\"\n ],\n \"languages\": [],\n \"regions\": [\n \"<string>\"\n ],\n \"competitors\": [\n {\n \"name\": \"<string>\",\n \"domains\": [\n \"<unknown>\"\n ],\n \"aliases\": [\n \"<string>\"\n ],\n \"ambiguous\": true\n }\n ],\n \"gscProperty\": \"<string>\",\n \"ga4Property\": \"<string>\",\n \"activeSetSize\": 160,\n \"quotas\": {\n \"discovery\": 0.5,\n \"problem_solution\": \"<unknown>\",\n \"use_case\": \"<unknown>\",\n \"comparison\": \"<unknown>\",\n \"expert\": \"<unknown>\",\n \"brand_research\": \"<unknown>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "geo.session=")
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.example.com/api/v1/workspaces")
.header("cookie", "geo.session=")
.header("Content-Type", "application/json")
.body("{\n \"brand\": \"<string>\",\n \"displayName\": \"<string>\",\n \"domains\": [\n \"<string>\"\n ],\n \"languages\": [],\n \"regions\": [\n \"<string>\"\n ],\n \"competitors\": [\n {\n \"name\": \"<string>\",\n \"domains\": [\n \"<unknown>\"\n ],\n \"aliases\": [\n \"<string>\"\n ],\n \"ambiguous\": true\n }\n ],\n \"gscProperty\": \"<string>\",\n \"ga4Property\": \"<string>\",\n \"activeSetSize\": 160,\n \"quotas\": {\n \"discovery\": 0.5,\n \"problem_solution\": \"<unknown>\",\n \"use_case\": \"<unknown>\",\n \"comparison\": \"<unknown>\",\n \"expert\": \"<unknown>\",\n \"brand_research\": \"<unknown>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/workspaces")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cookie"] = 'geo.session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"brand\": \"<string>\",\n \"displayName\": \"<string>\",\n \"domains\": [\n \"<string>\"\n ],\n \"languages\": [],\n \"regions\": [\n \"<string>\"\n ],\n \"competitors\": [\n {\n \"name\": \"<string>\",\n \"domains\": [\n \"<unknown>\"\n ],\n \"aliases\": [\n \"<string>\"\n ],\n \"ambiguous\": true\n }\n ],\n \"gscProperty\": \"<string>\",\n \"ga4Property\": \"<string>\",\n \"activeSetSize\": 160,\n \"quotas\": {\n \"discovery\": 0.5,\n \"problem_solution\": \"<unknown>\",\n \"use_case\": \"<unknown>\",\n \"comparison\": \"<unknown>\",\n \"expert\": \"<unknown>\",\n \"brand_research\": \"<unknown>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"slug": "<string>",
"emailProvisioning": {
"workspace": "<string>",
"email": "jsmith@example.com",
"inboxId": "<string>",
"attempts": 1,
"message": "<string>"
}
}API Reference
Create a workspace
POST
/
api
/
v1
/
workspaces
Create a workspace
curl --request POST \
--url https://api.example.com/api/v1/workspaces \
--header 'Content-Type: application/json' \
--cookie geo.session= \
--data '
{
"brand": "<string>",
"displayName": "<string>",
"domains": [
"<string>"
],
"languages": [],
"regions": [
"<string>"
],
"competitors": [
{
"name": "<string>",
"domains": [
"<unknown>"
],
"aliases": [
"<string>"
],
"ambiguous": true
}
],
"gscProperty": "<string>",
"ga4Property": "<string>",
"activeSetSize": 160,
"quotas": {
"discovery": 0.5,
"problem_solution": "<unknown>",
"use_case": "<unknown>",
"comparison": "<unknown>",
"expert": "<unknown>",
"brand_research": "<unknown>"
}
}
'import requests
url = "https://api.example.com/api/v1/workspaces"
payload = {
"brand": "<string>",
"displayName": "<string>",
"domains": ["<string>"],
"languages": [],
"regions": ["<string>"],
"competitors": [
{
"name": "<string>",
"domains": ["<unknown>"],
"aliases": ["<string>"],
"ambiguous": True
}
],
"gscProperty": "<string>",
"ga4Property": "<string>",
"activeSetSize": 160,
"quotas": {
"discovery": 0.5,
"problem_solution": "<unknown>",
"use_case": "<unknown>",
"comparison": "<unknown>",
"expert": "<unknown>",
"brand_research": "<unknown>"
}
}
headers = {
"cookie": "geo.session=",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {cookie: 'geo.session=', 'Content-Type': 'application/json'},
body: JSON.stringify({
brand: '<string>',
displayName: '<string>',
domains: ['<string>'],
languages: [],
regions: ['<string>'],
competitors: [
{
name: '<string>',
domains: ['<unknown>'],
aliases: ['<string>'],
ambiguous: true
}
],
gscProperty: '<string>',
ga4Property: '<string>',
activeSetSize: 160,
quotas: {
discovery: 0.5,
problem_solution: '<unknown>',
use_case: '<unknown>',
comparison: '<unknown>',
expert: '<unknown>',
brand_research: '<unknown>'
}
})
};
fetch('https://api.example.com/api/v1/workspaces', 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.example.com/api/v1/workspaces",
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([
'brand' => '<string>',
'displayName' => '<string>',
'domains' => [
'<string>'
],
'languages' => [
],
'regions' => [
'<string>'
],
'competitors' => [
[
'name' => '<string>',
'domains' => [
'<unknown>'
],
'aliases' => [
'<string>'
],
'ambiguous' => true
]
],
'gscProperty' => '<string>',
'ga4Property' => '<string>',
'activeSetSize' => 160,
'quotas' => [
'discovery' => 0.5,
'problem_solution' => '<unknown>',
'use_case' => '<unknown>',
'comparison' => '<unknown>',
'expert' => '<unknown>',
'brand_research' => '<unknown>'
]
]),
CURLOPT_COOKIE => "geo.session=",
CURLOPT_HTTPHEADER => [
"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.example.com/api/v1/workspaces"
payload := strings.NewReader("{\n \"brand\": \"<string>\",\n \"displayName\": \"<string>\",\n \"domains\": [\n \"<string>\"\n ],\n \"languages\": [],\n \"regions\": [\n \"<string>\"\n ],\n \"competitors\": [\n {\n \"name\": \"<string>\",\n \"domains\": [\n \"<unknown>\"\n ],\n \"aliases\": [\n \"<string>\"\n ],\n \"ambiguous\": true\n }\n ],\n \"gscProperty\": \"<string>\",\n \"ga4Property\": \"<string>\",\n \"activeSetSize\": 160,\n \"quotas\": {\n \"discovery\": 0.5,\n \"problem_solution\": \"<unknown>\",\n \"use_case\": \"<unknown>\",\n \"comparison\": \"<unknown>\",\n \"expert\": \"<unknown>\",\n \"brand_research\": \"<unknown>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("cookie", "geo.session=")
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.example.com/api/v1/workspaces")
.header("cookie", "geo.session=")
.header("Content-Type", "application/json")
.body("{\n \"brand\": \"<string>\",\n \"displayName\": \"<string>\",\n \"domains\": [\n \"<string>\"\n ],\n \"languages\": [],\n \"regions\": [\n \"<string>\"\n ],\n \"competitors\": [\n {\n \"name\": \"<string>\",\n \"domains\": [\n \"<unknown>\"\n ],\n \"aliases\": [\n \"<string>\"\n ],\n \"ambiguous\": true\n }\n ],\n \"gscProperty\": \"<string>\",\n \"ga4Property\": \"<string>\",\n \"activeSetSize\": 160,\n \"quotas\": {\n \"discovery\": 0.5,\n \"problem_solution\": \"<unknown>\",\n \"use_case\": \"<unknown>\",\n \"comparison\": \"<unknown>\",\n \"expert\": \"<unknown>\",\n \"brand_research\": \"<unknown>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/workspaces")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["cookie"] = 'geo.session='
request["Content-Type"] = 'application/json'
request.body = "{\n \"brand\": \"<string>\",\n \"displayName\": \"<string>\",\n \"domains\": [\n \"<string>\"\n ],\n \"languages\": [],\n \"regions\": [\n \"<string>\"\n ],\n \"competitors\": [\n {\n \"name\": \"<string>\",\n \"domains\": [\n \"<unknown>\"\n ],\n \"aliases\": [\n \"<string>\"\n ],\n \"ambiguous\": true\n }\n ],\n \"gscProperty\": \"<string>\",\n \"ga4Property\": \"<string>\",\n \"activeSetSize\": 160,\n \"quotas\": {\n \"discovery\": 0.5,\n \"problem_solution\": \"<unknown>\",\n \"use_case\": \"<unknown>\",\n \"comparison\": \"<unknown>\",\n \"expert\": \"<unknown>\",\n \"brand_research\": \"<unknown>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"slug": "<string>",
"emailProvisioning": {
"workspace": "<string>",
"email": "jsmith@example.com",
"inboxId": "<string>",
"attempts": 1,
"message": "<string>"
}
}Authorizations
Signed HttpOnly browser session cookie
Body
application/json
Pattern:
^[a-z0-9-]{2,20}$Required string length:
2 - 60Required array length:
1 - 8 elementsPattern:
^([a-z0-9]([a-z0-9-]*[a-z0-9])?\.)+[a-z]{2,}$Minimum array length:
1Available options:
en, es, ca, fr Maximum array length:
8Pattern:
^[a-z-]{2,20}$Required array length:
2 - 12 elementsShow child attributes
Show child attributes
Pattern:
^sc-domain:([a-z0-9-]+\.)+[a-z]{2,}$Pattern:
^\d{6,12}$Required range:
20 <= x <= 300Available options:
none, eu_medical Show child attributes
Show child attributes
⌘I