curl --request POST \
--url https://api.athenahq.ai/api/v1/seo/issues \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"website_id": "<string>",
"check": "<string>",
"search": "<string>",
"assignee": "me",
"page": 123,
"page_urls": [
"<string>"
],
"page_size": 123
}
'import requests
url = "https://api.athenahq.ai/api/v1/seo/issues"
payload = {
"website_id": "<string>",
"check": "<string>",
"search": "<string>",
"assignee": "me",
"page": 123,
"page_urls": ["<string>"],
"page_size": 123
}
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({
website_id: '<string>',
check: '<string>',
search: '<string>',
assignee: 'me',
page: 123,
page_urls: ['<string>'],
page_size: 123
})
};
fetch('https://api.athenahq.ai/api/v1/seo/issues', 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.athenahq.ai/api/v1/seo/issues",
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([
'website_id' => '<string>',
'check' => '<string>',
'search' => '<string>',
'assignee' => 'me',
'page' => 123,
'page_urls' => [
'<string>'
],
'page_size' => 123
]),
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.athenahq.ai/api/v1/seo/issues"
payload := strings.NewReader("{\n \"website_id\": \"<string>\",\n \"check\": \"<string>\",\n \"search\": \"<string>\",\n \"assignee\": \"me\",\n \"page\": 123,\n \"page_urls\": [\n \"<string>\"\n ],\n \"page_size\": 123\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.athenahq.ai/api/v1/seo/issues")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"website_id\": \"<string>\",\n \"check\": \"<string>\",\n \"search\": \"<string>\",\n \"assignee\": \"me\",\n \"page\": 123,\n \"page_urls\": [\n \"<string>\"\n ],\n \"page_size\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.athenahq.ai/api/v1/seo/issues")
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 \"website_id\": \"<string>\",\n \"check\": \"<string>\",\n \"search\": \"<string>\",\n \"assignee\": \"me\",\n \"page\": 123,\n \"page_urls\": [\n \"<string>\"\n ],\n \"page_size\": 123\n}"
response = http.request(request)
puts response.read_body{
"groups": [
{
"check": "<string>",
"title": "<string>",
"why_it_matters": "<string>",
"owner": "writer",
"effort": "minutes",
"bucket": "technical_cleanup",
"severity": "critical",
"priority": "high",
"site_wide": true,
"counts": {
"open": 123,
"in_progress": 123,
"fixed": 123,
"verified": 123,
"dismissed": 123
},
"sections": [
{
"section": "<string>",
"open": 123,
"audited": 123
}
],
"pages": [
{
"finding_id": "<string>",
"page_id": "<string>",
"property_id": "<string>",
"url": "<string>",
"status": "open",
"page_title": "<string>",
"detail": "<string>",
"recommendation": "<string>",
"shared_value": "<string>",
"evidence": [
"<string>"
],
"evidence_links": [
{
"label": "<string>",
"url": "<string>"
}
],
"robots_txt_rule": {
"url": "<string>",
"line": 123,
"excerpt": [
{
"line": 123,
"text": "<string>"
}
]
},
"first_seen_at": "<string>",
"last_seen_at": "<string>",
"resolved_at": "<string>",
"last_checked_at": "<string>",
"assignee": {
"id": "<string>",
"name": "<string>"
},
"task_revision": 123,
"draft": {
"run_id": "<string>",
"status": "<string>"
}
}
],
"has_more_pages": true
}
],
"total": 123,
"counts": {
"open": 123,
"in_progress": 123,
"fixed": 123,
"verified": 123,
"dismissed": 123
},
"page_size": 123,
"has_evidence": true
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}List Site Health issues
List a website’s Site Health issues: one group per kind of problem (check) with its title, why it matters, severity (critical, warning, opportunity), priority (high, medium, low), owner (writer, developer or either; null when unknown), effort (minutes, hours, days), whether it is site-wide, counts of affected pages by status (open, in_progress, fixed, verified, dismissed), up to three sections it concentrates in, and sample affected pages with each page’s detail, recommendation, evidence, assignee and task_revision. Filter by status, check, a search term, the stored URLs of specific pages (page_urls), or assignee “me” (signed-in connections only). Groups are paged: page is 0-based, page_size defaults to 25 (max 200) and total counts the groups that match; counts totals pages by status across the whole site, ignoring the status filter. A group carries at most 50 sample pages (10 when a tool calls it, which also caps page_size at 25); has_more_pages says to read the rest with the issue pages read (get_site_health_issue_pages or POST /v1/seo/issues/pages), whose page 0 repeats the sample pages. has_evidence false means the site has never been crawled or audited. Requires Site Health on the website’s plan; otherwise the call fails with 403.
curl --request POST \
--url https://api.athenahq.ai/api/v1/seo/issues \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"website_id": "<string>",
"check": "<string>",
"search": "<string>",
"assignee": "me",
"page": 123,
"page_urls": [
"<string>"
],
"page_size": 123
}
'import requests
url = "https://api.athenahq.ai/api/v1/seo/issues"
payload = {
"website_id": "<string>",
"check": "<string>",
"search": "<string>",
"assignee": "me",
"page": 123,
"page_urls": ["<string>"],
"page_size": 123
}
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({
website_id: '<string>',
check: '<string>',
search: '<string>',
assignee: 'me',
page: 123,
page_urls: ['<string>'],
page_size: 123
})
};
fetch('https://api.athenahq.ai/api/v1/seo/issues', 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.athenahq.ai/api/v1/seo/issues",
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([
'website_id' => '<string>',
'check' => '<string>',
'search' => '<string>',
'assignee' => 'me',
'page' => 123,
'page_urls' => [
'<string>'
],
'page_size' => 123
]),
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.athenahq.ai/api/v1/seo/issues"
payload := strings.NewReader("{\n \"website_id\": \"<string>\",\n \"check\": \"<string>\",\n \"search\": \"<string>\",\n \"assignee\": \"me\",\n \"page\": 123,\n \"page_urls\": [\n \"<string>\"\n ],\n \"page_size\": 123\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.athenahq.ai/api/v1/seo/issues")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"website_id\": \"<string>\",\n \"check\": \"<string>\",\n \"search\": \"<string>\",\n \"assignee\": \"me\",\n \"page\": 123,\n \"page_urls\": [\n \"<string>\"\n ],\n \"page_size\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.athenahq.ai/api/v1/seo/issues")
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 \"website_id\": \"<string>\",\n \"check\": \"<string>\",\n \"search\": \"<string>\",\n \"assignee\": \"me\",\n \"page\": 123,\n \"page_urls\": [\n \"<string>\"\n ],\n \"page_size\": 123\n}"
response = http.request(request)
puts response.read_body{
"groups": [
{
"check": "<string>",
"title": "<string>",
"why_it_matters": "<string>",
"owner": "writer",
"effort": "minutes",
"bucket": "technical_cleanup",
"severity": "critical",
"priority": "high",
"site_wide": true,
"counts": {
"open": 123,
"in_progress": 123,
"fixed": 123,
"verified": 123,
"dismissed": 123
},
"sections": [
{
"section": "<string>",
"open": 123,
"audited": 123
}
],
"pages": [
{
"finding_id": "<string>",
"page_id": "<string>",
"property_id": "<string>",
"url": "<string>",
"status": "open",
"page_title": "<string>",
"detail": "<string>",
"recommendation": "<string>",
"shared_value": "<string>",
"evidence": [
"<string>"
],
"evidence_links": [
{
"label": "<string>",
"url": "<string>"
}
],
"robots_txt_rule": {
"url": "<string>",
"line": 123,
"excerpt": [
{
"line": 123,
"text": "<string>"
}
]
},
"first_seen_at": "<string>",
"last_seen_at": "<string>",
"resolved_at": "<string>",
"last_checked_at": "<string>",
"assignee": {
"id": "<string>",
"name": "<string>"
},
"task_revision": 123,
"draft": {
"run_id": "<string>",
"status": "<string>"
}
}
],
"has_more_pages": true
}
],
"total": 123,
"counts": {
"open": 123,
"in_progress": 123,
"fixed": 123,
"verified": 123,
"dismissed": 123
},
"page_size": 123,
"has_evidence": true
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Body
Was this page helpful?