Skip to main content
GET
Your workspace’s entire competitor-interaction history, in one response, for analysis outside Clustr. It returns the whole history in one response, deliberately unfiltered and unpaged: the result means the same thing every time it is called, regardless of how anyone had the app’s table narrowed. The exclusions that are properties of the data rather than of a view still apply (dismissed people, the competitor’s own staff, and advisory/investor targets), and duplicates are merged on (actor, target, type, post), so there is one row per real interaction. Sorted newest-first.
This is a bulk export and can be large and slow. If you want a subset, use the filtered feed with a from/to window instead.
The deal fields (has_open_deal, deal_name, deal_stage, deal_amount) are the account’s open deal in your CRM, the one the Accounts page shows, read when you export. They are empty when the account has no open deal.

JSON or CSV

By default the response is JSON (the example on the right). Add format=csv to get the same rows as a CSV file instead, the one the app’s Export button downloads:
  • UTF-8 with a byte order mark, so Excel reads accented names correctly.
  • Sent as an attachment named clustr-competitor-interactions-<YYYY-MM-DD>.csv (the date in UTC).
  • A cell that starts with =, +, - or @ gets a leading apostrophe, so a spreadsheet never runs it as a formula.
Any other format value is answered with a 400.

At most 50,000 rows

One export holds at most 50,000 interactions, the newest ones. Every response, JSON or CSV, says how big it is in three headers: In JSON, data.total and data.truncated say the same. When it is truncated, say so rather than silently hand on a short file. The rows are sent as they are read, so the first bytes arrive before the last row is ready. If an export fails partway, the connection is closed before the response ends, and a CSV ends with the line # EXPORT FAILED: this file is incomplete. Download it again. A response that ends normally is complete.

Compression

Send Accept-Encoding: gzip (most HTTP clients do by default) and the response is gzip-compressed, typically several times smaller.

Authorizations

Authorization
string
header
required

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

Query Parameters

format
enum<string>
default:json

json (the default) or csv. CSV is UTF-8 with a byte order mark, served as an attachment named clustr-competitor-interactions-<YYYY-MM-DD>.csv; a cell that starts with = + - @ gets a leading apostrophe so a spreadsheet reads it as text. Any other value answers 400.

Available options:
json,
csv

Response

The whole interaction history

The CSV file, when format=csv.