List Competitor Summaries

GET

competitor-summaries

curl https://api.clustr-ai.com/api/public/competitor-summaries \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests

requests.get(
    "https://api.clustr-ai.com/api/public/competitor-summaries",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)

await fetch("https://api.clustr-ai.com/api/public/competitor-summaries", {
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});

{
  "success": true,
  "data": {
    "summaries": [
      {
        "clustr_competitor_id": "cmp_r0jpyyqyeh0txpgdhb604j2g9s",
        "competitor_id": "c1a2b3c4-d5e6-7890-abcd-ef1234567890",
        "competitor_name": "Globex Inc",
        "persons_tracked": 24,
        "interactions": 2871,
        "accounts_touched": 148,
        "atk_accounts": 101,
        "def_accounts": 47,
        "at_risk": 6
      },
      {
        "clustr_competitor_id": "cmp_5ry79b7b4dh6544gqk56z0dx8c",
        "competitor_id": "d2b3c4d5-e6f7-8901-bcde-f23456789012",
        "competitor_name": "Initech",
        "persons_tracked": 11,
        "interactions": 1257,
        "accounts_touched": 82,
        "atk_accounts": 66,
        "def_accounts": 16,
        "at_risk": 3
      }
    ],
    "totals": {
      "accounts_touched": 201,
      "at_risk": 8
    }
  }
}

Every tracked competitor’s header tallies in a single read: people tracked, interactions, accounts touched, the attack/defend split, and the at-risk count. It replaces calling the battlecard once per competitor when all you want is the scoreboard. Attack, defend and at-risk come from one workspace-wide overlay of your live CRM over every competitor’s touched accounts, so the numbers are comparable across competitors. totals gives the workspace-wide figures across every competitor, counting each account once however many competitors touch it: accounts_touched, and at_risk (you own the account and it has an open deal). The per-competitor rows count an account once per competitor, so their sum can be higher.

curl https://api.clustr-ai.com/api/public/competitor-summaries \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests

requests.get(
    "https://api.clustr-ai.com/api/public/competitor-summaries",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)

await fetch("https://api.clustr-ai.com/api/public/competitor-summaries", {
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});

{
  "success": true,
  "data": {
    "summaries": [
      {
        "clustr_competitor_id": "cmp_r0jpyyqyeh0txpgdhb604j2g9s",
        "competitor_id": "c1a2b3c4-d5e6-7890-abcd-ef1234567890",
        "competitor_name": "Globex Inc",
        "persons_tracked": 24,
        "interactions": 2871,
        "accounts_touched": 148,
        "atk_accounts": 101,
        "def_accounts": 47,
        "at_risk": 6
      },
      {
        "clustr_competitor_id": "cmp_5ry79b7b4dh6544gqk56z0dx8c",
        "competitor_id": "d2b3c4d5-e6f7-8901-bcde-f23456789012",
        "competitor_name": "Initech",
        "persons_tracked": 11,
        "interactions": 1257,
        "accounts_touched": 82,
        "atk_accounts": 66,
        "def_accounts": 16,
        "at_risk": 3
      }
    ],
    "totals": {
      "accounts_touched": 201,
      "at_risk": 8
    }
  }
}

Authorizations

Authorization

string

header

required

The API key you created on the API settings page of the Clustr app.

Query Parameters

from

string<date-time>

The start of the time window, as an RFC 3339 timestamp. Leave it out to cover all time.

string<date-time>

The end of the time window, as an RFC 3339 timestamp.

Response

The counts for each competitor

success

boolean

required

Example:

true

data

object

required

curl https://api.clustr-ai.com/api/public/competitor-summaries \
  -H "Authorization: Bearer YOUR_API_KEY"

import requests

requests.get(
    "https://api.clustr-ai.com/api/public/competitor-summaries",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
)

await fetch("https://api.clustr-ai.com/api/public/competitor-summaries", {
  headers: { Authorization: "Bearer YOUR_API_KEY" },
});

{
  "success": true,
  "data": {
    "summaries": [
      {
        "clustr_competitor_id": "cmp_r0jpyyqyeh0txpgdhb604j2g9s",
        "competitor_id": "c1a2b3c4-d5e6-7890-abcd-ef1234567890",
        "competitor_name": "Globex Inc",
        "persons_tracked": 24,
        "interactions": 2871,
        "accounts_touched": 148,
        "atk_accounts": 101,
        "def_accounts": 47,
        "at_risk": 6
      },
      {
        "clustr_competitor_id": "cmp_5ry79b7b4dh6544gqk56z0dx8c",
        "competitor_id": "d2b3c4d5-e6f7-8901-bcde-f23456789012",
        "competitor_name": "Initech",
        "persons_tracked": 11,
        "interactions": 1257,
        "accounts_touched": 82,
        "atk_accounts": 66,
        "def_accounts": 16,
        "at_risk": 3
      }
    ],
    "totals": {
      "accounts_touched": 201,
      "at_risk": 8
    }
  }
}

API Reference

Import

Search

Jobs

Network

Opportunities

Owners

Accounts

Account States

Saved Views

Workflows

Intro Requests

Notes

Record Activity

Tags

Target Accounts

Client Companies

Excluded Companies

Buyer Titles

ICP

Competitor Monitoring

Connector Refresh

Notifications

List Competitor Summaries

Authorizations

Query Parameters

Response