Overview Time Series
rybbit_get_overview_timeseriesRead-onlyIdempotent
Retrieve time-series analytics data with configurable time buckets for charting trends and monitoring website performance metrics.
Instructions
Get overview metrics as time-series data with configurable time buckets (minute, hour, day, week, month). Returns arrays of data points for charting trends.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| siteId | Yes | Site ID (numeric ID or domain identifier) | |
| startDate | No | Start date in ISO format (YYYY-MM-DD) | |
| endDate | No | End date in ISO format (YYYY-MM-DD) | |
| timeZone | No | IANA timezone (e.g., Europe/Prague). Default: UTC | |
| filters | No | Array of filters. Example: [{parameter:'browser',type:'equals',value:['Chrome']},{parameter:'country',type:'equals',value:['US','DE']}] | |
| pastMinutesStart | No | Alternative to dates: minutes ago start (e.g., 60 = last hour) | |
| pastMinutesEnd | No | Alternative to dates: minutes ago end (default 0 = now) | |
| bucket | No | Time bucket granularity (default: day). Use 'hour' for last 24h, 'week'/'month' for long ranges |
Implementation Reference
- src/tools/overview.ts:115-165 (handler)Registration and implementation of the 'rybbit_get_overview_timeseries' tool.
server.registerTool( "rybbit_get_overview_timeseries", { title: "Overview Time Series", description: "Get overview metrics as time-series data with configurable time buckets (minute, hour, day, week, month). Returns arrays of data points for charting trends.", inputSchema: { ...analyticsInputSchema, bucket: bucketSchema, }, annotations: { readOnlyHint: true, destructiveHint: false, idempotentHint: true, openWorldHint: true, }, }, async (args) => { try { const params = client.buildAnalyticsParams({ startDate: args.startDate, endDate: args.endDate, timeZone: args.timeZone, filters: args.filters, pastMinutesStart: args.pastMinutesStart, pastMinutesEnd: args.pastMinutesEnd, bucket: args.bucket, }); const data = await client.get<TimeseriesDataPoint[]>( `/sites/${args.siteId}/overview-bucketed`, params ); return { content: [ { type: "text" as const, text: truncateResponse(data), }, ], }; } catch (err) { const message = err instanceof Error ? err.message : String(err); return { content: [{ type: "text" as const, text: `Error: ${message}` }], isError: true, }; } } );