Insights
What we hold on a handle, before you pay for a lookup
/data-api/v2/insights/tiktok/{handle}/coverage- Scope
- insights:read
- Freshness
- catalog read
- Group
- Insights
- Platforms
- 1 of 7
What this endpoint answers
Counts what the catalog holds for one TikTok handle - snapshots, rollup days, suggested-account edges - and lists which endpoints will return real data for it. Reads the catalog only and never touches an upstream, so it is not metered as a live call.
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
- holdings.posts is always null for TikTok. The engine holds no post table for this platform at all, and null says we do not measure it rather than reporting a count of zero. The same field carries a real count on the Instagram counterpart, which shares this response shape.
- Snapshot depth is bimodal and worth checking before reading a growth series: about 2,900 accounts hold 40 or more snapshots while 13,080 hold fewer than 10.
- When every snapshot held for an account predates the 2026-08-24 statsV2 cutover, unavailable_endpoints carries a separate entry saying the series is readable but its follower and like velocity will not be.
- Built for the decision a caller makes before spending a live call: ask what a catalog read would give you, then decide whether a live fetch is worth the meter.
Parameters
Every value the call accepts, with the example the spec ships so the request runs as written.
| Name | In | Required | Example | What it does |
|---|---|---|---|---|
handle | path | required | mohsinbahim | TikTok handle, without the @. |
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 "https://crmsolid.com/data-api/v2/insights/tiktok/mohsinbahim/coverage" \
-H "Authorization: Bearer psk_live_..."
const res = await fetch("https://crmsolid.com/data-api/v2/insights/tiktok/mohsinbahim/coverage", {
headers: {
Authorization: `Bearer ${process.env.CRM_SOLID_DATA_API_KEY}`,
},
});
if (!res.ok) {
const { error } = await res.json();
throw new Error(`${error.code}: ${error.message} (${error.request_id})`);
}
const { data, meta } = await res.json();
import os
import requests
res = requests.get(
"https://crmsolid.com/data-api/v2/insights/tiktok/mohsinbahim/coverage",
headers={"Authorization": f"Bearer {os.environ['CRM_SOLID_DATA_API_KEY']}"},
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.
- Handle
- mohsinbahim
- Platform
- tiktok
- In catalog
- yes
- User id
- 6743139527352910850
- Profile complete
- yes
- Crawled at
- 8/30/2026, 10:39:28 PM
- Data age s
- 50,713
- First seen
- 6/24/2026, 11:14:48 PM
- Followers
- 628,510
- Holdings snapshots
- 50
- Holdings snapshots from
- 6/24/2026, 11:14:48 PM
- Holdings snapshots to
- 8/30/2026, 10:39:28 PM
- Holdings daily stat days
- 50
- Holdings edges out
- 0
- Holdings edges in
- 0
- Available endpoints
- /insights/tiktok/{handle}/growth, /insights/tiktok/{handle}/activity, /accounts/tiktok/{handle}
{
"data": {
"handle": "mohsinbahim",
"platform": "tiktok",
"in_catalog": true,
"user_id": "6743139527352910850",
"profile_complete": true,
"crawled_at": "2026-08-30T22:39:28.448Z",
"data_age_s": 50713,
"first_seen": "2026-06-24T23:14:48.552Z",
"followers": 628510,
"holdings": {
"posts": null,
"posts_from": null,
"posts_to": null,
"snapshots": 50,
"snapshots_from": "2026-06-24T23:14:48.553Z",
"snapshots_to": "2026-08-30T22:39:28.441Z",
"daily_stat_days": 50,
"edges_out": 0,
"edges_in": 0
},
"available_endpoints": [
"/insights/tiktok/{handle}/growth",
"/insights/tiktok/{handle}/activity",
"/accounts/tiktok/{handle}"
],
"unavailable_endpoints": []
},
"meta": {
"request_id": "req_9f2c41a8b3d5",
"generated_at": "2026-08-23T09:14:02.317Z",
"took_ms": 42
}
}
The meta block
request_idstringrequiredUnique id for this request. Quote it in a support ticket.
generated_atstringrequiredServer time the response was produced.
took_msintegerrequiredMilliseconds spent server-side.
pagePageoptionalsourcestringoptionalWhich backend served the payload, for endpoints with more than one.
cache_age_sintegeroptionalAge of the underlying data in seconds. 0 for live reads.
When it fails
GET /insights/tiktok/{handle}/coverage documents 8 failure statuses. Branch on error.code, which is stable and enumerated; message is prose and may change.
- 401Unauthorized
unauthorized | invalid_keyNo key was presented, or the key is unknown, revoked or expired.
- 402PaymentRequired
payment_required | subscription_inactiveThe 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.
- 403Forbidden
forbidden_scope | forbidden_ipThe 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.
- 404NotFound
not_foundThe addressed resource does not exist.
- 422InvalidRequest
invalid_requestA parameter is malformed, out of range or mutually exclusive with another. `details` names the offending fields.
- 429RateLimited
rate_limited | quota_exceededEither 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.
- 500InternalError
internal_errorSomething failed on our side. Internals are never leaked; quote the request id.
- 503Unavailable
upstream_timeout | upstream_error | not_configuredThe 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 TikTok. Rate limits come from the tier on your key.
| 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.
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.
Reference path: /data-api/reference/insights-tiktok-coverage