Skip to main content

​
Overview

This endpoint provides comprehensive analytics for browser checks, including page load times, script execution performance, Core Web Vitals, and other user experience metrics. Essential for monitoring web application performance from the end-user perspective.

​
Response Example

{
  "data": {
    "checkId": "browser_check_789123",
    "checkName": "E-commerce Checkout Flow",
    "timeframe": {
      "from": "2024-01-01T00:00:00.000Z",
      "to": "2024-01-31T23:59:59.999Z"
    },
    "metrics": {
      "averagePageLoadTime": 2.8,
      "averageScriptDuration": 15.6,
      "successRate": 98.5,
      "errorRate": 1.5,
      "totalRuns": 4320,
      "successfulRuns": 4255,
      "failedRuns": 65,
      "coreWebVitals": {
        "firstContentfulPaint": 1.2,
        "largestContentfulPaint": 2.4,
        "cumulativeLayoutShift": 0.05,
        "firstInputDelay": 12.3
      },
      "performanceScore": 87.5
    },
    "timeline": [
      {
        "timestamp": "2024-01-01T00:00:00.000Z",
        "pageLoadTime": 2.6,
        "scriptDuration": 14.8,
        "status": "success",
        "coreWebVitals": {
          "firstContentfulPaint": 1.1,
          "largestContentfulPaint": 2.3,
          "cumulativeLayoutShift": 0.04
        }
      }
    ],
    "locationBreakdown": [
      {
        "location": "us-east-1",
        "locationName": "N. Virginia, USA",
        "averagePageLoadTime": 2.5,
        "averageScriptDuration": 14.2,
        "successRate": 99.1,
        "runCount": 1440
      }
    ],
    "stepBreakdown": [
      {
        "stepName": "Navigate to homepage",
        "averageDuration": 2.1,
        "successRate": 99.8,
        "errorCount": 3
      },
      {
        "stepName": "Add item to cart",
        "averageDuration": 1.2,
        "successRate": 99.5,
        "errorCount": 8
      },
      {
        "stepName": "Complete checkout",
        "averageDuration": 3.8,
        "successRate": 97.9,
        "errorCount": 54
      }
    ]
  }
}

​
Query Parameters

  • from (string): Start date for analytics data (ISO 8601 format)
  • to (string): End date for analytics data (ISO 8601 format)
  • period (string): Predefined time period (24h, 7d, 30d, 90d)
Default: Last 30 days if no parameters provided
  • granularity (string): Data point granularity (5m, 15m, 1h, 1d)
  • locations (array): Filter by specific monitoring locations
  • includeSteps (boolean): Include individual step performance data
  • includeCoreWebVitals (boolean): Include Core Web Vitals metrics
Example:
?from=2024-01-01T00:00:00Z&to=2024-01-31T23:59:59Z&includeSteps=true&includeCoreWebVitals=true

​
Metrics Explained

Page Performance

  • Page Load Time: Time to fully load the page
  • Script Duration: Total time for script execution
  • Performance Score: Overall performance rating (0-100)

Core Web Vitals

  • FCP: First Contentful Paint - time to first content render
  • LCP: Largest Contentful Paint - time to largest element render
  • CLS: Cumulative Layout Shift - visual stability score
  • FID: First Input Delay - interactivity responsiveness

User Experience

  • Success Rate: Percentage of successful browser check runs
  • Error Breakdown: Failed steps and error categories
  • Step Performance: Individual step execution times

Geographic Analysis

  • Location Performance: Performance metrics by region
  • Network Conditions: Simulated network performance
  • Device Simulation: Mobile vs desktop performance

​
Use Cases

Track Google’s Core Web Vitals for SEO and user experience:
  • Monitor FCP, LCP, CLS, and FID metrics
  • Ensure Core Web Vitals meet Google’s “Good” thresholds
  • Track performance impact of code changes
  • Optimize for search rankings and user experience
Analyze end-to-end user workflows:
  • Track multi-step processes like checkout flows
  • Identify bottlenecks in user journeys
  • Monitor conversion funnel performance
  • Detect step-specific failures and optimization opportunities
Detect performance regressions after deployments:
  • Compare performance before and after releases
  • Set up alerts for performance degradation
  • Track script execution time changes
  • Monitor impact of new features on performance
Optimize performance across different regions:
  • Compare page load times across locations
  • Identify regions with poor performance
  • Make CDN and infrastructure decisions
  • Optimize for global user experience

​
Code Examples

curl -X GET "https://api.checklyhq.com/v1/analytics/browser-checks/browser_check_789123?period=7d&includeSteps=true&includeCoreWebVitals=true" \
  -H "Authorization: Bearer cu_1234567890abcdef" \
  -H "X-Checkly-Account: 550e8400-e29b-41d4-a716-446655440000"
Browser check analytics include detailed Core Web Vitals metrics that align with Google’s performance standards for SEO and user experience optimization.