Rybbit
APIStats

Performance

Retrieve Core Web Vitals and performance metrics for your site

See the API Reference for authentication, common parameters, and filters.

Core Web Vitals

The performance endpoints return data for the following Core Web Vitals metrics:

MetricDescriptionGoodNeeds ImprovementPoor
LCPLargest Contentful Paint - loading performance< 2.5s2.5s - 4s> 4s
CLSCumulative Layout Shift - visual stability< 0.10.1 - 0.25> 0.25
INPInteraction to Next Paint - interactivity< 200ms200ms - 500ms> 500ms
FCPFirst Contentful Paint - initial render< 1.8s1.8s - 3s> 3s
TTFBTime to First Byte - server response time< 800ms800ms - 1.8s> 1.8s

Endpoints

GET/api/performance/overview/:siteGET/api/performance/time-series/:siteGET/api/performance/by-dimension/:site

Get Performance Overview

GET /api/performance/overview/:site

Returns aggregate performance metrics with percentile breakdowns for all Core Web Vitals.

Path Parameters

Prop

Type

Query Parameters

Accepts all Common Parameters (time and filters).

Response

Prop

Type

PerformanceMetrics Object

Each metric (lcp, cls, inp, fcp, ttfb) includes the following percentiles:

Prop

Type

Request
curl -X GET "https://api.rybbit.io/api/performance/overview/123?start_date=2024-01-01&end_date=2024-01-31" \
  -H "Authorization: Bearer your_api_key_here"
Request
const response = await fetch(
  'https://api.rybbit.io/api/performance/overview/123?start_date=2024-01-01&end_date=2024-01-31',
  {
    headers: {
      'Authorization': 'Bearer your_api_key_here'
    }
  }
);

const data = await response.json();
Request
import requests

response = requests.get(
    'https://api.rybbit.io/api/performance/overview/123',
    params={
        'start_date': '2024-01-01',
        'end_date': '2024-01-31'
    },
    headers={
        'Authorization': 'Bearer your_api_key_here'
    }
)

data = response.json()
Request
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/performance/overview/123?start_date=2024-01-01&end_date=2024-01-31');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer your_api_key_here'
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
Request
require 'net/http'
require 'json'

uri = URI('https://api.rybbit.io/api/performance/overview/123?start_date=2024-01-01&end_date=2024-01-31')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
Request
req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/performance/overview/123?start_date=2024-01-01&end_date=2024-01-31", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")

client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

var data map[string]interface{}
json.NewDecoder(resp.Body).Decode(&data)
Request
let client = reqwest::Client::new();
let res = client
    .get("https://api.rybbit.io/api/performance/overview/123?start_date=2024-01-01&end_date=2024-01-31")
    .header("Authorization", "Bearer your_api_key_here")
    .send()
    .await?;

let data: serde_json::Value = res.json().await?;
Request
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.rybbit.io/api/performance/overview/123?start_date=2024-01-01&end_date=2024-01-31"))
    .header("Authorization", "Bearer your_api_key_here")
    .GET()
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
Request
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");

var response = await client.GetAsync("https://api.rybbit.io/api/performance/overview/123?start_date=2024-01-01&end_date=2024-01-31");
var data = await response.Content.ReadAsStringAsync();
Response
{
  "data": {
    "lcp_p50": 1850,
    "lcp_p75": 2400,
    "lcp_p90": 3200,
    "lcp_p99": 5100,
    "cls_p50": 0.05,
    "cls_p75": 0.1,
    "cls_p90": 0.18,
    "cls_p99": 0.35,
    "inp_p50": 120,
    "inp_p75": 180,
    "inp_p90": 280,
    "inp_p99": 450,
    "fcp_p50": 1200,
    "fcp_p75": 1600,
    "fcp_p90": 2100,
    "fcp_p99": 3500,
    "ttfb_p50": 450,
    "ttfb_p75": 650,
    "ttfb_p90": 950,
    "ttfb_p99": 1800,
    "total_performance_events": 48521
  }
}

Get Performance Time Series

GET /api/performance/time-series/:site

Returns performance metrics over time, broken down by configurable time buckets. Useful for charting performance trends.

Path Parameters

Prop

Type

Query Parameters

Accepts all Common Parameters plus the following:

Prop

Type

Response

Prop

Type

PerformancePoint Object

Each point includes all percentiles for each metric plus:

Prop

Type

Request
curl -X GET "https://api.rybbit.io/api/performance/time-series/123?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=UTC" \
  -H "Authorization: Bearer your_api_key_here"
Request
const response = await fetch(
  'https://api.rybbit.io/api/performance/time-series/123?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=UTC',
  {
    headers: {
      'Authorization': 'Bearer your_api_key_here'
    }
  }
);

const data = await response.json();
Request
import requests

response = requests.get(
    'https://api.rybbit.io/api/performance/time-series/123',
    params={
        'bucket': 'day',
        'start_date': '2024-01-01',
        'end_date': '2024-01-07',
        'time_zone': 'UTC'
    },
    headers={
        'Authorization': 'Bearer your_api_key_here'
    }
)

data = response.json()
Request
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/performance/time-series/123?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=UTC');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer your_api_key_here'
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
Request
require 'net/http'
require 'json'

uri = URI('https://api.rybbit.io/api/performance/time-series/123?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=UTC')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
Request
req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/performance/time-series/123?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=UTC", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")

client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

