{ "openapi": "3.0.1", "info": { "title": "X Business Intelligence Pro", "description": "Professional Twitter/X intelligence tool trusted by 26+ teams. Enterprise analytics with sentiment analysis, competitive intelligence, and crisis detection. Unlimited monthly extraction vs $0.40 per 1K tweets. Perfect for marketing agencies, brand teams, and enterprises.", "version": "0.0", "x-build-id": "Fx4bhMHT4wuoKlPVs" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/red.cars~x-business-intelligence-pro/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-red.cars-x-business-intelligence-pro", "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/red.cars~x-business-intelligence-pro/runs": { "post": { "operationId": "runs-sync-red.cars-x-business-intelligence-pro", "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/red.cars~x-business-intelligence-pro/run-sync": { "post": { "operationId": "run-sync-red.cars-x-business-intelligence-pro", "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": [ "searchTerms", "maxTweets", "analysisMode" ], "properties": { "searchTerms": { "title": "Keywords or Hashtags to Monitor", "minItems": 1, "maxItems": 10, "type": "array", "description": "Search terms for social media analytics (brands, hashtags, keywords)", "items": { "type": "string", "minLength": 1 } }, "maxTweets": { "title": "Maximum Tweets to Analyze", "minimum": 1, "maximum": 500, "type": "integer", "description": "Limit tweets for faster processing (recommended: 10-50 for testing, 100+ for production)" }, "analysisMode": { "title": "Analysis Mode", "enum": [ "basic", "sentiment", "competitive", "enterprise" ], "type": "string", "description": "Level of social media intelligence and processing depth" }, "enableSentimentAnalysis": { "title": "Enable Sentiment Analysis", "type": "boolean", "description": "Analyze positive/negative sentiment in tweets with confidence scoring" }, "timeRange": { "title": "Time Range", "enum": [ "1h", "6h", "24h", "3d", "7d" ], "type": "string", "description": "Time period for social media monitoring" }, "competitorBrands": { "title": "Competitor Brands (Optional)", "maxItems": 5, "type": "array", "description": "Brand names for competitive intelligence analysis", "items": { "type": "string", "minLength": 1 } }, "proxyType": { "title": "Proxy Reliability Level", "enum": [ "DATACENTER", "RESIDENTIAL" ], "type": "string", "description": "Choose your preferred balance of cost vs reliability. Standard (Datacenter) is faster; Premium (Residential) is most reliable for high-security targets." }, "debugMode": { "title": "Debug Mode (Self-Test)", "type": "boolean", "description": "Enable minimal extraction for health checks and testing. Guarantees success within 300s." }, "exportFormat": { "title": "Export Format", "enum": [ "json", "csv", "markdown", "salesforce", "hubspot" ], "type": "string", "description": "Choose output format. Use 'markdown' for token-efficient LLM-ready X intelligence." }, "businessIntelligenceFeatures": { "title": "Business Intelligence Features", "type": "object", "description": "Advanced analytics and intelligence capabilities", "properties": { "enableCompetitorAnalysis": { "title": "Competitor Analysis", "type": "boolean", "description": "Multi-brand comparison and market share analysis" }, "enableInfluencerScoring": { "title": "Influencer Scoring", "type": "boolean", "description": "Identify high-value prospects and collaboration opportunities" }, "enableTrendAnalysis": { "title": "Trend Analysis", "type": "boolean", "description": "Track viral content and emerging trends" }, "enableCrisisDetection": { "title": "Crisis Detection", "type": "boolean", "description": "Real-time negative sentiment alerts and escalation" }, "industryContext": { "title": "Industry Context", "type": "string", "description": "Industry for specialized analytics and insights", "enum": [ "Technology", "Healthcare", "Finance", "Retail", "Media", "Government", "Education", "General" ] } } }, "outputOptions": { "title": "Output Options", "type": "object", "description": "Configure what data and reports to generate", "properties": { "includeTweetContent": { "title": "Include Tweet Content", "type": "boolean", "description": "Include full tweet text in results" }, "includeAuthorProfiles": { "title": "Include Author Profiles", "type": "boolean", "description": "Include detailed author information and metrics" }, "includeEngagementMetrics": { "title": "Include Engagement Metrics", "type": "boolean", "description": "Include likes, retweets, replies, and engagement rates" }, "generateSummaryReport": { "title": "Generate Executive Summary", "type": "boolean", "description": "Create executive-level business intelligence summary" }, "generateDashboard": { "title": "Generate Interactive Dashboard", "type": "boolean", "description": "Create professional HTML dashboard with charts and analytics" }, "enableCRMIntegration": { "title": "Enable CRM Integration", "type": "boolean", "description": "Generate Salesforce and HubSpot ready data exports" } } }, "competitorListFile": { "title": "Upload Competitor List", "type": "string", "description": "Upload CSV or JSON file with competitor handles for bulk analysis." }, "influencerDatabaseFile": { "title": "Upload Influencer Database", "type": "string", "description": "Upload JSON file with influencer profiles for batch analysis." }, "hashtagListFile": { "title": "Upload Hashtag List", "type": "string", "description": "Upload CSV file with hashtags for content strategy analysis." }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Configure proxy settings for reliable enterprise scraping", "properties": { "useApifyProxy": { "title": "Use Apify Proxy", "type": "boolean", "description": "Use Apify's residential proxy service (recommended for enterprise)" } } } } }, "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 } } } } } } } } } }