Fetch the deliverables dashboard for a project

Returns the deliverables dashboard for a project. Response is wrapped: { success: true, data: DashboardData }. Returns 404 if no audit analysis has been run yet (call POST .../audit-analysis first).

GET /api/projects/{id}/deliverables

Fetch the deliverables dashboard for a project

cURL

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

import requests

url = "https://app.auditynow.com/api/projects/{id}/deliverables"

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}/deliverables', 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}/deliverables",
  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}/deliverables"

	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}/deliverables")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

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

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

{
  "success": true,
  "data": {
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "isComplete": true,
    "executiveSummary": "<string>",
    "opportunities": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "title": "<string>",
        "description": "<string>",
        "impactScore": 5,
        "effortScore": 5,
        "roiPotential": "<string>",
        "implementationTimeline": "<string>",
        "parallelExecution": true,
        "resourceRequirements": "<string>",
        "implementationStrategy": "<string>",
        "dependencies": [
          "<string>"
        ],
        "riskMitigation": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "risks": [
      {
        "id": "<string>",
        "title": "<string>",
        "description": "<string>"
      }
    ],
    "stakeholderMemos": [
      {
        "stakeholderName": "<string>",
        "stakeholderRole": "<string>",
        "memo": "<string>"
      }
    ],
    "generatedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "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

Deliverables dashboard data

success · boolean · required

data · object · required

Show child attributes