Analytics API

The Analytics API provides programmatic access to QR code performance data, visitor profiles, and event streams through REST endpoints. It enables automated reporting, business intelligence integration, and real-time monitoring for workspace analytics data.

The API exposes the same data visible in the dashboard but through structured endpoints that support complex queries, bulk exports, and real-time access for integration with CRM systems, BI platforms, and custom analytics tools.

Quick summary

• Learn how to access comprehensive QR code and visitor analytics through REST API endpoints
• Discover campaign performance data including scan counts, geographic distribution, and device breakdowns
• Master visitor analytics with behavioral scoring, audience segmentation, and lead qualification data
• Implement real-time event streams for operational dashboards and monitoring systems
• Explore authentication methods and rate limiting for secure and scalable API integration
• Understand bulk export capabilities and custom queries for business intelligence platforms

Understanding the Analytics API architecture

The Analytics API provides structured access to the same performance data visible in your Linkbreakers dashboard, but through programmable endpoints that support automated data collection, real-time monitoring, and integration with external analytics platforms. For implementation details, see our API integration guide.

Unlike traditional analytics platforms that provide limited API access, Linkbreakers exposes comprehensive analytics data through well-designed REST endpoints that support complex queries, flexible filtering, and efficient data retrieval at scale. This comprehensive access enables everything from simple reporting automation to sophisticated machine learning pipelines that analyze visitor behavior patterns.

The API architecture emphasizes performance and flexibility, supporting both real-time queries for operational dashboards and batch data extraction for business intelligence systems. Response formats are optimized for common integration scenarios while maintaining the depth needed for advanced analysis use cases.

All analytics data respects workspace boundaries and role-based access control, ensuring programmatic access maintains the same security and organizational isolation as manual dashboard usage.

Core analytics endpoints overview

The Analytics API organizes data access around three primary endpoint types that align with campaign reporting, visitor analysis, and event tracking requirements.

Endpoint Type	Primary Use	Data Returned	Update Frequency
Campaign Performance	Aggregate metrics across links and tags	Scan counts, visitor metrics, geographic distribution, device breakdowns, temporal patterns	Real-time aggregation
Visitor Analytics	Individual profiles and audience segments	Engagement histories, form data, lead scores, behavioral patterns	Updated per interaction
Event Streams	Granular interaction records	Individual scan events, timestamps, device data, location, workflow progression	Real-time and historical

Campaign performance endpoints

Campaign-level analytics provide aggregated metrics for performance analysis:

• Link performance includes scan counts, unique visitors, geographic distribution, device types, and engagement patterns
• QR code analytics provide scan success rates, error conditions, and technical performance metrics
• Tag-based aggregation enables portfolio analysis across campaign categories

Visitor analytics endpoints

Visitor-focused endpoints provide person-centric data:

• Individual profiles include engagement histories, demographic information, behavioral scores, and journey tracking
• Audience segments enable programmatic access to visitor groups based on behavior, geography, demographics, and engagement
• Lead scoring provides AI-generated qualification scores and behavioral analysis

Event stream analytics

Event-level data provides granular interaction visibility:

• Real-time streams deliver immediate access to scan events for operational dashboards and monitoring
• Historical data supports retrospective analysis, pattern identification, and machine learning development
• Correlation analysis enables multi-touchpoint attribution and journey mapping

Authentication and access control

Analytics API access requires proper authentication and adheres to workspace-level security policies.

Authentication Method	Token Type	Created By	Access Scope	Validity
API Tokens	Development	Admin/Tech roles	Test data, limited time ranges	Until revoked
API Tokens	Production	Admin/Tech roles	Full workspace access	Until revoked
API Tokens	Analytics	Admin/Tech roles	Read-only analytics endpoints	Until revoked

API token management

Analytics access requires API tokens created by admin or tech role users. Tokens inherit creator permissions and provide secure programmatic access without individual user credentials.

Token creation specifies access scopes that determine which analytics endpoints each token can access. This enables specialized tokens for different purposes while maintaining security boundaries.

Token rotation ensures long-term security through regular credential updates. The platform supports overlapping token validity periods for smooth transitions during security maintenance.

Rate limiting and usage management

The API implements intelligent rate limiting balanced with integration needs:

