{ "openapi": "3.0.1", "info": { "title": "Developer Community Listening — Stack Exchange, Lemmy, Mastodon", "description": "Track a brand, product or topic across developer communities in one run: Stack Exchange questions, Lemmy posts and Mastodon hashtag activity, merged into one schema with text, direct link, author, community and engagement numbers. Official/open APIs, no key needed.", "version": "0.1", "x-build-id": "wuV3Z08VteHbF6FWf" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/foxlabs~community-listening/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-foxlabs-community-listening", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/foxlabs~community-listening/runs": { "post": { "operationId": "runs-sync-foxlabs-community-listening", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/foxlabs~community-listening/run-sync": { "post": { "operationId": "run-sync-foxlabs-community-listening", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "query" ], "properties": { "query": { "title": "Search term", "type": "string", "description": "The brand, product, competitor or topic to track — e.g. \"supabase\", \"clickhouse\", \"self-hosted\". Used as the search phrase on Stack Exchange and Lemmy, and as the hashtag on Mastodon unless you set one below." }, "sources": { "title": "Sources", "type": "array", "description": "Which communities to listen to. Every source returns rows in the same shape, tagged with `source`, so you can filter afterwards.", "items": { "type": "string", "enum": [ "stackexchange", "lemmy", "mastodon" ], "enumTitles": [ "Stack Exchange (Stack Overflow & network)", "Lemmy", "Mastodon (hashtags)" ] }, "default": [ "stackexchange", "lemmy", "mastodon" ] }, "datePreset": { "title": "Time window", "enum": [ "last_7_days", "last_30_days", "last_90_days", "last_year", "all_time" ], "type": "string", "description": "How far back to look. Default is all time WITH newest-first sorting, which gives you the most recent mentions without hiding a thin week — Stack Overflow question volume for a single product can be as low as a couple of posts a month (measured: 2 for \"supabase\" in 30 days). Narrow the window when you specifically want strict recency.", "default": "all_time" }, "sortBy": { "title": "Sort by", "enum": [ "newest", "votes", "activity" ], "type": "string", "description": "Newest first for monitoring, most-voted for the discussions that mattered, activity for threads still moving.", "default": "newest" }, "stackExchangeSites": { "title": "Stack Exchange sites", "type": "array", "description": "Which sites in the Stack Exchange network to search — e.g. [\"stackoverflow\", \"serverfault\", \"dba\", \"security\"]. Each site is searched separately. Leave empty for Stack Overflow only.", "default": [], "items": { "type": "string" } }, "lemmyInstance": { "title": "Lemmy instance", "type": "string", "description": "Which Lemmy server to search. Defaults to lemmy.world, the largest general instance; use a niche instance to target its communities.", "default": "lemmy.world" }, "mastodonInstance": { "title": "Mastodon instance", "type": "string", "description": "Which Mastodon server's hashtag timeline to read. Defaults to mastodon.social; instances federate, so a large one sees most public posts.", "default": "mastodon.social" }, "mastodonHashtags": { "title": "Mastodon hashtags", "type": "array", "description": "Hashtags to follow, without the #. Leave empty to use the search term itself. Note: Mastodon's full-text search needs an account token, so this Actor reads hashtag timelines — posts that mention your brand without a hashtag won't appear.", "default": [], "items": { "type": "string" } }, "stackExchangeKey": { "title": "Stack Exchange API key (optional)", "type": "string", "description": "Without a key Stack Exchange allows ~300 requests/day per IP; a free key raises it to 10,000/day and lets big sweeps run faster. Get one at stackapps.com — no approval needed." }, "maxResults": { "title": "Max results", "minimum": 0, "type": "integer", "description": "Hard cap on mentions returned across all sources. The budget is shared evenly between the sources you selected — and whatever one source doesn't use passes to the others — so a busy source can't crowd out the rest. Set 0 for unlimited.", "default": 500 } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }