Technical audit summary for one domain: counts, the top problems to fix, and any run in progress
curl --request GET \
--url https://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit \
--header 'X-API-KEY: <api-key>'import requests
url = "https://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"status": "not_started",
"outcome": "completed",
"stage": "access",
"ran_at": "2023-11-07T05:31:56Z",
"domain": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>"
},
"checks_total": 123,
"checks_passing": 123,
"missing_count": 123,
"partial_count": 123,
"to_fix_count": 123,
"missing_by_priority": {
"high": 123,
"medium": 123,
"low": 123
},
"pages_checked": 123,
"pages_blocked": 123,
"failure": {
"reason": "<string>",
"title": "<string>",
"explanation": "<string>",
"fix": "<string>"
},
"latest_failure": {
"reason": "<string>",
"ran_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"explanation": "<string>",
"fix": "<string>"
},
"top_issues": [
{
"key": "access.ai_bot.oai_searchbot",
"title": "<string>",
"priority": "high",
"status": "missing",
"affected_count": 123
}
],
"quota": {
"limit": 123,
"used": 123,
"remaining": 123,
"unlimited": true,
"resets_at": "2023-11-07T05:31:56Z",
"spent": [
{
"domain_id": "<string>",
"domain": "<string>",
"runs": 123,
"last_run_at": "2023-11-07T05:31:56Z"
}
]
},
"sections": [
{
"key": "reach",
"title": "<string>",
"checks_total": 123,
"checks_passing": 123
}
],
"crawl": {
"sitemap_urls": 123,
"discovered": 123,
"out_of_scope": 123,
"duplicates_merged": 123,
"stored": 123,
"checked": 123,
"blocked": 123,
"errors": 123,
"non_html": 123,
"in_sitemap": 123,
"found_by_links": 123,
"classified": 123,
"classified_from_cache": 123,
"classify_failed": 123,
"page_limit": 123,
"hit_page_limit": true,
"timings": {
"access": 123,
"crawling": 123,
"classifying": 123,
"evaluating": 123,
"total": 123
},
"page_types": {
"article": 123,
"faq": 123,
"product": 123,
"pricing": 123,
"docs": 123,
"landing": 123,
"category": 123,
"about": 123,
"contact": 123,
"other": 123,
"unclassified": 123
}
},
"dismissed_count": 123,
"running": {
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stage": "access",
"started_at": "2023-11-07T05:31:56Z",
"trigger": "user"
},
"running_elsewhere": {
"domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"started_at": "2023-11-07T05:31:56Z"
}
}
}{
"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
Technical audit summary for one domain: counts, the top problems to fix, and any run in progress
GET
/
api
/
v2
/
brands
/
{brand_id}
/
technical_audit
Technical audit summary for one domain: counts, the top problems to fix, and any run in progress
curl --request GET \
--url https://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit \
--header 'X-API-KEY: <api-key>'import requests
url = "https://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit"
headers = {"X-API-KEY": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core.cognizo.ai/api/v2/brands/{brand_id}/technical_audit")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"status": "not_started",
"outcome": "completed",
"stage": "access",
"ran_at": "2023-11-07T05:31:56Z",
"domain": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>"
},
"checks_total": 123,
"checks_passing": 123,
"missing_count": 123,
"partial_count": 123,
"to_fix_count": 123,
"missing_by_priority": {
"high": 123,
"medium": 123,
"low": 123
},
"pages_checked": 123,
"pages_blocked": 123,
"failure": {
"reason": "<string>",
"title": "<string>",
"explanation": "<string>",
"fix": "<string>"
},
"latest_failure": {
"reason": "<string>",
"ran_at": "2023-11-07T05:31:56Z",
"title": "<string>",
"explanation": "<string>",
"fix": "<string>"
},
"top_issues": [
{
"key": "access.ai_bot.oai_searchbot",
"title": "<string>",
"priority": "high",
"status": "missing",
"affected_count": 123
}
],
"quota": {
"limit": 123,
"used": 123,
"remaining": 123,
"unlimited": true,
"resets_at": "2023-11-07T05:31:56Z",
"spent": [
{
"domain_id": "<string>",
"domain": "<string>",
"runs": 123,
"last_run_at": "2023-11-07T05:31:56Z"
}
]
},
"sections": [
{
"key": "reach",
"title": "<string>",
"checks_total": 123,
"checks_passing": 123
}
],
"crawl": {
"sitemap_urls": 123,
"discovered": 123,
"out_of_scope": 123,
"duplicates_merged": 123,
"stored": 123,
"checked": 123,
"blocked": 123,
"errors": 123,
"non_html": 123,
"in_sitemap": 123,
"found_by_links": 123,
"classified": 123,
"classified_from_cache": 123,
"classify_failed": 123,
"page_limit": 123,
"hit_page_limit": true,
"timings": {
"access": 123,
"crawling": 123,
"classifying": 123,
"evaluating": 123,
"total": 123
},
"page_types": {
"article": 123,
"faq": 123,
"product": 123,
"pricing": 123,
"docs": 123,
"landing": 123,
"category": 123,
"about": 123,
"contact": 123,
"other": 123,
"unclassified": 123
}
},
"dismissed_count": 123,
"running": {
"job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stage": "access",
"started_at": "2023-11-07T05:31:56Z",
"trigger": "user"
},
"running_elsewhere": {
"domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"domain": "<string>",
"started_at": "2023-11-07T05:31:56Z"
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": [
{
"field": "<string>",
"code": "<string>",
"message": "<string>"
}
]
}
}