• Workspace-based limits align with subscription level, with higher limits for Pro and Enterprise accounts
• Intelligent throttling adapts to usage patterns, providing additional capacity during off-peak hours
• Batch optimization handles bulk requests efficiently through specialized endpoints

Common integration scenarios

The Analytics API supports three primary integration patterns for business intelligence, marketing automation, and custom analytics development.

Integration Type	Data Frequency	Primary Use Cases	Recommended Endpoints
Business Intelligence	Scheduled (daily/hourly)	Historical analysis, trend reporting, executive dashboards	Bulk exports, time-range queries, aggregated metrics
Marketing Automation	Real-time	Lead qualification, behavioral triggers, CRM synchronization	Webhooks, visitor profiles, lead scores
Custom Analytics	Mixed	Industry metrics, predictive models, compliance reporting	Event streams, custom queries, filtered datasets

Business intelligence integration

BI platforms require reliable, scheduled data extraction for analysis:

• Daily reporting extracts performance metrics, visitor engagement, and campaign results for executive dashboards
• Historical synchronization ensures complete datasets spanning campaign lifecycles and seasonal patterns
• Real-time feeds support operational monitoring through live KPI updates

Marketing automation integration

Marketing platforms benefit from real-time visitor data for immediate response:

• Lead qualification leverages scoring data to populate CRM systems and trigger sales notifications
• Behavioral triggers monitor actions to initiate email sequences and targeted campaigns
• Campaign optimization uses analytics to automatically adjust parameters and budgets

Custom analytics development

Organizations with specialized requirements build custom tools:

• Industry-specific metrics calculate custom conversions aligned with business models
• Predictive modeling leverages datasets to build ML models for conversion prediction
• Compliance reporting ensures regulatory requirements through automated monitoring

Data export and format options

The Analytics API supports multiple export patterns and response formats for different integration requirements.

Export Method	Format	Use Case	Performance	Pagination
Standard Queries	JSON	Real-time dashboards, single-record lookups	Fast	Cursor-based
Bulk Exports	JSON/Compressed	BI synchronization, historical analysis	Optimized for volume	Time-range based
Incremental Sync	JSON	Regular updates, change detection	Efficient delta transfer	Timestamp-based
Custom Queries	JSON	Filtered datasets, specific analysis	Variable by complexity	Multi-dimensional

Response formats and structures

API responses use consistent JSON structures optimized for parsing and error handling:

• Structured objects include field types, validation information, and relationship indicators
• Pagination enables efficient handling through consistent interfaces across endpoints
• Error responses provide detailed failure information for retry logic

Bulk export capabilities

Specialized endpoints optimize large-scale data extraction:

• Time-range exports extract analytics for specific date ranges with minimized resource usage
• Incremental synchronization detects changes since previous operations for efficient updates
• Compressed formats reduce bandwidth through intelligent compression for large operations

Custom query capabilities

Flexible query interfaces support complex analysis requirements:

• Multi-dimensional filtering combines visitor attributes, campaign characteristics, temporal constraints, and performance criteria
• Aggregation functions calculate server-side statistics and trends to reduce data transfer
• Custom field selection includes only requested fields to optimize bandwidth and performance

Real-time analytics and monitoring

Live data access enables operational monitoring and immediate response automation for campaign performance changes.

Webhook integration for live updates

Webhook systems deliver immediate notifications of analytics events. Learn more about how webhooks work and visitor tracking capabilities.

• Event-driven notifications eliminate polling overhead for high-value engagement and conversions
• Custom triggers enable tailored notification policies aligned with business requirements
• Reliability features include automatic retry, delivery confirmation, and failure handling

Performance monitoring and alerting

Automated monitoring detects issues and optimization opportunities:

• Threshold monitoring detects performance changes indicating technical issues or opportunities
• Trend analysis identifies gradual changes affecting long-term effectiveness
• Comparative alerts monitor performance relative to baselines and seasonal patterns

Operational dashboard integration

Real-time feeds support dashboards for immediate visibility:

• Live metrics enable immediate response to campaign changes and engagement spikes
• Visitor tracking supports sales and marketing teams monitoring high-value engagement
• System health provides visibility into QR code functionality and redirect performance

Advanced analytics features

Advanced API capabilities support complex queries and specialized analytics integration.

Cohort analysis and retention tracking

Cohort analysis tracks visitor segments across time:

