curl --request GET \
--url https://server.promptwatch.com/api/v2/site-audit/links \
--header 'X-API-Key: <api-key>'import requests
url = "https://server.promptwatch.com/api/v2/site-audit/links"
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://server.promptwatch.com/api/v2/site-audit/links', 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://server.promptwatch.com/api/v2/site-audit/links",
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://server.promptwatch.com/api/v2/site-audit/links"
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://server.promptwatch.com/api/v2/site-audit/links")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.promptwatch.com/api/v2/site-audit/links")
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{
"kind": "brokenLinks",
"nextCursor": null,
"rows": [
{
"anchorText": "pricing",
"nofollow": false,
"sourceHash": "0f115db062b7c0dd",
"sourceUrl": "https://example.com/",
"targetHash": "23a538fde85c5907",
"targetStatusCode": 404,
"targetUrl": "https://example.com/pricing"
}
],
"runId": "6ba7b820-9dad-11d1-80b4-00c04fd430c8",
"total": 1,
"truncated": false
}{
"error": "Bad Request",
"code": "DATE_RANGE_TOO_LARGE",
"message": "Date range cannot exceed 92 days"
}{
"error": "Unauthorized",
"message": "Missing or invalid X-API-Key header."
}{
"code": "SITE_AUDIT_RUN_NOT_FOUND",
"message": "Site audit run not found"
}{
"code": "SITE_AUDIT_RUN_NOT_FOUND",
"message": "Site audit run not found"
}{
"code": "SITE_AUDIT_RUN_NOT_FOUND",
"message": "Site audit run not found"
}List site audit link findings
One link list for a run: orphans, brokenLinks, coverageGaps or navOnly. Omit runId for the newest finished run. truncated means the stored list hit its cap. The brokenLinks cursor is opaque; pass nextCursor back as cursor.
curl --request GET \
--url https://server.promptwatch.com/api/v2/site-audit/links \
--header 'X-API-Key: <api-key>'import requests
url = "https://server.promptwatch.com/api/v2/site-audit/links"
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://server.promptwatch.com/api/v2/site-audit/links', 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://server.promptwatch.com/api/v2/site-audit/links",
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://server.promptwatch.com/api/v2/site-audit/links"
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://server.promptwatch.com/api/v2/site-audit/links")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.promptwatch.com/api/v2/site-audit/links")
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{
"kind": "brokenLinks",
"nextCursor": null,
"rows": [
{
"anchorText": "pricing",
"nofollow": false,
"sourceHash": "0f115db062b7c0dd",
"sourceUrl": "https://example.com/",
"targetHash": "23a538fde85c5907",
"targetStatusCode": 404,
"targetUrl": "https://example.com/pricing"
}
],
"runId": "6ba7b820-9dad-11d1-80b4-00c04fd430c8",
"total": 1,
"truncated": false
}{
"error": "Bad Request",
"code": "DATE_RANGE_TOO_LARGE",
"message": "Date range cannot exceed 92 days"
}{
"error": "Unauthorized",
"message": "Missing or invalid X-API-Key header."
}{
"code": "SITE_AUDIT_RUN_NOT_FOUND",
"message": "Site audit run not found"
}{
"code": "SITE_AUDIT_RUN_NOT_FOUND",
"message": "Site audit run not found"
}{
"code": "SITE_AUDIT_RUN_NOT_FOUND",
"message": "Site audit run not found"
}Authorizations
API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.
Query Parameters
Cursor from the previous response's nextCursor
orphans (no inbound links), brokenLinks (edges to a dead page), coverageGaps (linked URLs never fetched) or navOnly (linked only from site-wide navigation)
orphans, brokenLinks, coverageGaps, navOnly Page size (default 50, max 200)
1 <= x <= 200Defaults to the latest finished run
Response
Default Response
orphans (no inbound links), brokenLinks (edges to a dead page), coverageGaps (linked URLs never fetched) or navOnly (linked only from site-wide navigation)
orphans, brokenLinks, coverageGaps, navOnly Pass as cursor to fetch the next page; null on the last page
Rows for the requested kind
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
{
"anchorText": "pricing",
"nofollow": false,
"sourceHash": "0f115db062b7c0dd",
"sourceUrl": "https://example.com/",
"targetHash": "23a538fde85c5907",
"targetStatusCode": 404,
"targetUrl": "https://example.com/pricing"
}
Run the response was read from
Stored rows. A truncated list is a floor, not a count.
True when finalize capped how many rows of this kind it stored