> **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/youtube/videos/comments/analysis/get](https://www.socialfetch.dev/docs/api/v1/youtube/videos/comments/analysis/get) - **Markdown (.mdx) URL:** [https://www.socialfetch.dev/docs/api/v1/youtube/videos/comments/analysis/get.mdx](https://www.socialfetch.dev/docs/api/v1/youtube/videos/comments/analysis/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`). --- # Analyze YouTube video comments (https://www.socialfetch.dev/docs/api/v1/youtube/videos/comments/analysis/get) ## Summary Analyze YouTube video comments **Tags:** `YouTube` ## HTTP - **Method:** GET - **Path:** `/v1/youtube/videos/comments/analysis` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** HTTP only today - **Accepted identifiers:** `url` (query) - **Pagination:** none - **Business outcome field:** `data.lookupStatus` with values `found`, `not_found` ## Credits - **Base:** 2 credits per successful lookup. - **Maximum on success (200):** 2 credits. - **Normalization failure (502):** 0 credits charged. - **Authoritative field:** `meta.creditsCharged`. ## Authentication - **`x-api-key`**: API key (`sfk_...`) ## Parameters ### `url` (query) - **Required:** yes - **Constraints:** type `string`; minLength: 1; maxLength: 4096 - **Description:** Link to the YouTube video whose comments should be listed. ### `order` (query) - **Required:** no - **Constraints:** type `string`; enum: top, newest - **Description:** Comment sort order to analyze. Defaults to `top` for the strongest signal. ## Responses (status codes) - **200**: Comment frequency/ranking analysis for one page. - **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) Comment frequency/ranking analysis for one page. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **lookupStatus** (required) — type `string`; enum: found, not_found. Whether the video could be resolved for comment analysis. - **commentCount** (required) — type `integer`; minimum: 0. Comments analyzed from this page. - **totalLikes** (required) — type `integer`; minimum: 0 - **totalReplies** (required) — type `integer`; minimum: 0 - **avgLikes** (required) — type `number`; minimum: 0 - **questionCount** (required) — type `integer`; minimum: 0 - **creatorCommentCount** (required) — type `integer`; minimum: 0 - **verifiedCommentCount** (required) — type `integer`; minimum: 0 - **topComments** (required) — type `array`. Highest-liked comments from this page (desc), up to 8. - _items:_ - **id** (required) — type `string`; minLength: 1. Stable identifier for the comment. - **text** (required) — type `string`. Comment text. - **createdAt** (required) — type `string`. ISO-8601 timestamp when the comment was published. - **publishedTimeText** (required) — type `string`; nullable. Human-readable relative publish time when available. - **likeCount** (required) — type `integer`; minimum: 0. Like count on the comment. - **replyCount** (required) — type `integer`; minimum: 0. Direct reply count for the comment thread. - **repliesCursor** (required) — type `string`; nullable. Use as `cursor` on comment replies. Null when unavailable. - **author** (required) — type `object`. Comment author. - **handle** (required) — type `string`; minLength: 1. Public YouTube channel handle without a leading @. - **displayName** (required) — type `string`; nullable. Display name shown on the commenter channel. - **platformUserId** (optional) — type `string`. YouTube channel id when available. - **verified** (required) — type `boolean`. Whether the commenter channel is verified. - **creator** (required) — type `boolean`. Whether the commenter is the video creator. - **avatarUrl** (required) — type `string`; nullable. Profile image URL for the commenter when available. - **channelUrl** (required) — type `string`; nullable. Channel page URL when available. - **keywords** (required) — type `array`. Frequent content words from comment text (stopwords stripped), up to 12. - _items:_ - **word** (required) — type `string` - **count** (required) — type `integer`; minimum: 0 - **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", "commentCount": 3, "totalLikes": 47, "totalReplies": 3, "avgLikes": 16, "questionCount": 1, "creatorCommentCount": 0, "verifiedCommentCount": 0, "topComments": [ { "id": "2", "text": "What camera do you use?", "createdAt": "2024-01-01T00:00:00.000Z", "publishedTimeText": "1 day ago", "likeCount": 40, "replyCount": 3, "repliesCursor": null, "author": { "handle": "viewer", "displayName": "Viewer", "verified": false, "creator": false, "avatarUrl": null, "channelUrl": null } } ], "keywords": [ { "word": "cameras", "count": 2 } ] }, "meta": { "requestId": "req_01example", "creditsCharged": 2, "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.