API reference / Account insights

Your social selling index (live)

Written and maintained by The ProspectAPIs team

GET/v1/insights/ssi

GET /v1/insights/ssi is the ProspectAPIs operation readSocialSellingIndex, in the Account insights group of the REST API. Your social selling index (0 to 100) and its four parts (0 to 25 each): professional_brand, finding_people, engaging_insights and building_relationships, with your top-percent rank in your industry and your network when shown. $0.01 per read. Acts on your own connected account. Billed per call once the messaging-read family is live; while it is not yet on sale the call is free (GET /pricing reports messaging_reads.available). While GET /pricing does not list this route in messaging_reads.available_routes it answers 503 temporarily_unavailable and nothing is charged. Cost: Launching soon. Send your API key as a Bearer token in the Authorization header.

The quickstart shows this call in context, next to the first requests most integrations make.

Parameters

This operation takes no path or query parameters.

Responses

Every error answers with the same JSON body, an error string and sometimes a code; the errors page lists each status and when it happens. A per-key 429 carries Retry-After; see rate limits.

200 response fields

The index and its four parts, read fresh, with coverage. The body is a PeopleReadResult.

Code samples

Each sample sends the same request. Set PROSPECTAPIS_KEY in your environment first. Values come from the spec's examples; replace them with your own.

curl https://api.prospectapis.com/v1/insights/ssi \
  -H "Authorization: Bearer $PROSPECTAPIS_KEY"

const res = await fetch("https://api.prospectapis.com/v1/insights/ssi", {
  headers: { Authorization: `Bearer ${process.env.PROSPECTAPIS_KEY}` },
});
if (!res.ok) throw new Error(`${res.status}: ${(await res.json().catch(() => ({}))).error ?? res.statusText}`);
const data = await res.json();
console.log(data);

import os, requests

res = requests.get(
    "https://api.prospectapis.com/v1/insights/ssi",
    headers={"Authorization": f"Bearer {os.environ['PROSPECTAPIS_KEY']}"},
    timeout=30,
)
res.raise_for_status()
data = res.json()
print(data)

Billing

Billing reserves before it serves: the call holds what it may cost, serves at most what that hold covers, and refunds the rest when the response closes. Any non-2xx answer refunds the whole hold, so a failed call costs nothing. The response reports your balance in X-Credits-Remaining.

Related

Previous operation: Who viewed your profile (live). Next operation: Your post insights (live). Every operation, grouped by area, is on the API reference index.

Create a free account to get a key, then run the samples above with your own values.