cURL
curl --request GET \ --url https://api.alpic.ai/v1/beacon/audits/{auditId} \ --header 'Authorization: Bearer <token>'
{ "id": "<string>", "targetUrl": "<string>", "status": "pending", "durationMs": 123, "createdAt": "2023-11-07T05:31:56Z", "report": { "schemaVersion": "<string>", "auditId": "<string>", "targetUrl": "<string>", "startedAt": "<string>", "completedAt": "<string>", "durationMs": 123, "results": [ { "checkId": "<string>", "status": "pass", "message": "<string>", "severity": "error", "category": "connectivity", "scope": "server", "durationMs": 123, "skipReason": "<string>", "platforms": [ "chatgpt" ], "details": [ { "label": "<string>", "value": "<string>" } ], "hint": { "text": "<string>" } } ], "requiresAuth": true, "hasViewSupport": true, "isReadyForPlatform": {}, "viewPlatforms": [ "chatgpt" ], "widgetScreenshotKeys": { "chatgpt": "<string>", "claudeai": "<string>" }, "widgetScreenshots": { "chatgpt": { "url": "<string>" }, "claudeai": { "url": "<string>" } } } }
Get a beacon audit by ID, including the report if completed
Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.
The ID of the audit
The audit details
pending
partial
completed
failed
Show child attributes
Was this page helpful?
Contact support