Start a site audit.
curl --request POST \
--url https://api.parallellabs.app/api/v0/seo/audits \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"companyId": "<string>",
"domain": "<string>",
"maxPages": 123,
"checkAiReadiness": true
}
'import requests
url = "https://api.parallellabs.app/api/v0/seo/audits"
payload = {
"companyId": "<string>",
"domain": "<string>",
"maxPages": 123,
"checkAiReadiness": True
}
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({
companyId: '<string>',
domain: '<string>',
maxPages: 123,
checkAiReadiness: true
})
};
fetch('https://api.parallellabs.app/api/v0/seo/audits', 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.parallellabs.app/api/v0/seo/audits",
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([
'companyId' => '<string>',
'domain' => '<string>',
'maxPages' => 123,
'checkAiReadiness' => true
]),
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://api.parallellabs.app/api/v0/seo/audits"
payload := strings.NewReader("{\n \"companyId\": \"<string>\",\n \"domain\": \"<string>\",\n \"maxPages\": 123,\n \"checkAiReadiness\": true\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://api.parallellabs.app/api/v0/seo/audits")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyId\": \"<string>\",\n \"domain\": \"<string>\",\n \"maxPages\": 123,\n \"checkAiReadiness\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.parallellabs.app/api/v0/seo/audits")
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 \"companyId\": \"<string>\",\n \"domain\": \"<string>\",\n \"maxPages\": 123,\n \"checkAiReadiness\": true\n}"
response = http.request(request)
puts response.read_body{
"audit": {
"id": "<string>",
"domain": "<string>",
"startUrl": "<string>",
"status": "queued",
"error": "<string>",
"maxPages": 123,
"pagesCrawled": 123,
"healthScore": 123,
"issueCounts": {},
"issueSummary": [
{
"id": "<string>",
"severity": "<string>",
"label": "<string>",
"pageCount": 123
}
],
"linksChecked": 123,
"brokenLinkCount": 123,
"avgResponseMs": 123,
"aiReadinessScore": 123,
"aiReadinessGrade": "<string>",
"aiReadinessChecks": {},
"aiReadinessRecommendations": [
{}
],
"aiReadinessCheckedAt": "2023-11-07T05:31:56Z",
"aiReadinessError": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"created_date": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}SEO
Start a site audit.
Crawls the domain from its homepage and checks each page for on-page SEO problems. Returns as soon as the audit is queued - the crawl runs in the background, so poll the audit until its status is complete.
POST
/
api
/
v0
/
seo
/
audits
Start a site audit.
curl --request POST \
--url https://api.parallellabs.app/api/v0/seo/audits \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"companyId": "<string>",
"domain": "<string>",
"maxPages": 123,
"checkAiReadiness": true
}
'import requests
url = "https://api.parallellabs.app/api/v0/seo/audits"
payload = {
"companyId": "<string>",
"domain": "<string>",
"maxPages": 123,
"checkAiReadiness": True
}
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({
companyId: '<string>',
domain: '<string>',
maxPages: 123,
checkAiReadiness: true
})
};
fetch('https://api.parallellabs.app/api/v0/seo/audits', 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.parallellabs.app/api/v0/seo/audits",
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([
'companyId' => '<string>',
'domain' => '<string>',
'maxPages' => 123,
'checkAiReadiness' => true
]),
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://api.parallellabs.app/api/v0/seo/audits"
payload := strings.NewReader("{\n \"companyId\": \"<string>\",\n \"domain\": \"<string>\",\n \"maxPages\": 123,\n \"checkAiReadiness\": true\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://api.parallellabs.app/api/v0/seo/audits")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyId\": \"<string>\",\n \"domain\": \"<string>\",\n \"maxPages\": 123,\n \"checkAiReadiness\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.parallellabs.app/api/v0/seo/audits")
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 \"companyId\": \"<string>\",\n \"domain\": \"<string>\",\n \"maxPages\": 123,\n \"checkAiReadiness\": true\n}"
response = http.request(request)
puts response.read_body{
"audit": {
"id": "<string>",
"domain": "<string>",
"startUrl": "<string>",
"status": "queued",
"error": "<string>",
"maxPages": 123,
"pagesCrawled": 123,
"healthScore": 123,
"issueCounts": {},
"issueSummary": [
{
"id": "<string>",
"severity": "<string>",
"label": "<string>",
"pageCount": 123
}
],
"linksChecked": 123,
"brokenLinkCount": 123,
"avgResponseMs": 123,
"aiReadinessScore": 123,
"aiReadinessGrade": "<string>",
"aiReadinessChecks": {},
"aiReadinessRecommendations": [
{}
],
"aiReadinessCheckedAt": "2023-11-07T05:31:56Z",
"aiReadinessError": "<string>",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"created_date": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
CompanyApiKeyBearerAuth & CompanyId
Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.
Body
application/json
Domain to audit
Queue a site audit. Returns immediately with a queued audit; the crawl runs in the background, so poll the audit until status is complete.
Response
The queued audit
The site audit
A site audit. Carries its own rolled-up totals, so listing audits never loads the per-page rows.
Show child attributes
Show child attributes
⌘I

