{ "openapi": "3.0.1", "info": { "title": "Social Listening API - Brand24 Mentions, Sentiment, Topics", "description": "Social listening and media monitoring data from your own Brand24 projects: mentions filtered by date, sentiment and source, daily volume, reach and engagement, AI topics, spikes and summaries, influencers, domains, hashtags and demographics. Read only. Bring your own key.", "version": "0.1", "x-build-id": "zd1qPCyLHp7Ehrlfg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/nabeelbaghoor~social-listening-media-monitoring-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-nabeelbaghoor-social-listening-media-monitoring-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-media-monitoring-api/runs": { "post": { "operationId": "runs-sync-nabeelbaghoor-social-listening-media-monitoring-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-media-monitoring-api/run-sync": { "post": { "operationId": "run-sync-nabeelbaghoor-social-listening-media-monitoring-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": { "service": { "title": "What to read", "enum": [ "mentions", "mentionTrends", "dailyMetrics", "topics", "events", "aiSummary", "aiInsights", "influencers", "domains", "mostActiveSites", "trendingLinks", "trendingHashtags", "hotHours", "demographics", "keywords", "projects", "usage" ], "type": "string", "description": "Mentions (the default) returns every mention of a project in the date range, with the sentiment and source filters below. The other project services return daily volume, sentiment and reach; daily metrics with engagement and AVE; AI topics, detected events, the AI summary and AI insights; influential authors, popular domains, most active sites, trending links and hashtags, hot hours, demographics and project keywords. Projects lists the projects of an account id, which is where project ids come from. Projected mentions usage needs nothing else.", "default": "mentions" }, "projectIds": { "title": "Project ids", "type": "array", "description": "One Brand24 project id per line, as a number. Every service except projects and projected mentions usage reads them. The projects service lists the ids and names of every project in an account.", "items": { "type": "string" } }, "accountId": { "title": "Account id", "type": "string", "description": "Projects only: the number of the Brand24 account whose projects to list." }, "dateFrom": { "title": "Start date", "type": "string", "description": "First day of the range, as YYYY-MM-DD, inclusive. Mentions and daily volume need a range, so when both dates are empty they read the last 30 days. Other services send the date only when it is set and otherwise use the provider's default of about the last 30 days. Daily volume, daily metrics, AI summary and AI insights allow at most 31 days." }, "dateTo": { "title": "End date", "type": "string", "description": "Last day of the range, as YYYY-MM-DD, inclusive. Defaults to today where a range is needed." }, "sentiment": { "title": "Sentiment", "type": "array", "description": "Mentions only: keep mentions with these sentiments. Leave empty for all.", "items": { "type": "string", "enum": [ "positive", "negative", "neutral" ], "enumTitles": [ "Positive", "Negative", "Neutral" ] } }, "sourceCategories": { "title": "Source categories", "type": "array", "description": "Mentions only: keep mentions from these source categories. Leave empty for all. Facebook and Instagram mentions come without title, content or URL, and X mentions come with the tweet id only, because of those platforms' terms.", "items": { "type": "string", "enum": [ "facebook", "instagram", "x", "tiktok", "videos", "news", "podcasts", "other_socials", "blogs", "web" ], "enumTitles": [ "Facebook", "Instagram", "X (Twitter)", "TikTok", "Videos", "News", "Podcasts", "Other social networks", "Blogs", "Web" ] } }, "metricsSource": { "title": "Metrics source", "enum": [ "any", "twitter", "facebook", "instagram", "reddit", "youtube", "tiktok", "news" ], "type": "string", "description": "Daily metrics only: limit the totals to one source.", "default": "any" }, "includeBySource": { "title": "Per-source breakdown", "type": "boolean", "description": "Daily metrics only: add a per-source breakdown of each day under bySource.", "default": false }, "eventSortOrder": { "title": "Event order", "enum": [ "desc", "asc" ], "type": "string", "description": "Detected events only: newest first or oldest first.", "default": "desc" }, "influencerSortBy": { "title": "Author order", "enum": [ "followers_count", "mentions_count" ], "type": "string", "description": "Influential authors only: rank by follower count or by number of mentions.", "default": "followers_count" }, "minInfluencerScore": { "title": "Minimum influencer score", "minimum": 0, "maximum": 10, "type": "integer", "description": "Influential authors only: keep authors with at least this influencer score, from 0 to 10." }, "maxResults": { "title": "Maximum results", "minimum": 1, "maximum": 100000, "type": "integer", "description": "Stop after this many rows across all projects.", "default": 1000 }, "requestsPerMinute": { "title": "Requests per minute", "minimum": 1, "maximum": 120, "type": "integer", "description": "Pacing ceiling for calls to the provider. Rate limited answers are retried after a pause.", "default": 60 }, "apiKey": { "title": "API key", "type": "string", "description": "Your own Brand24 API Data key, shown at app.brand24.com/account/integrations-api-data. This actor is bring-your-own-key and never ships one. Leave blank to use the DATA_API_KEY environment secret. The key is sent only in the X-Api-Key header to the API host, and is never written to a row or logged." }, "baseUrl": { "title": "API base URL", "type": "string", "description": "Override the host the actor calls. Only useful for testing against a different environment." } } }, "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 } } } } } } } } } }