profile.visitors
List the people who recently viewed the connected account's profile, cursor-paginated and classified by disclosure fidelity.
Prerequisites
- A Curviate API key, passed as
apiKeywhen you construct the client. Authentication and accounts shows how to create one. - A connected LinkedIn account. This resource is account-scoped: the
account_idis injected automatically by the account-scoped accessor, so you pass it once tocurviate.account(...)and every call below inherits it. Authentication and accounts covers connecting one, and accounts.list returns theaccount_idof each account already connected.
Signature
visitors(params?: ProfileVisitorListQuery): Promise<ProfileVisitorListPage>Example
import { Curviate } from "@curviate/sdk";
const curviate = new Curviate({
apiKey: "cvt_live_...",
baseUrl: "https://api.curviate.com",
});
const page = await curviate.account("acc_YOUR_ACCOUNT_ID").profile.visitors();
for (const item of page.items ?? []) {
console.log(item.member_id);
}
// `page.cursor` is the opaque cursor for the next page (null when exhausted).Parameters
| Name | Type | Required | Description |
|---|---|---|---|
limit | number | No | Maximum viewers to return in this page (1-100, default 20). The server may walk a few internal pages to fill one page, and never slices a fetched page down to a smaller limit, so the returned count can exceed this value; the response text says so and includes a cursor to continue when it does. |
cursor | string | No | Opaque pagination cursor from a prior response's cursor; omit for the first page. Zero individuals on a page does NOT mean the list is exhausted while cursor is non-null (an aggregate-only page may precede more identified viewers); page until cursor is null. Heavy pagination consumes a shared, throttled upstream request budget; you own the spend via the cursor. |
Returns
Resolves to ProfileVisitorListPage. Top-level fields: object, items, cursor.
Error codes
| Code | What it means, and what to do |
|---|---|
UNAUTHORIZED | The API key is missing, malformed, or revoked. Check the key you passed to the client. |
INVALID_REQUEST | A parameter failed validation. The message names the offending field; fix the request rather than retrying it. |
RATE_LIMIT_ACCOUNT | This account's own quota is exhausted. Wait for the window in the Retry-After header, then retry. |
RATE_LIMIT_TENANT | The tenant-wide quota is exhausted across all accounts. Slow the whole workload, not just this call. |
PLATFORM_RATE_LIMIT | LinkedIn is throttling this account. Back off well beyond the hinted delay; sustained pressure risks the account. |
PLATFORM_ERROR | A transient upstream failure. Retry once with backoff before treating it as a real error. |
ACCOUNT_NOT_FOUND | No connected account with that id belongs to this tenant. List your accounts to get a current id. |
RESOURCE_NOT_FOUND | The id in the path does not exist, or is not visible to this account. Re-read it from the list endpoint that produced it. |
Every code above is a stable CurviateError.code you can branch on. The full list, the response envelope, and retry semantics are in the Error codes reference.
Next steps
profile.analytics: Read the connected account's performance headline metrics, profile viewers, followers, post impressions, and search appearances.profile.ssi: Read the connected account's Social Selling Index, the overall score, its four pillar breakdowns, and industry/network percentile ranks.profile.subscription: Read the connected account's premium subscription: its full entitlement inventory, primary plan title, and LinkedIn management links.- SDK Quick Start: installation, the client, account scoping, and pagination.