Side-by-side metrics for up to ten accounts: POST /insights/x/compare

What this endpoint answers

Competitive analysis in one call: the same engagement block and cohort placement for every handle in the body, plus a ranking by engagement rate so follower count does not decide the answer. Handles we have not measured come back with null metrics and their coverage marker rather than being dropped.

This is a catalog read: it is served from the CRM Solid database in milliseconds, costs one budget unit, and reports how old the reading is in meta.cache_age_s. It needs the insights:read scope (Insights): Engagement rates, top posts, viral patterns, cohort benchmarks.

Good to know

At most 10 handles per call.
Ranking excludes handles with no tweet coverage; they are still present in accounts with coverage.tweets=false.
Rates are only comparable between accounts of similar size. peer_percentile is the size-adjusted number and is the fairer column to sort a competitive set on.

Parameters

This endpoint takes no path or query parameters.

Request body

handlesstring[]required
Array of X handles without the @, 1-10 of them, for example ["elonmusk","BillGates","NASA"]. Duplicates are collapsed case-insensitively before they take a slot.
metricstringoptional
Echoed onto the response for clients that batch several metrics.

Example request body

{
  "handles": [
    "string"
  ],
  "metric": "engagement"
}

Call it

Authenticate with a bearer token or the x-api-key header. Keys are server-to-server credentials. Never embed one in front-end code - call the API from your own backend and forward the result.

curl

curl -X POST "https://crmsolid.com/data-api/v2/insights/x/compare" \
  -H "Authorization: Bearer psk_live_..." \
  -H "Content-Type: application/json" \
  -d '{"handles":["string"],"metric":"engagement"}'

JavaScript

const res = await fetch("https://crmsolid.com/data-api/v2/insights/x/compare", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.CRM_SOLID_DATA_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "handles": [
      "string"
    ],
    "metric": "engagement"
  }),
});

if (!res.ok) {
  const { error } = await res.json();
  throw new Error(`${error.code}: ${error.message} (${error.request_id})`);
}

const { data, meta } = await res.json();

Python

import json
import os

import requests

body = json.loads("""
{
  "handles": [
    "string"
  ],
  "metric": "engagement"
}
""")

res = requests.post(
    "https://crmsolid.com/data-api/v2/insights/x/compare",
    headers={"Authorization": f"Bearer {os.environ['CRM_SOLID_DATA_API_KEY']}"},
    json=body,
    timeout=30,
)
res.raise_for_status()

payload = res.json()
data, meta = payload["data"], payload["meta"]

Keys look like psk_live_... for production keys, psk_test_... for test keys and are minted in the panel.

What comes back

Success is { data, meta }. Failure is { error: { code, message, request_id } }. The body below is the spec's own example: the values in it are illustrative readings, not live numbers.

Requested: 3
Resolved: 3
Ranking: 3 items
Accounts: 1 items

200 POST /insights/x/compare

{
  "data": {
    "requested": 3,
    "resolved": 3,
    "ranking": [
      {
        "handle": "elonmusk",
        "engagement_rate": 0.0471,
        "peer_percentile": 99.7,
        "followers": 241382119
      },
      {
        "handle": "BillGates",
        "engagement_rate": 0.0142,
        "peer_percentile": 71,
        "followers": 65130442
      },
      {
        "handle": "NASA",
        "engagement_rate": 0.0117,
        "peer_percentile": 62,
        "followers": 96204881
      }
    ],
    "accounts": [
      {
        "handle": "elonmusk",
        "found": true,
        "coverage": {
          "tweets": true,
          "reliable": true
        }
      }
    ]
  },
  "meta": {
    "request_id": "req_9f2c41a8b3d5",
    "generated_at": "2026-08-23T09:14:02.317Z",
    "took_ms": 42
  }
}

The meta block

request_idstringrequired
Unique id for this request. Quote it in a support ticket.
generated_atstringrequired
Server time the response was produced.
took_msintegerrequired
Milliseconds spent server-side.
pagePageoptional
sourcestringoptional
Which backend served the payload, for endpoints with more than one.
cache_age_sintegeroptional
Age of the underlying data in seconds. 0 for live reads.

When it fails

POST /insights/x/compare documents 7 failure statuses. Branch on error.code, which is stable and enumerated; message is prose and may change.

401Unauthorizedunauthorized | invalid_key
No key was presented, or the key is unknown, revoked or expired.
402PaymentRequiredpayment_required | subscription_inactive
The key is valid but the plan behind it cannot serve the call: the included requests are spent and overage is switched off, capped or unfunded (payment_required), or the billing period lapsed and was not renewed (subscription_inactive). Retrying does not help; paying does. The X-Plan-* headers on this response say how far past the line you are.
Carries X-Plan, X-Plan-Limit, X-Plan-Overage, X-Plan-Period-End, X-Plan-Remaining.
403Forbiddenforbidden_scope | forbidden_ip
The key is valid but not allowed to make this call: it lacks the scope, or the request came from an address outside the key's allowlist.
422InvalidRequestinvalid_request
A parameter is malformed, out of range or mutually exclusive with another. `details` names the offending fields.
429RateLimitedrate_limited | quota_exceeded
Either the burst ceiling for the current minute or the daily quota is spent. Distinguish with the code: rate_limited clears within the minute, quota_exceeded does not clear until 00:00 UTC.
Carries Retry-After, X-Quota-Limit, X-Quota-Remaining, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-Request-Id.
500InternalErrorinternal_error
Something failed on our side. Internals are never leaked; quote the request id.
503Unavailableupstream_timeout | upstream_error | not_configured
The request could not be served right now. BRANCH ON error.code, not on the status: 'upstream_timeout' means a source was too slow (this is what a catalog query hitting its 15-second statement timeout returns, so it is reachable from any endpoint that reads the corpus, not only the live-scrape ones) and the same call is worth retrying with backoff - narrowing it with a smaller limit, a filtered scope or a less popular account makes it far less likely; 'upstream_error' means a source was unreachable, so back off further; 'not_configured' means the capability has no backing service in this deployment, and retrying will never help.

Every response carries X-Request-Id and meta.request_id. Quote it in support requests.

Coverage and limits

This endpoint covers X. Rate limits come from the tier on your key.

X

Tier	Requests a minute	Requests a day	Live reads a minute
free	30	1,000	5
standard	120	25,000	20
pro	600	250,000	60
unlimited	6,000	10,000,000	600

This call only draws on the ordinary per-minute and per-day columns. Every response reports where you stand in X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset and the X-Plan headers.

The rest of the Insights group

Derived engagement intelligence: engagement rates, top and viral posts, posting patterns and cohort benchmarks computed over the post layer.

Other groups

Accounts Directory X People Live scrape Trends Identity Graph Watch Research Tools Leads

Start calling it

A key takes a minute to mint in the panel, no card. The reference covers authentication, the envelope, scopes, rate limits and every error code in one page.

Get a key All 127 endpoints Full reference What the Data API is

Reference path: /data-api/reference/insights-x-compare