Add a website to audit (any site, e.g. a docs or regional site) without making it a brand domain
curl --request POST \
--url https://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit/domains \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"domain": "docs.acme.com"
}
'import requests
url = "https://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit/domains"
payload = { "domain": "docs.acme.com" }
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({domain: 'docs.acme.com'})
};
fetch('https://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit/domains', 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://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit/domains",
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([
'domain' => 'docs.acme.com'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit/domains"
payload := strings.NewReader("{\n \"domain\": \"docs.acme.com\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit/domains")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"domain\": \"docs.acme.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit/domains")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"domain\": \"docs.acme.com\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"source": "brand",
"removable": true,
"status": "not_started",
"outcome": "completed",
"ran_at": "2023-11-07T05:31:56Z",
"checks_total": 123,
"checks_passing": 123,
"missing_count": 123,
"to_fix_count": 123,
"running": true
}
}{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"source": "brand",
"removable": true,
"status": "not_started",
"outcome": "completed",
"ran_at": "2023-11-07T05:31:56Z",
"checks_total": 123,
"checks_passing": 123,
"missing_count": 123,
"to_fix_count": 123,
"running": true
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}Technical audit
Add a website to audit (any site, e.g. a docs or regional site) without making it a brand domain
For a docs site, a regional site… Audit-only domains don’t change citation attribution. Idempotent: a domain the brand already has (own or audit-only) returns that row with 200. Up to 10 audit-only domains per brand.
POST
/
api
/
v2
/
brands
/
{brand_id}
/
technical_audit
/
domains
Add a website to audit (any site, e.g. a docs or regional site) without making it a brand domain
curl --request POST \
--url https://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit/domains \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"domain": "docs.acme.com"
}
'import requests
url = "https://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit/domains"
payload = { "domain": "docs.acme.com" }
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({domain: 'docs.acme.com'})
};
fetch('https://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit/domains', 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://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit/domains",
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([
'domain' => 'docs.acme.com'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$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://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit/domains"
payload := strings.NewReader("{\n \"domain\": \"docs.acme.com\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
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://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit/domains")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"domain\": \"docs.acme.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit/domains")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"domain\": \"docs.acme.com\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"source": "brand",
"removable": true,
"status": "not_started",
"outcome": "completed",
"ran_at": "2023-11-07T05:31:56Z",
"checks_total": 123,
"checks_passing": 123,
"missing_count": 123,
"to_fix_count": 123,
"running": true
}
}{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"source": "brand",
"removable": true,
"status": "not_started",
"outcome": "completed",
"ran_at": "2023-11-07T05:31:56Z",
"checks_total": 123,
"checks_passing": 123,
"missing_count": 123,
"to_fix_count": 123,
"running": true
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}Authorizations
Path Parameters
Body
application/json
A host or a URL; stored as the bare lowercase host (scheme, path and port dropped, subdomains kept). IP addresses, localhost, single-label hosts, private-network names (.local, .internal, .localhost…) and hosts that resolve to a private address are rejected.
Example:
"docs.acme.com"
Response
already one of the brand's domains; that row
Show child attributes
Show child attributes