• Time-based cohorts analyze engagement changes, repeat patterns, and lifecycle value
• Behavioral cohorts group visitors by interaction patterns and demographics
• Retention analysis tracks return frequency and long-term relationship factors

Attribution modeling and journey analysis

Attribution analysis understands multi-touchpoint campaign effectiveness:

• Multi-touch attribution analyzes journeys across QR codes and campaigns to optimize resource allocation
• Cross-campaign analysis reveals interaction patterns across simultaneous campaigns
• Journey mapping identifies progression patterns, bottlenecks, and successful pathway designs

Predictive analytics integration

Machine learning leverages comprehensive datasets for optimization:

• Visitor scoring provides signals for lead scoring models and conversion prediction
• Performance prediction uses historical data to predict campaign performance and optimize timing
• Automated optimization adjusts parameters based on performance patterns and predictive models

API security and best practices

Production integrations require security practices, efficient resource usage, and reliable error handling.

Security implementation requirements

Analytics data requires protection throughout collection, transmission, and storage:

• Transport security requires HTTPS for all communications with proper certificate validation
• Token security includes secure storage, regular rotation, and access logging for audit trails
• Data handling ensures encryption at rest, access controls, and retention policies aligned with privacy regulations

Performance optimization strategies

Efficient API usage reduces costs and improves reliability:

• Query optimization uses appropriate filtering, field selection, and aggregation to minimize data transfer
• Caching strategies balance data freshness with API efficiency through intelligent local storage
• Error handling ensures reliability through appropriate responses to service issues and rate limiting

Monitoring and maintenance

Production integrations require ongoing monitoring:

• Usage monitoring tracks consumption patterns, performance trends, and error rates
• Integration health provides visibility into data quality and processing performance
• Documentation ensures maintainability as capabilities evolve and requirements change

Frequently Asked Questions

What analytics data is available through the API?

The Analytics API provides access to all performance data visible in your dashboard, including visitor profiles, scan events, campaign metrics, geographic data (country, region, city, timezone, ISP, ASN), device information, and behavioral analytics. Data access respects workspace permissions and subscription levels.

How do API rate limits work for analytics endpoints?

Rate limits vary by subscription level and endpoint type, with higher limits for Pro and Enterprise accounts. Real-time endpoints have different limits than bulk export operations, and intelligent throttling provides additional capacity during off-peak hours.

Can I access real-time analytics data through the API?

Yes, the API supports both real-time data queries and webhook notifications for immediate updates. Real-time capabilities include live visitor tracking, immediate scan event access, and automated alerting for performance thresholds.

What authentication methods does the Analytics API support?

Analytics API access requires workspace API tokens created through the dashboard. Tokens inherit creator permissions and support scoped access control for different integration requirements and security policies.

How far back does historical analytics data extend?

Historical data availability depends on your subscription level and data retention policies. Pro and Enterprise accounts typically have access to complete historical data, while free accounts may have limited retention periods.

Can I export analytics data in bulk for business intelligence systems?

Yes, specialized bulk export endpoints support efficient large-scale data extraction with optimization for BI integration. These endpoints support time-range queries, incremental synchronization, and compressed data formats for efficient processing.

Does the Analytics API support custom metrics and calculated fields?

The API provides raw data and standard calculations, with server-side aggregation functions for common scenarios. Custom metric calculation typically occurs in integration systems using the comprehensive raw data available through API endpoints.

How does the Analytics API handle visitor privacy and GDPR compliance?

Analytics API access respects all privacy settings, consent management, and data protection policies configured in your workspace. Data access follows the same privacy controls as dashboard usage, ensuring compliance with applicable regulations.

What's the difference between the Analytics API and webhook notifications?

The Analytics API provides on-demand access to comprehensive historical and current data, while webhooks deliver immediate notifications of specific events. Most integrations use both approaches for comprehensive analytics automation.

Can I integrate Analytics API data with external BI platforms like Tableau or Power BI?

Yes, the API's JSON responses and bulk export capabilities are designed for BI integration. Many organizations build custom connectors or use API middleware to synchronize Linkbreakers analytics with their preferred business intelligence platforms.

Limits and caveats

• Feature availability and limits can vary by plan and workspace setup.
• Results depend on correct implementation, attribution setup, and data quality controls.
• Regulatory and privacy obligations vary by jurisdiction and use case.