Site Overview
rybbit_get_overviewGet aggregated site metrics like sessions, pageviews, unique users, and bounce rate for a specified date range and filters to analyze website performance.
Instructions
Get aggregated overview metrics for a site: sessions, pageviews, unique users, pages per session, bounce rate, and average session duration. Supports date range and filters.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| siteId | Yes | Site ID (numeric ID or domain identifier) | |
| endDate | No | End date in ISO format (YYYY-MM-DD) | |
| filters | No | Array of filters. Example: [{parameter:'browser',type:'equals',value:['Chrome']},{parameter:'country',type:'equals',value:['US','DE']}] | |
| timeZone | No | IANA timezone (e.g., Europe/Prague). Default: UTC | |
| startDate | No | Start date in ISO format (YYYY-MM-DD) | |
| pastMinutesEnd | No | Alternative to dates: minutes ago end (default 0 = now) | |
| pastMinutesStart | No | Alternative to dates: minutes ago start (e.g., 60 = last hour) |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| users | No | ||
| sessions | No | ||
| pageviews | No | ||
| bounceRate | No | ||
| pagesPerSession | No | ||
| avgSessionDuration | No |