Rybbit
Overview

Get Overview (Time Series)

Returns time-series analytics data broken down by configurable time buckets. Useful for charting trends over time.

GET /api/sites/:site/overview-bucketed

Returns time-series analytics data broken down by configurable time buckets. Useful for charting trends over time.

Path Parameters

Prop

Type

Query Parameters

Accepts all Common Parameters plus the following:

Prop

Type

Bucket Selection Guide

BucketBest For
minuteReal-time monitoring (last hour)
five_minutesShort-term analysis (last few hours)
hourDaily analysis
dayWeekly/monthly analysis
weekMonthly/quarterly analysis
monthYearly analysis

Response

Prop

Type

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

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

response = requests.get(
    'https://app.rybbit.io/api/sites/123/overview-bucketed',
    params={
        'bucket': 'day',
        'start_date': '2024-01-01',
        'end_date': '2024-01-07',
        'time_zone': 'America/New_York'
    },
    headers={
        'Authorization': 'Bearer your_api_key_here'
    }
)

data = response.json()
Request
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://app.rybbit.io/api/sites/123/overview-bucketed?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=America/New_York');
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://app.rybbit.io/api/sites/123/overview-bucketed?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=America/New_York')
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://app.rybbit.io/api/sites/123/overview-bucketed?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=America/New_York", 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://app.rybbit.io/api/sites/123/overview-bucketed?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=America/New_York")
    .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://app.rybbit.io/api/sites/123/overview-bucketed?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=America/New_York"))
    .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://app.rybbit.io/api/sites/123/overview-bucketed?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=America/New_York");
var data = await response.Content.ReadAsStringAsync();
Response
{
  "data": [
    {
      "time": "2024-01-01T00:00:00.000Z",
      "sessions": 1250,
      "pageviews": 3890,
      "users": 1100,
      "pages_per_session": 3.11,
      "bounce_rate": 41.5,
      "session_duration": 165.2
    },
    {
      "time": "2024-01-02T00:00:00.000Z",
      "sessions": 1420,
      "pageviews": 4520,
      "users": 1280,
      "pages_per_session": 3.18,
      "bounce_rate": 39.8,
      "session_duration": 178.4
    },
    {
      "time": "2024-01-03T00:00:00.000Z",
      "sessions": 1380,
      "pageviews": 4210,
      "users": 1190,
      "pages_per_session": 3.05,
      "bounce_rate": 42.1,
      "session_duration": 162.8
    }
  ]
}