> **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):** - **Markdown (.mdx) URL:** ## API base URL and authentication - **API origin (from OpenAPI `servers`):** `https://api.socialfetch.dev` - **Authentication:** send `x-api-key: sfk_...` on `/v1/**` and `/v2/**` 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:** ## 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()`. - [Capability matrix](https://www.socialfetch.dev/docs/capability-matrix.mdx) — every operation with identifiers, pagination, outcomes, media download, credits, and its SDK method. Generated from OpenAPI, so use it for route selection instead of scanning individual pages. - [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, Make custom app, 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, 264 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. - [Make integration](https://www.socialfetch.dev/docs/integrations/make.mdx) — custom app modules for Make scenarios, API key credentials, and module catalog. - [`/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`). - Published blog posts use the same convention: `/blog/{slug}` → `/blog/{slug}.mdx`, or `Accept: text/markdown` on the HTML URL (`Vary: Accept`). --- # Get Instagram profile engagement audit (https://www.socialfetch.dev/docs/api/v2/instagram/profiles/profile/engagement/get) ## Summary Get an engagement audit of an Instagram profile's recent posts by handle, profile URL or user id. **Tags:** `Instagram` ## HTTP - **Method:** GET - **Path:** `/v2/instagram/profiles/{profile}/engagement` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** `client.instagram.getProfileEngagementV2({ profile })` - **Pagination:** none - **Business outcome field:** `data.lookupStatus` with values `found`, `private`, `not_found` ## Agent notes - **Disambiguation:** An engagement-rate audit of a profile's latest posts (up to 12), for a handle, a profile URL or a numeric user id. Each sample post is the same media object every v2 endpoint returns, with its engagement rate beside it. - **Empty results:** Check `data.lookupStatus` and `data.audit.canCalculateEngagement`: a private or missing profile has no audit to calculate (empty `posts`, null rates, no written summary) and costs 1 credit instead of 5, and `profile` is null when it is not found. `audit.insight` is also null when the written summary could not be generated; the rest of the audit stands. ## Credits - 5 credits for an audited profile - 1 credit when the profile is private or not found ## Authentication - **`x-api-key`**: API key (`sfk_...`) ## Parameters ### `profile` (path) - **Required:** yes - **Constraints:** type `string` - **Description:** Handle, profile URL or numeric user id. ## Responses (status codes) - **200**: Engagement-rate audit computed from recent posts. - **400**: Invalid profile or query parameter - **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 posts. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, private, not_found. `found` (an audited profile, 5 credits); `private` or `not_found` (nothing to audit, 1 credit). - **profile** (required) — type `object`; nullable. The profile. Null when not found. - **id** (required) — type `string`; pattern: `^\d+$`; nullable. Instagram user id. - **handle** (required) — type `string`; nullable. Username, without @. - **displayName** (required) — type `string`; nullable. Display name. - **avatarUrl** (required) — type `string`; nullable. Profile picture. Instagram CDN URL; it expires after a while. - **verified** (required) — type `boolean`; nullable. Whether the account is verified. - **privateAccount** (required) — type `boolean`; nullable. Whether the account is private. - **audit** (required) — type `object`. The engagement-rate audit. - **canCalculateEngagement** (required) — type `boolean`. False for a private or missing profile, and when the follower count isn't available. - **metrics** (required) — type `object` - **followers** (required) — type `number`; nullable - **averageEngagementRatePercent** (required) — type `number`; nullable - **medianEngagementRatePercent** (required) — type `number`; nullable - **averageLikesPerPost** (required) — type `number`; nullable - **averageCommentsPerPost** (required) — type `number`; nullable - **commentToLikeRatio** (required) — type `number`; nullable - **engagementVolatilityPercent** (required) — type `number`; nullable - **bestPostShortcode** (required) — type `string`; nullable - **worstPostShortcode** (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 - **posts** (required) — type `array`. The latest posts the audit sampled (up to 12), newest first. Empty when engagement can't be calculated. - _items:_ - **contentSegments** (required) — type `array`. Average rate by post type. Empty when engagement can't be calculated. - _items:_ - **sampleCoverage** (required) — type `object`. How many of the recent posts had usable engagement counts. - **totalRecentPosts** (required) — type `integer`; minimum: 0 - **usablePosts** (required) — type `integer`; minimum: 0 - **skippedPosts** (required) — type `integer`; minimum: 0 - **skippedReasons** (required) — type `object` - **formulaDescription** (required) — type `string`. How the rate is computed. - **dataFreshnessNote** (required) — type `string`; nullable. The dates the sample covers. Null without posts. - **insight** (required) — type `object`; nullable. Best-effort AI narrative over the audit. Null for a private or missing profile, and when generation was unavailable or failed; it 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 about the API response. - **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: v2. Public API version that served the response. ### Example JSON (found) ```json { "data": { "lookupStatus": "found", "profile": { "id": "13460080", "handle": "nike", "displayName": "Nike", "avatarUrl": "https://scontent.cdninstagram.com/v/t51.2885-15/c6787266b032.jpg?stp=example", "verified": true, "privateAccount": false }, "audit": { "canCalculateEngagement": true, "metrics": { "followers": 290980671, "averageEngagementRatePercent": 0.25, "medianEngagementRatePercent": 0.03, "averageLikesPerPost": 715577, "averageCommentsPerPost": 2480, "commentToLikeRatio": 0, "engagementVolatilityPercent": 130, "bestPostShortcode": "DePopGlnxXJ", "worstPostShortcode": "DeXh9YDSac8", "qualityLabel": "low", "qualityLabelNote": "Below typical ranges for accounts of this size — verify with more posts or a longer window." }, "posts": [ { "media": { "id": "4005819746817255228", "shortcode": "DeXh9YDSac8", "url": "https://www.instagram.com/p/DeXh9YDSac8/", "kind": "post", "mediaType": "image", "caption": "@zhengqinwen_tennis claims her first WTA 1000 title in Beijing. A winner’s name, etched on home soil.", "altText": null, "createdAt": "2026-10-11T20:36:14.000Z", "owner": { "id": "13460080", "handle": "nike", "displayName": "Nike", "avatarUrl": "https://scontent.cdninstagram.com/v/t51.2885-15/7550c657d356.jpg?stp=example", "verified": true, "privateAccount": false }, "metrics": { "likeCount": 41228, "commentCount": 406, "playCount": null, "shareCount": 858, "saveCount": null, "likesHidden": false }, "imageUrl": "https://scontent.cdninstagram.com/v/t51.2885-15/ef17bf7a3959.jpg?stp=example", "thumbnailUrl": "https://scontent.cdninstagram.com/v/t51.2885-15/b6a0e1d8230b.jpg?stp=example", "videoUrl": null, "durationSec": null, "dimensions": { "width": 2700, "height": 3375 }, "carousel": null, "audio": null, "coauthors": [ { "id": "2346946227", "handle": "zhengqinwen_tennis", "displayName": "Zheng Qinwen", "avatarUrl": "https://scontent.cdninstagram.com/v/t51.2885-15/0ebc7d9001d1.jpg?stp=example", "verified": true, "privateAccount": false } ], "taggedUsers": [ { "id": "2346946227", "handle": "zhengqinwen_tennis", "displayName": "Zheng Qinwen", "avatarUrl": "https://scontent.cdninstagram.com/v/t51.2885-15/0ebc7d9001d1.jpg?stp=example", "verified": true, "privateAccount": false } ], "location": null, "isPaidPartnership": false, "sponsors": [], "commentsDisabled": false, "isPinned": false, "story": null }, "engagementRatePercent": 0.01, "isOutlierHigh": false, "isOutlierLow": false, "skipReason": null } ], "contentSegments": [ { "mediaType": "video", "postCount": 1, "averageEngagementRatePercent": 0.03 } ], "sampleCoverage": { "totalRecentPosts": 3, "usablePosts": 3, "skippedPosts": 0, "skippedReasons": { "missingLikes": 0, "missingComments": 0, "missingBoth": 0 } }, "formulaDescription": "Engagement rate = (likes + comments) ÷ followers × 100, averaged across recent posts with visible counts.", "dataFreshnessNote": "Based on recent posts between 2026-10-08 and 2026-10-11.", "insight": { "headlineInsight": "Engagement is low for an account of this size, and one carousel carries most of it.", "engagementAssessment": "The 3 sampled posts average a 0.25% engagement rate against about 291 million followers, with a median of 0.03%. The carousel reached about 0.7%, while the photo and the Reel stayed near 0.01% to 0.03%.", "contentPatternObservations": [ "The carousel earned the highest rate in the sample; the Reel and the photo were far behind it." ], "risksAndCaveats": [ "Only 3 posts were sampled, so treat the rates as directional." ], "recommendedExperiments": [ "Publish more carousels and compare their rate with single photos." ], "apiUseCaseTeaser": "Run this audit across a creator shortlist automatically with the Social Fetch API." } } }, "meta": { "requestId": "req_01example_instagram_engagement_v2", "creditsCharged": 5, "version": "v2" } } ``` ### 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 profile or query parameter **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. ## Examples ### TypeScript SDK ```typescript import { SocialFetchClient } from "@socialfetch/sdk"; const client = new SocialFetchClient({ apiKey: process.env.SOCIALFETCH_API_KEY!, }); const result = await client.instagram.getProfileEngagementV2({ profile: "nike", }); if (!result.ok) { console.error(result.error); } else { console.log(result.value.data); } ``` ### Node.js ```javascript const response = await fetch( "https://api.socialfetch.dev/v2/instagram/profiles/nike/engagement", { headers: { "x-api-key": "YOUR_API_KEY" } } ); const data = await response.json(); console.log(data); ``` ### cURL ```bash curl "https://api.socialfetch.dev/v2/instagram/profiles/nike/engagement" \ -H "x-api-key: YOUR_API_KEY" ``` ### Python ```python import requests response = requests.get( "https://api.socialfetch.dev/v2/instagram/profiles/nike/engagement", headers={"x-api-key": "YOUR_API_KEY"}, ) data = response.json() print(data) ```