Outbound Links
rybbit_get_outbound_linksRead-onlyIdempotent
Retrieve and analyze outbound link click data from your website to understand which external URLs users visit and their frequency.
Instructions
Get outbound link clicks tracked on the site. Shows which external URLs users are clicking and how often.
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) | |
| page | No | Page number, 1-indexed (default: 1) | |
| limit | No | Results per page (default: 20-50 depending on endpoint, max 200) |
Implementation Reference
- src/tools/events.ts:159-173 (handler)The handler function for the rybbit_get_outbound_links tool, which fetches outbound link click events from the Rybbit API.
async (args) => { try { const params = client.buildAnalyticsParams(args); const data = await client.get(`/sites/${args.siteId}/events/outbound`, 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, }; } } - src/tools/events.ts:147-158 (registration)The registration block for the rybbit_get_outbound_links tool, including its schema and description.
server.registerTool( "rybbit_get_outbound_links", { title: "Outbound Links", annotations: { readOnlyHint: true, idempotentHint: true, openWorldHint: true, destructiveHint: false }, description: "Get outbound link clicks tracked on the site. Shows which external URLs users are clicking and how often.", inputSchema: { ...analyticsInputSchema, ...paginationSchema, }, },