Skip to main content
GET
/
{brand_id}
/
page-audits
/
{page_audit_id}
Get Page Audit
curl --request GET \
  --url https://api.scrunchai.com/v1/{brand_id}/page-audits/{page_audit_id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.scrunchai.com/v1/{brand_id}/page-audits/{page_audit_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.scrunchai.com/v1/{brand_id}/page-audits/{page_audit_id}', 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.scrunchai.com/v1/{brand_id}/page-audits/{page_audit_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$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://api.scrunchai.com/v1/{brand_id}/page-audits/{page_audit_id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.scrunchai.com/v1/{brand_id}/page-audits/{page_audit_id}")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.scrunchai.com/v1/{brand_id}/page-audits/{page_audit_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "url": "<string>",
  "result": {
    "access_controls_score": 123,
    "content_delivery_score": 123,
    "content_quality_score": 123,
    "access_controls_succeeded": 123,
    "content_delivery_succeeded": 123,
    "content_quality_succeeded": 123,
    "access_controls_failed": 123,
    "content_delivery_failed": 123,
    "content_quality_failed": 123,
    "access_controls_total": 123,
    "content_delivery_total": 123,
    "content_quality_total": 123,
    "version": 1,
    "checks": [
      {
        "check_score": 123,
        "check_description": "<string>",
        "detail": "<string>",
        "help_text": "<string>"
      }
    ],
    "visitor_preview_image_url": "<string>",
    "ai_preview_markdown": "<string>",
    "title": "<string>",
    "description": "<string>",
    "final_url": "<string>",
    "assistant_statuses": [
      {
        "assistant": {
          "name": "<string>",
          "does_training": true,
          "does_retrieval": true,
          "does_search_indexing": true,
          "can_cite": true,
          "search_agents": [],
          "retrieval_agents": [],
          "training_agents": []
        },
        "sample_title": "<string>",
        "sample_description": "<string>",
        "sample_final_url": "<string>",
        "can_retrieve": true,
        "retrieval_response_time": 123,
        "retrieval_block_reason": "<string>"
      }
    ],
    "screenshot_vs_page": {
      "screenshot_is_representative": true,
      "difference_explanation": "<string>",
      "missing_content_from_markdown": [
        "<string>"
      ],
      "importance_of_missing_content": "critical"
    },
    "intent_vs_page": {
      "markdown_respresents_intent": true,
      "intent_of_page": "<string>",
      "difference_explanation": "<string>"
    },
    "key_question_answers": [
      {
        "question": "<string>",
        "answer": "<string>",
        "rationale": "<string>"
      }
    ]
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brand_id
integer
required
page_audit_id
string
required

Response

Successful Response

url
string
required
status
enum<string>
required
Available options:
pending,
running,
completed,
failed
result
PageTestResult · object | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required