Purpose and Capabilities
This Connector provides tools to interact with Marketing Cloud’s reporting and analytics APIs:Tool Name | Description | Example Inputs |
---|---|---|
marketing_cloud_get_email_send_summary | Retrieves performance summary for email sends. | send_id , job_id , date_range , metrics_to_include |
marketing_cloud_get_campaign_performance | Gets comprehensive campaign performance metrics. | campaign_id , date_range , metrics_list , segment_breakdown |
marketing_cloud_list_recent_sends | Lists recent email sends with basic performance data. | date_range , limit , send_classification , sort_by |
marketing_cloud_get_top_performing_emails | Retrieves top performing emails based on specified metrics. | metric_type , date_range , limit , campaign_filter |
marketing_cloud_get_email_engagement_data | Gets detailed engagement metrics for specific emails. | email_id , send_id , date_range , engagement_types |
marketing_cloud_get_subscriber_engagement | Retrieves engagement history for specific subscribers. | subscriber_key , email_address , date_range , engagement_types |
marketing_cloud_get_bounce_report | Gets bounce and delivery failure details. | send_id , bounce_types , date_range , include_details |
marketing_cloud_get_unsubscribe_report | Retrieves unsubscribe data and trends. | date_range , list_ids , unsubscribe_reasons , include_demographics |
marketing_cloud_get_click_tracking_data | Gets detailed click tracking and link performance. | send_id , email_id , date_range , link_breakdown |
marketing_cloud_get_open_tracking_data | Retrieves email open tracking and timing data. | send_id , email_id , date_range , device_breakdown |
marketing_cloud_get_journey_performance | Gets performance metrics for Journey Builder journeys. | journey_id , date_range , metrics_list , version_id |
marketing_cloud_get_automation_report | Retrieves execution reports for Automation Studio. | automation_id , date_range , execution_status , include_errors |
marketing_cloud_get_data_extension_stats | Gets usage and growth statistics for Data Extensions. | data_extension_key , date_range , stat_types |
marketing_cloud_get_send_time_optimization | Retrieves send time optimization performance data. | campaign_id , date_range , time_zone , optimization_metrics |
marketing_cloud_export_tracking_data | Exports detailed tracking data for analysis. | send_ids , date_range , data_types , export_format |
Prerequisites
- Marketing Cloud Account: Your organization must have an active Salesforce Marketing Cloud account with Analytics/Intelligence features.
- API Integration:
- An Installed Package must be created in Marketing Cloud Setup with API Integration component.
- Appropriate permissions for Analytics and Reporting data access.
- Required Scopes:
analytics_read
,email_read
,campaigns_read
,tracking_read
- Marketing Cloud Intelligence: Some advanced analytics features may require Marketing Cloud Intelligence license.
- Data Retention: Ensure your Marketing Cloud account has appropriate data retention settings for historical reporting.
Setup Instructions
-
Create Installed Package:
- In Marketing Cloud Setup, go to Apps > Installed Packages.
- Click New and provide package details.
- Add API Integration component with these permissions:
- Email: Read, Write (for email metadata)
- Tracking: Read (for engagement data)
- Analytics: Read (for performance metrics)
- Campaigns: Read (for campaign data)
-
Configure Authentication:
- Note the Client ID and Client Secret from your API Integration.
- Configure OAuth 2.0 authentication flow.
- Obtain access tokens with appropriate scopes.
-
Set Up Data Access:
- Ensure your API user has access to the business units containing the campaigns you want to analyze.
- Configure appropriate folder permissions for email and campaign assets.
-
Test API Access:
- Use the Marketing Cloud REST API to test basic operations.
- Verify you can retrieve email send data and campaign information.
Authentication
The Marketing Cloud Analytics Connector uses OAuth 2.0 authentication:Available Metrics
Email Performance Metrics
- Delivery Metrics: Sent, Delivered, Bounced, Delivery Rate
- Engagement Metrics: Opens, Clicks, Open Rate, Click Rate, Click-to-Open Rate
- Conversion Metrics: Conversions, Revenue, ROI
- List Growth: Subscribes, Unsubscribes, Net Growth
Campaign Metrics
- Reach: Total Recipients, Unique Recipients
- Engagement: Total Engagement, Engagement Rate
- Performance: Campaign ROI, Cost per Engagement
- Timing: Send Time Performance, Optimal Send Times
Advanced Analytics
- Predictive Analytics: Engagement Scoring, Send Time Optimization
- Segmentation: Performance by Segment, Demographic Breakdown
- Journey Analytics: Journey Performance, Path Analysis
- A/B Testing: Test Results, Statistical Significance
Common Use Cases
- Performance Reporting: Generate automated reports on campaign performance.
- Content Optimization: Identify top-performing email content for reuse.
- Audience Insights: Analyze subscriber engagement patterns and preferences.
- Campaign Planning: Use historical data to optimize future campaigns.
- ROI Analysis: Track and measure marketing campaign return on investment.
- Automated Alerts: Set up notifications for performance thresholds.
Data Freshness and Availability
- Real-time Data: Some metrics are available in near real-time (5-15 minutes delay).
- Historical Data: Historical reporting data is typically available within 2-4 hours.
- Data Retention: Standard retention periods apply (typically 6-12 months for detailed tracking data).
- Aggregated Data: Summary metrics may be available for longer periods.
Rate Limits and Best Practices
- API Limits: Marketing Cloud enforces rate limits (typically 2,500 calls per minute).
- Data Volume: Large data exports may take time to process and should be handled asynchronously.
- Caching: Implement caching for frequently accessed metrics to reduce API calls.
- Batch Requests: Use batch endpoints when available to retrieve multiple metrics efficiently.
- Error Handling: Implement proper retry logic for transient errors and rate limit responses.
Security Considerations
- Data Privacy: Ensure compliance with privacy regulations when accessing subscriber data.
- Access Control: Use principle of least privilege for API access permissions.
- Token Security: Store and rotate OAuth tokens securely.
- Audit Logging: Maintain logs of analytics data access for compliance purposes.
- Data Encryption: Ensure all API communications use HTTPS encryption.