Skip to main content

BrainPredict Marketing: API Reference

Complete API documentation for all 29 endpoints across Marketing AI models and strategic intelligence. RESTful API with JSON responses.

Authentication

All API requests require authentication using your API key in the header:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
X-Tenant-ID: your-tenant-id

Get your API key from Portal → Settings → API Keys

API Endpoints

GET/api/marketing/ai-models/models

List all 26 Marketing AI models with metadata and accuracy rates

Parameters:

Response: {"total":26,"models":[],"average_accuracy":90.6}

POST/api/marketing/ai-models/campaign-performance-predictor

Predict campaign performance and ROI (CampaignPerformancePredictor - 91.5% accuracy)

Parameters: campaign_data

Response: {"predicted_roi":2.5,"predicted_conversions":1500,"confidence":0.915}

POST/api/marketing/ai-models/customer-acquisition-optimizer

Optimize customer acquisition cost (CustomerAcquisitionOptimizer - 89.7% accuracy)

Parameters: acquisition_data

Response: {"optimal_cac":45,"channel_recommendations":[],"expected_savings":15000}

POST/api/marketing/ai-models/content-performance-ai

Analyze content performance (ContentPerformanceAI - 88.3% accuracy)

Parameters: content_data

Response: {"performance_score":0.85,"engagement_prediction":0.75,"recommendations":[]}

POST/api/marketing/ai-models/attribution-model-ai

Calculate multi-touch attribution (AttributionModelAI - 92.1% accuracy)

Parameters: touchpoint_data

Response: {"attribution_model":{},"channel_contributions":{},"insights":[]}

POST/api/marketing/ai-models/churn-prevention-ai

Predict customer churn (ChurnPreventionAI - 90.8% accuracy)

Parameters: customer_data

Response: {"churn_probability":0.35,"risk_level":"medium","retention_strategies":[]}

POST/api/marketing/ai-models/segmentation-ai

Segment customers intelligently (SegmentationAI - 87.9% accuracy)

Parameters: customer_data

Response: {"segments":[],"segment_characteristics":{},"targeting_recommendations":[]}

POST/api/marketing/ai-models/personalization-engine

Personalize customer experiences (PersonalizationEngine - 91.2% accuracy)

Parameters: customer_id, context

Response: {"personalized_content":{},"recommendations":[],"confidence":0.912}

POST/api/marketing/ai-models/brand-health-monitor

Monitor brand health metrics (BrandHealthMonitor - 86.4% accuracy)

Parameters: brand_data

Response: {"health_score":0.82,"sentiment":"positive","risk_factors":[],"opportunities":[]}

POST/api/marketing/ai-models/influencer-roi-predictor

Predict influencer campaign ROI (InfluencerROIPredictor - 88.7% accuracy)

Parameters: influencer_data, campaign_details

Response: {"predicted_roi":3.2,"reach_estimate":500000,"engagement_rate":0.045}

POST/api/marketing/ai-models/email-engagement-optimizer

Optimize email campaigns (EmailEngagementOptimizer - 90.3% accuracy)

Parameters: email_data

Response: {"optimal_send_time":"10:00 AM","subject_line_score":0.85,"predicted_open_rate":0.35}

POST/api/marketing/ai-models/landing-page-optimizer

Optimize landing pages (LandingPageOptimizer - 89.5% accuracy)

Parameters: page_data

Response: {"optimization_score":0.88,"recommendations":[],"predicted_conversion_lift":0.25}

POST/api/marketing/ai-models/video-performance-predictor

Predict video content performance (VideoPerformancePredictor - 87.6% accuracy)

Parameters: video_data

Response: {"predicted_views":50000,"engagement_score":0.75,"virality_potential":0.65}

POST/api/marketing/ai-models/social-media-scheduler

Optimize social media posting schedule (SocialMediaScheduler - 88.9% accuracy)

Parameters: platform, content_type

Response: {"optimal_times":[],"expected_reach":100000,"engagement_prediction":0.055}

POST/api/marketing/ai-models/competitor-intelligence

Analyze competitor strategies (CompetitorIntelligence - 86.8% accuracy)

Parameters: competitor_data

Response: {"competitive_insights":[],"market_positioning":{},"strategic_recommendations":[]}

POST/api/marketing/ai-models/pricing-optimization

Optimize pricing strategies (PricingOptimization - 91.7% accuracy)

Parameters: product_data, market_data

Response: {"optimal_price":99,"demand_elasticity":-1.5,"revenue_impact":0.18}

POST/api/marketing/ai-models/customer-lifetime-value-predictor

Predict customer lifetime value (CLVPredictor - 92.4% accuracy)

Parameters: customer_id

