List proactive AI insights

Returns insights generated by Nucleus’s background cron jobs. Insight types include pre_meeting, overdue_followup, pattern_detected, referral_opportunity, portfolio_insight, stale_client, similar_lead, content_suggestion.

Use ?unreadOnly=true to fetch only unread.

GET /api/nucleus/insights

List proactive AI insights

cURL

curl --request GET \
  --url https://app.auditynow.com/api/nucleus/insights \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://app.auditynow.com/api/nucleus/insights"

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/nucleus/insights', 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/nucleus/insights",
  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/nucleus/insights"

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

require 'uri'
require 'net/http'

url = URI("https://app.auditynow.com/api/nucleus/insights")

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",
    "title": "<string>",
    "body": "<string>",
    "isRead": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "isDismissed": true
  }
]

{
  "error": "Unauthorized"
}

Authorizations

Authorization · string · header · required

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

Query Parameters

type · enum<string>

Available options: pre_meeting, overdue_followup, pattern_detected, referral_opportunity, portfolio_insight, stale_client, similar_lead, content_suggestion

unreadOnly · boolean · default: false

limit · integer · default: 25

Required range: 1 <= x <= 100

Response

200

application/json

Insights

id · string<uuid> · required

type · enum<string> · required

Available options: pre_meeting, overdue_followup, pattern_detected, referral_opportunity, portfolio_insight, stale_client, similar_lead, content_suggestion

title · string · required

body · string · required

isRead · boolean · required

createdAt · string<date-time> · required

projectId · string<uuid> | null

isDismissed · boolean