Sites
Get scan configuration
The Site’s scan setup: business profile, personas, products, journey stages, the AI models it scans (with on/off), regions, schedule, and prompt/competitor counts. List the prompts and competitors themselves via the prompts and competitors endpoints.
GET
/
v1
/
sites
/
{siteId}
/
scan-config
Get scan configuration
curl --request GET \
--url https://api.onsomble.ai/v1/sites/{siteId}/scan-config \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.onsomble.ai/v1/sites/{siteId}/scan-config"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.onsomble.ai/v1/sites/{siteId}/scan-config', 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.onsomble.ai/v1/sites/{siteId}/scan-config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.onsomble.ai/v1/sites/{siteId}/scan-config"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.onsomble.ai/v1/sites/{siteId}/scan-config")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.onsomble.ai/v1/sites/{siteId}/scan-config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"businessProfile": {
"businessName": "<string>",
"industry": "<string>",
"market": "<string>",
"description": "<string>",
"domain": "<string>",
"products": [
"<string>"
],
"operatingRegions": [
"<string>"
],
"aliases": [
"<string>"
],
"aliasBuckets": {
"safeExactAliases": [
"<string>"
],
"domainAliases": [
"<string>"
],
"ambiguousAliases": [
"<string>"
]
}
},
"personas": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"aliases": [
"<string>"
]
}
],
"products": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>"
}
],
"journeyStages": [
{
"id": "<string>",
"name": "<string>"
}
],
"models": [
{
"id": "chatgpt_app",
"name": "<string>",
"selected": true
}
],
"regions": [
"<string>"
],
"schedule": {
"frequency": "weekly",
"enabled": true,
"nextRunAt": "<string>"
},
"prompts": {
"total": 18
},
"competitors": {
"total": 18
}
}Authorizations
An API key created in Settings → Account → API Keys.
Path Parameters
Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Scan-strategy products (distinct from the profile products).
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Every selectable AI model, with whether the Site scans it.
Show child attributes
Show child attributes
Region codes the Site scans.
Show child attributes
Show child attributes
Prompt count; list them via GET …/prompts.
Show child attributes
Show child attributes
Tracked competitor count; list them via GET …/competitors.
Show child attributes
Show child attributes
⌘I
Get scan configuration
curl --request GET \
--url https://api.onsomble.ai/v1/sites/{siteId}/scan-config \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.onsomble.ai/v1/sites/{siteId}/scan-config"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.onsomble.ai/v1/sites/{siteId}/scan-config', 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.onsomble.ai/v1/sites/{siteId}/scan-config",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.onsomble.ai/v1/sites/{siteId}/scan-config"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.onsomble.ai/v1/sites/{siteId}/scan-config")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.onsomble.ai/v1/sites/{siteId}/scan-config")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"businessProfile": {
"businessName": "<string>",
"industry": "<string>",
"market": "<string>",
"description": "<string>",
"domain": "<string>",
"products": [
"<string>"
],
"operatingRegions": [
"<string>"
],
"aliases": [
"<string>"
],
"aliasBuckets": {
"safeExactAliases": [
"<string>"
],
"domainAliases": [
"<string>"
],
"ambiguousAliases": [
"<string>"
]
}
},
"personas": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"aliases": [
"<string>"
]
}
],
"products": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>"
}
],
"journeyStages": [
{
"id": "<string>",
"name": "<string>"
}
],
"models": [
{
"id": "chatgpt_app",
"name": "<string>",
"selected": true
}
],
"regions": [
"<string>"
],
"schedule": {
"frequency": "weekly",
"enabled": true,
"nextRunAt": "<string>"
},
"prompts": {
"total": 18
},
"competitors": {
"total": 18
}
}