var data map[string]interface{}
json.NewDecoder(resp.Body).Decode(&data)
Request
let client = reqwest::Client::new();
let res = client
    .get("https://api.rybbit.io/api/performance/time-series/123?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=UTC")
    .header("Authorization", "Bearer your_api_key_here")
    .send()
    .await?;

let data: serde_json::Value = res.json().await?;
Request
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.rybbit.io/api/performance/time-series/123?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=UTC"))
    .header("Authorization", "Bearer your_api_key_here")
    .GET()
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
Request
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");

var response = await client.GetAsync("https://api.rybbit.io/api/performance/time-series/123?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=UTC");
var data = await response.Content.ReadAsStringAsync();
Response
{
  "data": [
    {
      "time": "2024-01-01T00:00:00.000Z",
      "lcp_p50": 1820,
      "lcp_p75": 2350,
      "lcp_p90": 3100,
      "lcp_p99": 4900,
      "cls_p50": 0.04,
      "cls_p75": 0.09,
      "inp_p50": 115,
      "inp_p75": 175,
      "fcp_p50": 1180,
      "fcp_p75": 1580,
      "ttfb_p50": 440,
      "ttfb_p75": 640,
      "event_count": 6892
    },
    {
      "time": "2024-01-02T00:00:00.000Z",
      "lcp_p50": 1900,
      "lcp_p75": 2450,
      "lcp_p90": 3250,
      "lcp_p99": 5200,
      "cls_p50": 0.05,
      "cls_p75": 0.11,
      "inp_p50": 125,
      "inp_p75": 185,
      "fcp_p50": 1220,
      "fcp_p75": 1620,
      "ttfb_p50": 460,
      "ttfb_p75": 660,
      "event_count": 7234
    }
  ]
}

Get Performance by Dimension

GET /api/performance/by-dimension/:site

Returns performance metrics broken down by a specific dimension (page, country, browser, etc.). Useful for identifying performance issues on specific pages or for specific user segments.

Path Parameters

Prop

Type

Query Parameters

Accepts all Common Parameters plus the following:

Prop

Type

Response

Prop

Type

DimensionPerformance Object

Each object includes the dimension value plus all percentiles:

Prop

Type

Request
curl -X GET "https://api.rybbit.io/api/performance/by-dimension/123?dimension=pathname&sort_by=lcp_p75&sort_order=desc&limit=10" \
  -H "Authorization: Bearer your_api_key_here"
Request
const response = await fetch(
  'https://api.rybbit.io/api/performance/by-dimension/123?dimension=pathname&sort_by=lcp_p75&sort_order=desc&limit=10',
  {
    headers: {
      'Authorization': 'Bearer your_api_key_here'
    }
  }
);

const data = await response.json();
Request
import requests

response = requests.get(
    'https://api.rybbit.io/api/performance/by-dimension/123',
    params={
        'dimension': 'pathname',
        'sort_by': 'lcp_p75',
        'sort_order': 'desc',
        'limit': 10
    },
    headers={
        'Authorization': 'Bearer your_api_key_here'
    }
)

data = response.json()
Request
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/performance/by-dimension/123?dimension=pathname&sort_by=lcp_p75&sort_order=desc&limit=10');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer your_api_key_here'
]);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
Request
require 'net/http'
require 'json'

uri = URI('https://api.rybbit.io/api/performance/by-dimension/123?dimension=pathname&sort_by=lcp_p75&sort_order=desc&limit=10')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'

res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)
Request
req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/performance/by-dimension/123?dimension=pathname&sort_by=lcp_p75&sort_order=desc&limit=10", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")

client := &http.Client{}
resp, _ := client.Do(req)
defer resp.Body.Close()

var data map[string]interface{}
json.NewDecoder(resp.Body).Decode(&data)
Request
let client = reqwest::Client::new();
let res = client
    .get("https://api.rybbit.io/api/performance/by-dimension/123?dimension=pathname&sort_by=lcp_p75&sort_order=desc&limit=10")
    .header("Authorization", "Bearer your_api_key_here")
    .send()
    .await?;

let data: serde_json::Value = res.json().await?;
Request
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.rybbit.io/api/performance/by-dimension/123?dimension=pathname&sort_by=lcp_p75&sort_order=desc&limit=10"))
    .header("Authorization", "Bearer your_api_key_here")
    .GET()
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
Request
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");

var response = await client.GetAsync("https://api.rybbit.io/api/performance/by-dimension/123?dimension=pathname&sort_by=lcp_p75&sort_order=desc&limit=10");
var data = await response.Content.ReadAsStringAsync();
Response
{
  "data": {
    "data": [
      {
        "pathname": "/dashboard",
        "event_count": 12450,
        "lcp_avg": 2850,
        "lcp_p50": 2400,
        "lcp_p75": 3200,
        "lcp_p90": 4100,
        "lcp_p99": 6500,
        "cls_avg": 0.08,
        "cls_p50": 0.05,
        "cls_p75": 0.12,
        "inp_avg": 180,
        "inp_p50": 150,
        "inp_p75": 220,
        "fcp_avg": 1450,
        "fcp_p50": 1300,
        "fcp_p75": 1700,
        "ttfb_avg": 520,
        "ttfb_p50": 480,
        "ttfb_p75": 680
      },
      {
        "pathname": "/reports",
        "event_count": 8920,
        "lcp_avg": 2650,
        "lcp_p50": 2200,
        "lcp_p75": 2900,
        "lcp_p90": 3800,
        "lcp_p99": 5800
      }
    ],
    "totalCount": 156
  }
}

Funnels

Create and analyze multi-step conversion funnels

Errors

Track and analyze JavaScript errors captured from your site