Response: {"predicted_clv":5000,"confidence":0.924,"time_horizon_months":36}

POST/api/marketing/ai-models/voice-of-customer-analyzer

Analyze customer feedback (VoiceOfCustomerAnalyzer - 88.6% accuracy)

Parameters: feedback_data

Response: {"sentiment":"positive","themes":[],"action_items":[],"priority_issues":[]}

POST/api/marketing/ai-models/market-trend-analyzer

Analyze market trends (MarketTrendAnalyzer - 89.4% accuracy)

Parameters: market_data, time_horizon

Response: {"trends":[],"predictions":[],"opportunities":[],"threats":[]}

POST/api/marketing/ai-models/creative-generation-ai

Generate creative ideas (CreativeGenerationAI - 87.2% accuracy)

Parameters: brief, target_audience

Response: {"creative_concepts":[],"performance_predictions":[],"recommendations":[]}

POST/api/marketing/ai-models/conversion-rate-optimizer

Optimize conversion funnels (ConversionRateOptimizer - 92.8% accuracy)

Parameters: funnel_data

Response: {"bottlenecks":[],"optimization_opportunities":[],"predicted_lift":0.35}

POST/api/marketing/ai-models/marketing-mix-modeler

Analyze marketing mix effectiveness (MarketingMixModeler - 93.5% accuracy - HIGHEST)

Parameters: marketing_data, time_period

Response: {"channel_effectiveness":{},"budget_recommendations":[],"roi_by_channel":{}}

POST/api/marketing/ai-models/customer-journey-mapper

Map customer journeys (CustomerJourneyMapper - 90.7% accuracy)

Parameters: customer_data

Response: {"journey_stages":[],"touchpoints":[],"optimization_opportunities":[]}

POST/api/marketing/ai-models/retargeting-optimizer

Optimize retargeting campaigns (RetargetingOptimizer - 91.2% accuracy)

Parameters: audience_data, campaign_data

Response: {"optimal_audiences":[],"bid_recommendations":[],"expected_roas":4.5}

POST/api/marketing/ai-models/budget-allocation-ai

Optimize budget allocation (BudgetAllocationAI - 92.9% accuracy)

Parameters: budget, channels, objectives

Response: {"optimal_allocation":{},"expected_roi":3.8,"channel_recommendations":[]}

POST/api/v1/marketing/strategic/benchmarking/performance

Benchmark marketing performance against industry standards

Parameters: organization_data, industry, time_period_days

Response: {"benchmarking_results":{},"performance_gaps":[],"recommendations":[]}

POST/api/v1/marketing/strategic/intelligence/aggregate

Aggregate marketing intelligence for strategic decision-making

Parameters: time_period_days, include_predictions, aggregation_level

Response: {"aggregated_intelligence":{},"key_insights":[],"strategic_recommendations":[]}

GET/api/v1/marketing/strategic/benchmarking/industry-standards

Get industry benchmark standards for marketing metrics

Parameters: industry

Response: {"industry":"technology","industry_average":{},"top_performer":{},"available_industries":[]}

GET/api/v1/marketing/strategic/intelligence/portfolio-summary

Get summary of marketing portfolio health

Parameters:

Response: {"total_campaigns":0,"total_spend":0,"average_roi":0,"top_channels":[]}

Example: Campaign ROI Prediction

POST /v1/marketing/campaigns/predict-roi
Authorization: Bearer bp_marketing_live_xxx
Content-Type: application/json

{
  "campaign_name": "Q4 Product Launch",
  "channel": "Multi-Channel",
  "budget": 50000,
  "target_audience": "Enterprise Decision Makers",
  "content_type": "Video + Blog + Email",
  "duration_days": 90
}

Response (200 OK):
{
  "campaign_id": "cmp_1234567890",
  "predicted_roi": 485,
  "confidence": 92,
  "ai_score": 90,
  "predicted_leads": 1247,
  "predicted_conversions": 342,
  "predicted_revenue": 2425000,
  "recommendations": [
    "Increase video content by 30% for higher engagement",
    "Target enterprise decision makers on LinkedIn",
    "Launch campaign on Tuesday at 10 AM for optimal reach"
  ],
  "created_at": "2025-10-08T14:30:00Z"
}

Rate Limits

PlanRequests/MonthRate Limit
Starter10,000100 req/min
Professional50,000500 req/min
EnterpriseUnlimited5,000 req/min

Error Codes

  • 400 Bad Request - Invalid request parameters
  • 401 Unauthorized - Invalid or missing API key
  • 403 Forbidden - Insufficient permissions
  • 404 Not Found - Resource not found
  • 429 Too Many Requests - Rate limit exceeded
  • 500 Internal Server Error - Server error