REST API

Get Buyer Summary

Retrieve a buyer activity summary synthesized from tracked buyer activity and available signals. Use this for buyer strategy, top priorities, momentum, risks, opportunity framing, account context across the available information, and outreach preparation. Generates on-demand if the cached summary is missing or stale. The summary field is structured into three sections (whatsRecent, theBiggerPicture, areasForDeeperDiscovery); each section’s sources carry triggerId/entryId back-pointers so you can drill into a citation via listBridgeRows. The summary can be null while a (re)generation is in flight, in which case needsRegeneration is true. Returns 404 (resource.buyer.summary.empty) when no Bridges in the org are configured to track this buyer — there is nothing to summarize, so suggest the user set up a Bridge that covers this buyer rather than retrying.

GET

api

external

buyer

{buyerId}

summary

Get Buyer Summary

curl --request GET \
  --url https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/summary \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/summary"

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

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

print(response.text)

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

fetch('https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/summary', 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://dashboard.starbridge.ai/api/external/buyer/{buyerId}/summary",
  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://dashboard.starbridge.ai/api/external/buyer/{buyerId}/summary"

	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://dashboard.starbridge.ai/api/external/buyer/{buyerId}/summary")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/summary")

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

{
  "buyerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "needsRegeneration": true,
  "summary": {
    "whatsRecent": {
      "sections": [
        {
          "title": "<string>",
          "text": "<string>",
          "sources": [
            {
              "entryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "triggerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "triggerType": "<string>",
              "triggerName": "<string>",
              "entryName": "<string>"
            }
          ]
        }
      ],
      "intro": "<string>"
    },
    "theBiggerPicture": {
      "sections": [
        {
          "title": "<string>",
          "text": "<string>",
          "sources": [
            {
              "entryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "triggerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "triggerType": "<string>",
              "triggerName": "<string>",
              "entryName": "<string>"
            }
          ]
        }
      ],
      "intro": "<string>"
    },
    "areasForDeeperDiscovery": {
      "sections": [
        {
          "title": "<string>",
          "text": "<string>",
          "sources": [
            {
              "entryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "triggerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "triggerType": "<string>",
              "triggerName": "<string>",
              "entryName": "<string>"
            }
          ]
        }
      ],
      "intro": "<string>"
    }
  },
  "score": 123,
  "scoreReasoning": "<string>",
  "generatedAt": "<string>"
}

Authorizations

Authorization

string

header

required

HTTP Bearer Authentication

Path Parameters

buyerId

string

required

Response

Buyer activity summary grounded in tracked account activity.

buyerId

string<uuid>

required

needsRegeneration

boolean

required

summary

BuyerSummaryContent · object | null

Show child attributes

score

integer | null

scoreReasoning

string | null

generatedAt

string | null

List Recent Buyer SignalsReturns the most recent Starbridge signals (bridge rows) for a given buyer within the organization. A signal pairs a bridge (the monitoring definition) with a row (a concrete match). Supports filtering by bridge ids, bridge filter types, row statuses, and a relative date period. Default sort is by signal date (most recent first); pass sort=Hotness to rank by hotness score. All sorts are descending.

⌘I

Get Buyer Summary

curl --request GET \
  --url https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/summary \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/summary"

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

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

print(response.text)

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

fetch('https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/summary', 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://dashboard.starbridge.ai/api/external/buyer/{buyerId}/summary",
  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://dashboard.starbridge.ai/api/external/buyer/{buyerId}/summary"

	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://dashboard.starbridge.ai/api/external/buyer/{buyerId}/summary")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://dashboard.starbridge.ai/api/external/buyer/{buyerId}/summary")

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

{
  "buyerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "needsRegeneration": true,
  "summary": {
    "whatsRecent": {
      "sections": [
        {
          "title": "<string>",
          "text": "<string>",
          "sources": [
            {
              "entryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "triggerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "triggerType": "<string>",
              "triggerName": "<string>",
              "entryName": "<string>"
            }
          ]
        }
      ],
      "intro": "<string>"
    },
    "theBiggerPicture": {
      "sections": [
        {
          "title": "<string>",
          "text": "<string>",
          "sources": [
            {
              "entryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "triggerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "triggerType": "<string>",
              "triggerName": "<string>",
              "entryName": "<string>"
            }
          ]
        }
      ],
      "intro": "<string>"
    },
    "areasForDeeperDiscovery": {
      "sections": [
        {
          "title": "<string>",
          "text": "<string>",
          "sources": [
            {
              "entryId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "triggerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "triggerType": "<string>",
              "triggerName": "<string>",
              "entryName": "<string>"
            }
          ]
        }
      ],
      "intro": "<string>"
    }
  },
  "score": 123,
  "scoreReasoning": "<string>",
  "generatedAt": "<string>"
}