> **For coding agents and LLMs:** This is one page from the Social Fetch docs (markdown export). For curated orientation and workflow guidance, start with [`/llms.txt`](https://www.socialfetch.dev/llms.txt); for agent onboarding and crawl rules, use [`/agents.txt`](https://www.socialfetch.dev/agents.txt); for the full endpoint list with links to pages like this one, use [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt); for one platform's parameters and curls, use [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt); use [`/llms.json`](https://www.socialfetch.dev/llms.json) when you need structured JSON for tool registration. ## This page - **On-site (HTML):** [https://www.socialfetch.dev/docs/api/v1/tiktok/profiles/handle/engagement/get](https://www.socialfetch.dev/docs/api/v1/tiktok/profiles/handle/engagement/get) - **Markdown (.mdx) URL:** [https://www.socialfetch.dev/docs/api/v1/tiktok/profiles/handle/engagement/get.mdx](https://www.socialfetch.dev/docs/api/v1/tiktok/profiles/handle/engagement/get.mdx) ## API base URL and authentication - **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev` - **Authentication:** send `x-api-key: sfk_...` on `/v1/**` routes unless the operation is explicitly anonymous (check OpenAPI `security`, the [API reference hub](https://www.socialfetch.dev/docs/api.mdx), [`/llms.txt`](https://www.socialfetch.dev/llms.txt), or [`/llms.json`](https://www.socialfetch.dev/llms.json) for each route). - **OpenAPI JSON:** [https://www.socialfetch.dev/openapi.json](https://www.socialfetch.dev/openapi.json) ## Recommended docs entrypoints (this site) - [Documentation overview](https://www.socialfetch.dev/docs.mdx) — top-level orientation (markdown). - [Quickstart](https://www.socialfetch.dev/docs/quickstart.mdx) — authenticate with `x-api-key`, validate auth with `whoami`, and understand the JSON envelope. - [SDK](https://www.socialfetch.dev/docs/sdk.mdx) — official TypeScript SDK guide, including `SocialFetchClient`, `Result`, and `unwrap()`. - [SDK reference](https://www.socialfetch.dev/docs/sdk-reference.mdx) — exhaustive SDK method inventory and route mapping for agents, tooling, and power users. - [Choose the right endpoint](https://www.socialfetch.dev/docs/choose-endpoint.mdx) — task-oriented route selection for smoke tests, profiles, list endpoints, and single-item lookups. - [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — fast comparison of identifiers, pagination, outcomes, media download, and SDK coverage. - [Recipes](https://www.socialfetch.dev/docs/recipes.mdx) — copyable workflows (brand monitoring, transcripts, Ad Library, creator scoring, Reddit research) with credit callouts and SDK examples. - [Integrations](https://www.socialfetch.dev/docs/integrations.mdx) — MCP for AI clients, n8n verified node, Apify Store Actors, SDK, and REST API connection paths. - [MCP product page](https://www.socialfetch.dev/mcp) — hosted MCP overview, OAuth, Skills install. - [MCP integration](https://www.socialfetch.dev/docs/integrations/mcp.mdx) — hosted `/mcp` server, OAuth, Cursor/VS Code/Claude install snippets, 162 endpoint tools, plus docs_search/docs_read for implementation help. - [n8n integration](https://www.socialfetch.dev/docs/integrations/n8n.mdx) — install `n8n-nodes-socialfetch`, credentials, and workflow examples. - [Apify integration](https://www.socialfetch.dev/docs/integrations/apify.mdx) — Store Actors under @social-fetch, PPE billing, dataset export, and quick start. - [`/llms-endpoints.txt`](https://www.socialfetch.dev/llms-endpoints.txt) — every documented operation with a direct link to that route's agent-readable markdown page (prefer this over parsing OpenAPI). - [`/llms-{platform}.txt`](https://www.socialfetch.dev/llms-tiktok.txt) — per-platform endpoint files generated from OpenAPI (parameters, credits, curls). - [`/agents.txt`](https://www.socialfetch.dev/agents.txt) — agent crawl/onboarding file with capabilities, auth rules, and allowlist. - [`/llms.json`](https://www.socialfetch.dev/llms.json) — structured machine-readable operation inventory with parameter names, pagination, outcomes, credits, and SDK mapping. - [API reference hub](https://www.socialfetch.dev/docs/api.mdx) — human-friendly index of operations with links into generated pages. - [Errors](https://www.socialfetch.dev/docs/errors.mdx) — shared error envelope and HTTP status guidance. - [Credits](https://www.socialfetch.dev/docs/credits.mdx) — metering, `402`, and planning batch jobs. - Outcome semantics such as `found`, `not_found`, and `private` are documented in [Errors](https://www.socialfetch.dev/docs/errors.mdx) and on operation pages when present in the OpenAPI contract. ## Markdown docs convention - Every docs page has a markdown twin: append **`.mdx`** to the docs pathname (for example `/docs/quickstart` → `/docs/quickstart.mdx`). - Agents that send `Accept: text/markdown` on `/docs/**` HTML URLs may receive markdown directly (same URL, `Vary: Accept`). --- # Get TikTok profile engagement audit (https://www.socialfetch.dev/docs/api/v1/tiktok/profiles/handle/engagement/get) ## Summary Get TikTok profile engagement audit **Tags:** `TikTok` ## HTTP - **Method:** GET - **Path:** `/v1/tiktok/profiles/{handle}/engagement` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** HTTP only today - **Accepted identifiers:** `handle` (path) - **Pagination:** none - **Business outcome field:** `data.lookupStatus` with values `found`, `private`, `not_found` ## Credits - **Base:** 5 credits per successful lookup. - **Maximum on success (200):** 5 credits. - **Normalization failure (502):** 0 credits charged. - **Authoritative field:** `meta.creditsCharged`. ## Authentication - **`x-api-key`**: API key (`sfk_...`) ## Parameters ### `handle` (path) - **Required:** yes - **Constraints:** type `string`; minLength: 1; maxLength: 128 - **Description:** TikTok handle to look up, with or without a leading @. ## Responses (status codes) - **200**: Engagement-rate audit computed from recent videos. - **400**: Invalid request - **401**: Missing or invalid API key - **402**: Insufficient credits - **500**: Unexpected or billing error - **502**: Lookup could not be completed from the response (unexpected or invalid data). - **503**: Service temporarily unavailable; safe to retry with backoff. ## Response body (200) Engagement-rate audit computed from recent videos. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, private, not_found. Whether the profile was resolved. Engagement cannot be calculated for private or not-found profiles. - **canCalculateEngagement** (required) — type `boolean` - **profile** (required) — type `object`; nullable - **handle** (required) — type `string` - **displayName** (required) — type `string`; nullable - **bio** (required) — type `string`; nullable - **avatarUrl** (required) — type `string`; nullable - **verified** (required) — type `boolean` - **profileUrl** (required) — type `string` - **privateAccount** (required) — type `boolean` - **metrics** (required) — type `object` - **followers** (required) — type `number`; nullable - **averageEngagementRatePercent** (required) — type `number`; nullable - **medianEngagementRatePercent** (required) — type `number`; nullable - **averageLikesPerVideo** (required) — type `number`; nullable - **averageCommentsPerVideo** (required) — type `number`; nullable - **averageSharesPerVideo** (required) — type `number`; nullable - **averageViewsPerVideo** (required) — type `number`; nullable - **commentToLikeRatio** (required) — type `number`; nullable - **engagementVolatilityPercent** (required) — type `number`; nullable - **bestVideoId** (required) — type `string`; nullable - **worstVideoId** (required) — type `string`; nullable - **qualityLabel** (required) — type `string`; enum: excellent, strong, moderate, low, directional, null; nullable. Rough directional band by follower size — not an industry benchmark. - **qualityLabelNote** (required) — type `string`; nullable - **videos** (required) — type `array` - _items:_ - **id** (required) — type `string` - **caption** (required) — type `string`; nullable - **createdAt** (required) — type `string`; nullable - **likeCount** (required) — type `number`; nullable - **commentCount** (required) — type `number`; nullable - **shareCount** (required) — type `number`; nullable - **saveCount** (required) — type `number`; nullable - **viewCount** (required) — type `number`; nullable - **engagementRatePercent** (required) — type `number`; nullable. (likes + comments + shares) / followers * 100. - **isOutlierHigh** (required) — type `boolean` - **isOutlierLow** (required) — type `boolean` - **skipReason** (required) — type `string`; nullable - **videoUrl** (required) — type `string`; nullable - **pinned** (required) — type `boolean` - **sampleCoverage** (required) — type `object`. How many of the recent videos had usable engagement counts. - **totalRecentVideos** (required) — type `integer`; minimum: 0 - **usableVideos** (required) — type `integer`; minimum: 0 - **skippedVideos** (required) — type `integer`; minimum: 0 - **skippedReasons** (required) — type `object` - **missingLikes** (required) — type `integer`; minimum: 0 - **missingComments** (required) — type `integer`; minimum: 0 - **missingShares** (required) — type `integer`; minimum: 0 - **missingMultiple** (required) — type `integer`; minimum: 0 - **formulaDescription** (required) — type `string` - **dataFreshnessNote** (required) — type `string`; nullable - **insight** (required) — type `object`; nullable. Best-effort AI-generated narrative over the audit. Null when generation was unavailable or failed — never blocks or fails the request. - **headlineInsight** (required) — type `string` - **engagementAssessment** (required) — type `string` - **contentPatternObservations** (required) — type `array` - _items:_ - type `string` - **risksAndCaveats** (required) — type `array` - _items:_ - type `string` - **recommendedExperiments** (required) — type `array` - _items:_ - type `string` - **apiUseCaseTeaser** (required) — type `string` - **meta** (required) — type `object`. Metadata describing the request and billing outcome. - **requestId** (required) — type `string`; minLength: 1. Unique request identifier for tracing this API call. - **creditsCharged** (required) — type `integer`; minimum: 0. Credits charged for this request. - **version** (required) — type `string`; enum: v1. Public API version that served the response. - **cached** (optional) — type `boolean`. True when served from shared response cache. Credits still apply (full endpoint price); Age header may be present. ### Example JSON (found) ```json { "data": { "lookupStatus": "found", "canCalculateEngagement": true, "profile": { "handle": "creator", "displayName": "Creator", "bio": "Making things.", "avatarUrl": "https://example.com/avatar.jpg", "verified": false, "profileUrl": "https://www.tiktok.com/@creator", "privateAccount": false }, "metrics": { "followers": 10000, "averageEngagementRatePercent": 4.25, "medianEngagementRatePercent": 4.25, "averageLikesPerVideo": 350, "averageCommentsPerVideo": 40, "averageSharesPerVideo": 35, "averageViewsPerVideo": 40000, "commentToLikeRatio": 0.11, "engagementVolatilityPercent": 12.5, "bestVideoId": "1", "worstVideoId": "2", "qualityLabel": "moderate", "qualityLabelNote": null }, "videos": [ { "id": "1", "caption": "Example caption", "createdAt": "2024-01-01T00:00:00.000Z", "likeCount": 400, "commentCount": 50, "shareCount": 50, "saveCount": 10, "viewCount": 50000, "engagementRatePercent": 5, "isOutlierHigh": true, "isOutlierLow": false, "skipReason": null, "videoUrl": "https://www.tiktok.com/@creator/video/1", "pinned": false } ], "sampleCoverage": { "totalRecentVideos": 2, "usableVideos": 2, "skippedVideos": 0, "skippedReasons": { "missingLikes": 0, "missingComments": 0, "missingShares": 0, "missingMultiple": 0 } }, "formulaDescription": "Engagement rate = (likes + comments + shares) ÷ followers × 100, averaged across recent videos with visible counts.", "dataFreshnessNote": "Based on recent videos from 2024-01-01.", "insight": { "headlineInsight": "Engagement is moderate for an account this size, driven by one standout video.", "engagementAssessment": "Average engagement rate sits at 4.25%, within the moderate band for a 10k-follower account.", "contentPatternObservations": [ "The best-performing video nearly doubled the account average." ], "risksAndCaveats": [ "Only two recent videos had visible counts — treat this as directional." ], "recommendedExperiments": [ "Post at the same time of day as the top video." ], "apiUseCaseTeaser": "Run this audit across a creator shortlist automatically with the Social Fetch API." } }, "meta": { "requestId": "req_01example", "creditsCharged": 5, "version": "v1" } } ``` ### Machine-readable error codes When an error JSON body is returned, it may include one of these `error.code` values (derived from the OpenAPI schemas for this operation; additional codes may exist at runtime): - `bad_request` ## Error handling & retries Interpret HTTP status codes using the descriptions below. Do not assume a JSON body unless the OpenAPI schema defines one for that status. - **400**: Invalid request **Retry:** Fix the request; retrying the same invalid payload will not help. - **401**: Missing or invalid API key **Retry:** Fix the API key first; retrying without changes will not help. - **402**: Insufficient credits **Retry:** Do not retry without resolving billing/credits (retrying the same request will not help). - **500**: Unexpected or billing error - **502**: Lookup could not be completed from the response (unexpected or invalid data). **Retry:** May be transient; a few retries with backoff are reasonable. - **503**: Service temporarily unavailable; safe to retry with backoff. **Retry:** Usually safe to retry with exponential backoff and jitter. ### Suggested client defaults - Send the API key using the `x-api-key` header on every request. - On `503` (and sometimes `502`), retry with backoff; cap retries and surface a clear error to the user. - On `402`, surface an actionable billing message rather than blind retries.