Frequently Asked Questions

This page addresses frequently encountered questions regarding widget integration, configuration, and troubleshooting.

#Topics

• Client ID Authentication
• Widget Integration
• Widget State Monitoring
• Troubleshooting
• Widget Name Resolution
• Widget Customization
• Match ID Retrieval
• Licensing Errors
• Widget Errors
• Live Match Tracker
  • Coverage Documentation
  • Error Resolution

#Client ID Authentication

The Client ID is a 32-character unique identifier automatically generated during account provisioning. This identifier serves as the primary authentication mechanism for all widget integrations.

Key characteristics:

• Auto-generated upon account creation
• Bound to all orders within the account scope
• Provides access to all enabled products under the account
• Required for widget initialization and API authentication

#Widget Integration

Widgets integration follows the same pattern, with widget-specific details. For general info, see Getting Started Guide, for widget-specific details see documentation for specific widgets

#Widget State Monitoring

All widgets expose an onTrack callback property that enables event-driven monitoring of widget lifecycle states (e.g. when widget has loaded) and user interactions.

#Troubleshooting

For widget integration or runtime issues, follow a systematic diagnostic approach, as documented in the Troubleshooting Guide.

#Widget Name Resolution

Widget names follow a namespaced naming convention (e.g., match.statistics, tournament.preview) and are required for both the addWidget() method and data-sr-widget attribute.

Resolution methods:

#Widget Customization

The Widgets Demo provides an interactive configuration interface for visual customization and code generation.

#Match ID Retrieval

Match IDs are numeric identifiers required for match-specific widget instantiation. These can be obtained through the Widgets Demo interface or via API endpoints.

Retrieval via Widgets Demo:

1. Navigate to Widgets Demo
2. Select the desired sport from the available options
3. Choose a specific match from the match list
4. Extract the matchId parameter from the browser URL

Example URL structure:

https://widgets.sir.sportradar.com/live-match-tracker#matches:(matchId:29524624,sportId:1)

In this example, the Match ID is 29524624.

#Licensing Errors

Licensing errors occur when authentication fails or when attempting to access products outside your subscription scope.

Common causes:

• Invalid or expired Client ID
• Insufficient product permissions
• Geographic or coverage restrictions
• Subscription limitations

#Widget Errors

Widget errors encompass runtime exceptions, configuration issues, and data availability problems.

Error categories:

• Initialization errors: Configuration or authentication failures
• Runtime errors: Data fetch failures or rendering issues
• Validation errors: Invalid parameters or missing required fields

#Live Match Tracker

#Coverage Documentation

Live Match Tracker (LMT) coverage varies by sport, competition, and geographic region.

Coverage assessment:

Review the Coverage Page to determine LMT availability for specific sports and competitions.

Coverage tiers:

• Different coverage levels provide varying degrees of data granularity
• Tier definitions and feature availability are detailed in the coverage page

#Error Resolution

LMT-specific errors are frequently related to licensing constraints or coverage limitations.

Diagnostic approach:

1. Identify the specific error code or message
2. Verify licensing permissions for the requested sport/competition
3. Confirm match coverage availability in the coverage document
4. Validate Match ID and configuration parameters