Get a beacon audit
curl --request GET \
--url https://api.alpic.ai/v1/beacon/audits/{auditId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.alpic.ai/v1/beacon/audits/{auditId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.alpic.ai/v1/beacon/audits/{auditId}', 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.alpic.ai/v1/beacon/audits/{auditId}",
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.alpic.ai/v1/beacon/audits/{auditId}"
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.alpic.ai/v1/beacon/audits/{auditId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alpic.ai/v1/beacon/audits/{auditId}")
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{
"id": "<string>",
"targetUrl": "<string>",
"durationMs": 123,
"createdAt": "2023-11-07T05:31:56Z",
"report": {
"schemaVersion": "<string>",
"auditId": "<string>",
"targetUrl": "<string>",
"startedAt": "<string>",
"completedAt": "<string>",
"durationMs": 123,
"results": [
{
"checkId": "<string>",
"checkName": "<string>",
"description": "<string>",
"message": "<string>",
"durationMs": 123,
"skipReason": "<string>",
"platforms": [],
"details": [
{
"label": "<string>",
"value": "<string>"
}
],
"hint": {
"text": "<string>"
}
}
],
"requiresAuth": true,
"hasViewSupport": true,
"isReadyForPlatform": {},
"widgetScreenshotKeys": {
"chatgpt": "<string>",
"claudeai": "<string>"
},
"widgetScreenshots": {
"chatgpt": {
"url": "<string>"
},
"claudeai": {
"url": "<string>"
}
},
"viewPlatforms": []
}
}{
"defined": "<unknown>",
"code": "<unknown>",
"status": "<unknown>",
"message": "Bad Request",
"data": "<unknown>"
}{
"defined": "<unknown>",
"code": "<unknown>",
"status": "<unknown>",
"message": "Not Found",
"data": "<unknown>"
}beacon
Get a beacon audit
Get a beacon audit by ID, including the report if completed
GET
/
v1
/
beacon
/
audits
/
{auditId}
Get a beacon audit
curl --request GET \
--url https://api.alpic.ai/v1/beacon/audits/{auditId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.alpic.ai/v1/beacon/audits/{auditId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.alpic.ai/v1/beacon/audits/{auditId}', 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.alpic.ai/v1/beacon/audits/{auditId}",
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.alpic.ai/v1/beacon/audits/{auditId}"
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.alpic.ai/v1/beacon/audits/{auditId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alpic.ai/v1/beacon/audits/{auditId}")
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{
"id": "<string>",
"targetUrl": "<string>",
"durationMs": 123,
"createdAt": "2023-11-07T05:31:56Z",
"report": {
"schemaVersion": "<string>",
"auditId": "<string>",
"targetUrl": "<string>",
"startedAt": "<string>",
"completedAt": "<string>",
"durationMs": 123,
"results": [
{
"checkId": "<string>",
"checkName": "<string>",
"description": "<string>",
"message": "<string>",
"durationMs": 123,
"skipReason": "<string>",
"platforms": [],
"details": [
{
"label": "<string>",
"value": "<string>"
}
],
"hint": {
"text": "<string>"
}
}
],
"requiresAuth": true,
"hasViewSupport": true,
"isReadyForPlatform": {},
"widgetScreenshotKeys": {
"chatgpt": "<string>",
"claudeai": "<string>"
},
"widgetScreenshots": {
"chatgpt": {
"url": "<string>"
},
"claudeai": {
"url": "<string>"
}
},
"viewPlatforms": []
}
}{
"defined": "<unknown>",
"code": "<unknown>",
"status": "<unknown>",
"message": "Bad Request",
"data": "<unknown>"
}{
"defined": "<unknown>",
"code": "<unknown>",
"status": "<unknown>",
"message": "Not Found",
"data": "<unknown>"
}Authorizations
Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.
Path Parameters
The ID of the audit
Was this page helpful?
⌘I