> **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, 910 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`). --- # Compare saved queries' share of voice (https://www.socialfetch.dev/docs/api/v1/saved-queries/stats/compare/get) ## Summary Share of voice: 2 to 10 saved queries' posts over the same UTC days, each as a share of their sum, overall and per day. Free; nothing is searched. **Tags:** `Saved queries` ## HTTP - **Method:** GET - **Path:** `/v1/saved-queries/stats/compare` - **Base URL:** `https://api.socialfetch.dev` ## Capability summary - **SDK mapping:** HTTP only today - **Pagination:** none ## Credits - **Base:** 0 credits per successful lookup. - **Maximum on success (200):** 0 credits. - **Failed requests (`lookup_failed`, `503`):** not charged. - **Authoritative field:** `meta.creditsCharged`. ## Authentication - **`x-api-key`**: API key (`sfk_...`) ## Parameters ### `ids` (query) - **Required:** yes - **Constraints:** type `array` - **Description:** 2 to 10 saved query ids of this workspace, comma-separated (`sq_a,sq_b`) or repeated. A repeated id counts once. ### `days` (query) - **Required:** no - **Constraints:** type `integer`; minimum: 1; maximum: 90 - **Description:** UTC days to count, today (the day of `now`) included, from 1 to 90. Default 30. ### `now` (query) - **Required:** no - **Constraints:** type `string` - **Description:** The window's last day is this time's UTC day, ISO 8601. Default: now. Send the same value to read the same window again. ## Responses (status codes) - **200**: Each saved query's posts and share over the window. - **400**: Fewer than 2 or more than 10 ids, or invalid days or now. - **401**: Missing or invalid API key - **403**: The caller's role in this workspace can't manage its saved queries. - **404**: A saved query not found, or not owned by this workspace. - **500**: Unexpected error ## Response body (200) Each saved query's posts and share over the window. ### Field outline - **data** (required) — type `object`. Endpoint-specific response payload. - **window** (required) — type `object`. The window: whole UTC days, oldest first. - **days** (required) — type `integer`. UTC days in the window. - **from** (required) — type `string`. The first day's midnight, UTC, ISO 8601 (included). - **to** (required) — type `string`. The midnight after the last day, UTC, ISO 8601 (not included). - **posts** (required) — type `integer`. All the compared queries' posts in the window: the sum of theirs, so a post two queries matched counts twice. - **queries** (required) — type `array`. Each query, in the order the ids were sent. - _items:_ - **savedQueryId** (required) — type `string` - **name** (required) — type `string` - **posts** (required) — type `integer`. Its posts in the window, by when they were posted. Posts the platform gave no time for aren't counted. - **stories** (required) — type `integer`. Of those, the stories: a post and its reposts and near-copies (`duplicateOf`) count once. - **share** (required) — type `number`; minimum: 0; maximum: 1. This query's posts over all the compared queries' posts, from 0 to 1; 0 when none has any. While any has posts, the shares add up to 1, to within rounding. `posts` here is the sum of the query's `daily` posts from GET /v1/saved-queries/{id}/stats over the same window. - **daily** (required) — type `array`. Every day in the window, oldest first, with zeros for a day without posts. - _items:_ - **day** (required) — type `string`. `YYYY-MM-DD`, UTC. - **posts** (required) — type `integer`. All the compared queries' posts that day. - **queries** (required) — type `array`. Each query's posts that day, in the order sent. - _items:_ - **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. ### Example JSON (derived from schema) ```json { "data": { "window": { "days": 0, "from": "string", "to": "string" }, "posts": 0, "queries": [ { "savedQueryId": "string", "name": "string", "posts": 0, "stories": 0, "share": 0 } ], "daily": [ { "day": "string", "posts": 0, "queries": [ { "savedQueryId": "string", "posts": 0, "share": 0 } ] } ] }, "meta": { "requestId": "string", "creditsCharged": 0, "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**: Fewer than 2 or more than 10 ids, or invalid days or now. **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. - **403**: The caller's role in this workspace can't manage its saved queries. - **404**: A saved query not found, or not owned by this workspace. - **500**: Unexpected error ### 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.