Get the latest audit analysis

Returns the most recent completed audit analysis for the project. If analysis is still running, returns status: "running". If never run, returns 404.

GET /api/projects/{id}/audit-analysis

Get the latest audit analysis

cURL

curl --request GET \
  --url https://app.auditynow.com/api/projects/{id}/audit-analysis \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.auditynow.com/api/projects/{id}/audit-analysis"

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

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://app.auditynow.com/api/projects/{id}/audit-analysis', 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://app.auditynow.com/api/projects/{id}/audit-analysis",
  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://app.auditynow.com/api/projects/{id}/audit-analysis"

	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://app.auditynow.com/api/projects/{id}/audit-analysis")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.auditynow.com/api/projects/{id}/audit-analysis")

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

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdAt": "2023-11-07T05:31:56Z",
  "executiveSummary": "<string>",
  "opportunityCount": 123,
  "riskCount": 123,
  "synthesis": {}
}

{
  "error": "Unauthorized"
}

{
  "error": "<string>",
  "details": "<string>"
}

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

200

application/json

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.