{ "openapi": "3.0.1", "info": { "title": "Social Listening API - Mentions Export, Sentiment, SentiOne", "description": "Export social listening mentions from your own SentiOne Listen projects: posts, comments, articles and reviews from social media, news, blogs, forums and video, with sentiment, author, followers, engagement, language and location. Recent, historical and stream export. Read only. Bring your own key.", "version": "0.1", "x-build-id": "g7fNxc6nD65hb5CYs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~social-listening-mentions-export-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-social-listening-mentions-export-api", "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/nabeelbaghoor~social-listening-mentions-export-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-social-listening-mentions-export-api", "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/nabeelbaghoor~social-listening-mentions-export-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-social-listening-mentions-export-api", "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", "properties": { "mode": { "title": "What to read", "enum": [ "projects", "recentMentions", "historicalMentions", "exportHistorical", "exportRecent", "discussionRecent", "discussionHistorical", "mentionById", "parentMention" ], "type": "string", "description": "Projects lists the Listen projects your key reaches and needs nothing else, so it is the default: it gives the project IDs the other modes use. Recent mentions pages through the last 7 days of one project (free Basic API tier). Historical mentions pages through any period (Enterprise tier). The two export stream modes read the same mentions as one fast stream for large volumes (Enterprise tier). The discussion modes read one thread, a post with its comments. The mention modes look mentions, or the post a comment replies to, up by ID.", "default": "projects" }, "projectId": { "title": "Project ID", "type": "string", "description": "Mention and export modes. The numeric ID of one Listen project, as the projects mode lists it. Optional when your key reaches only one project. In the projects mode it reads just that project." }, "query": { "title": "Search query", "type": "string", "description": "Optional Listen Query Language filter on the mention text, up to 500 characters: AND, OR, NOT, parentheses, \"exact phrases\" and word* wildcards (4 or more letters before the asterisk). Example: \"customer service\" AND (slow OR rude) NOT job*" }, "lastDays": { "title": "Last days", "minimum": 1, "maximum": 36500, "type": "integer", "description": "Read mentions from this many days back until now. Recent modes see at most 7 days. Ignored when a date start or end is set. Leave empty for the provider default (the last 7 days in recent modes, no time limit in historical modes).", "default": 7 }, "dateFrom": { "title": "Date start", "type": "string", "description": "Custom range start, inclusive, as YYYY-MM-DD or an ISO 8601 date-time such as 2026-09-01T00:00:00Z. Cannot be in the future." }, "dateTo": { "title": "Date end", "type": "string", "description": "Custom range end, exclusive, as an ISO 8601 date-time. A plain YYYY-MM-DD date includes that whole day." }, "timeField": { "title": "Time range applies to", "enum": [ "publishedAt", "collectedAt" ], "type": "string", "description": "Filter on when the mention was published, or on when SentiOne collected it (use this for incremental exports that never miss late arrivals).", "default": "publishedAt" }, "sourceTypes": { "title": "Source types", "type": "array", "description": "Keep only mentions from these source types. Leave empty for all.", "items": { "type": "string", "enum": [ "Facebook", "Websites", "Instagram", "Forums", "X", "Blogs", "TikTok", "Reviews", "Reddit", "Video", "Imported", "Other" ], "enumTitles": [ "Facebook", "Websites and news", "Instagram", "Forums", "X (Twitter)", "Blogs", "TikTok", "Reviews", "Reddit", "Video (YouTube and others)", "Imported", "Other" ] } }, "mentionTypes": { "title": "Mention types", "type": "array", "description": "Keep only these mention formats. Leave empty for all.", "items": { "type": "string", "enum": [ "Post", "Comment", "Article", "PrivateMessage", "Share" ], "enumTitles": [ "Post", "Comment", "Article", "Private message", "Share" ] } }, "sentiments": { "title": "Sentiments", "type": "array", "description": "Keep only mentions with these sentiments. Leave empty for all.", "items": { "type": "string", "enum": [ "Positive", "Negative", "Neutral", "Unspecified" ], "enumTitles": [ "Positive", "Negative", "Neutral", "Unspecified" ] } }, "languages": { "title": "Languages", "type": "array", "description": "Keep only mentions in these languages, as two-letter ISO 639-1 codes such as en, pl or de. Leave empty for all.", "items": { "type": "string" } }, "sortType": { "title": "Sort by", "enum": [ "PublishedAtDescending", "PublishedAtAscending", "CollectedAtDescending", "CollectedAtAscending", "InfluenceScoreDescending", "EngagementRateDescending", "LikeCountDescending", "ShareCountDescending", "FollowerCountDescending" ], "type": "string", "description": "The documented sort orders. Search and export modes.", "default": "PublishedAtDescending" }, "discussionId": { "title": "Discussion ID", "type": "string", "description": "Discussion modes. The ID of one thread, exactly as the discussionId column of any mention row shows." }, "mentionIds": { "title": "Mention IDs", "type": "array", "description": "Mention modes. One mention ID per line, each starting with smid-, as the id column of any mention row shows. The parent mode returns the post or article each one replies to.", "items": { "type": "string" } }, "anonymize": { "title": "Anonymize personal data", "enum": [ "none", "author", "all" ], "type": "string", "description": "Export stream modes only, an experimental provider feature. Author replaces author names and IDs with consistent hashes and drops avatars. All also hashes the channel and removes the location.", "default": "none" }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 1000000, "type": "integer", "description": "The most rows this run returns and charges for. Search modes read 25 mentions a call and the provider allows 30 search calls an hour, so use an export stream mode for more than about 700 mentions; streams are sent this number as their documented limit so they never spend your monthly mentions cap past it.", "default": 100 }, "apiKey": { "title": "API key", "type": "string", "description": "Your own Listen API key (V2), from Organization > API Access in the SentiOne app. It starts with S1-APIKEY-. Stored as a secret. You can instead set the DATA_API_KEY environment secret." } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }