accounts.metrics
The account's own numbers, one snapshot per day, oldest first: 1st-degree connections, followers, profile_viewers_90d, search_appearances_week, post_impressions_7d, and ssi (Sales Navigator accounts only, else null).
Prerequisites
- A Curviate API key, passed as
apiKeywhen you construct the client. Quickstart shows how to create one.
Signature
metrics(accountId: string, params?: AccountMetricsParams): Promise<AccountMetricList>Example
import { Curviate } from "@curviate/sdk";
const curviate = new Curviate({
apiKey: "cvt_live_...",
baseUrl: "https://api.curviate.com",
});
const { items } = await curviate.accounts.metrics("acc_123", { from: "2026-08-01", to: "2026-10-28" });Parameters
| Name | Type | Required | Description |
|---|---|---|---|
accountId | string | Yes | The account ID (acc_...). |
from | string | No | First day, YYYY-MM-DD (the account's local day of each snapshot). Default: 89 days before to. |
to | string | No | Last day, inclusive, YYYY-MM-DD. Default: today in timezone. At most 366 days from from. |
timezone | string | No | IANA zone today is read in for the default to, e.g. Europe/Berlin. Default: UTC. |
Returns
Resolves to AccountMetricList. Top-level fields: object, account_id, from, to, 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 | An upstream failure, usually transient: retry once with backoff before treating it as a real error. Check the response first, though. When it carries retry_likely_to_succeed: false and retry_hint: {kind: "never"}, retrying cannot help and backing off only delays the real answer. |
ACCOUNT_NOT_FOUND | No connected account with that id belongs to this tenant. List your accounts to get a current id. |
NO_ACTIVE_SEAT | The targeted account is not on an active seat. Buy or attach a seat in Billing, then retry. |
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. |
TEAM_REQUIRED | See the error codes reference. |
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
- Quickstart: connect a LinkedIn account. An empty account list means the key works and nothing is connected yet.
accounts.list: List the tenant's connected LinkedIn accounts, cursor-paginated.accounts.listSeats: List the workspace's live seats: each seat_id, whether an account occupied it, and that account_id (null when free).- SDK Quick Start: installation, the client, account scoping, and pagination.