Pages

Get Pages Summary

Returns site-wide page totals for the period and the pageviews of every section.

GET /api/sites/:site/pages/summary

Returns the totals that head the Pages report, plus each section's pageviews and page count, largest first.

Permissions: any role on the site (viewer and above). API keys need the analytics:read scope. Public sites and private links can read it without a key.

Path Parameters

Prop

Type

Query Parameters

Accepts all Common Parameters (time and filters). Time parameters are optional; omit them for all-time data.

Response

Prop

Type

PagesSummary Object

Prop

Type

Request
curl -X GET "https://app.rybbit.io/api/sites/123/pages/summary?start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York" \
  -H "Authorization: Bearer your_api_key_here"
Request
const response = await fetch(
  'https://app.rybbit.io/api/sites/123/pages/summary?start_date=2024-01-01&end_date=2024-01-31&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/pages/summary',
    params={
        'start_date': '2024-01-01',
        'end_date': '2024-01-31',
        '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/pages/summary?start_date=2024-01-01&end_date=2024-01-31&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/pages/summary?start_date=2024-01-01&end_date=2024-01-31&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/pages/summary?start_date=2024-01-01&end_date=2024-01-31&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/pages/summary?start_date=2024-01-01&end_date=2024-01-31&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/pages/summary?start_date=2024-01-01&end_date=2024-01-31&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/pages/summary?start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York");
var data = await response.Content.ReadAsStringAsync();
Response
{
  "data": {
    "pageviews": 48210,
    "sessions": 21480,
    "pages": 214,
    "bounced_sessions": 9320,
    "bounce_rate": 43.39,
    "time_on_page_seconds": 52.4,
    "views_per_session": 2.24,
    "sections": [
      {
        "section": "/docs",
        "pageviews": 19840,
        "pages": 132
      },
      {
        "section": "/",
        "pageviews": 18420,
        "pages": 1
      },
      {
        "section": "/pricing",
        "pageviews": 6210,
        "pages": 1
      }
    ],
    "sectionCount": 12
  }
}