Skip to main content
GET
/
api
/
projects
/
{id}
/
audit-analysis
Get the latest audit analysis
curl --request GET \
  --url https://app.auditynow.com/api/projects/{id}/audit-analysis \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "running",
  "createdAt": "2023-11-07T05:31:56Z",
  "executiveSummary": "<string>",
  "opportunityCount": 123,
  "riskCount": 123,
  "synthesis": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.auditynow.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

A Personal Access Token issued from https://app.auditynow.com/dashboard/settings/api-tokens. Format: aky_<32 random chars>.

Path Parameters

​
id
string<uuid>
required

The project's UUID.

Response

Latest audit analysis

​
id
string<uuid>
required
​
projectId
string<uuid>
required
​
status
enum<string>
required
Available options:
running,
complete,
failed
​
createdAt
string<date-time>
​
executiveSummary
string | null
​
opportunityCount
integer
​
riskCount
integer
​
synthesis
object

Full structured synthesis output. Shape varies by audit type. See Audity-v1/types/comprehensive-audit.ts for full type.