{ "opencollection": "1.0.0", "info": { "name": "Rybbit API", "version": "1.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Event Tracking", "type": "folder" }, "items": [ { "info": { "name": "Send a pageview or custom event.", "type": "http" }, "http": { "method": "POST", "url": "https://app.rybbit.io/api/track", "body": { "type": "json", "data": "{\n \"site_id\": \"\",\n \"type\": \"custom_event\",\n \"event_name\": \"\",\n \"hostname\": \"\",\n \"pathname\": \"\",\n \"page_title\": \"\",\n \"referrer\": \"\",\n \"language\": \"\",\n \"screenWidth\": 0,\n \"screenHeight\": 0,\n \"properties\": \"{}\"\n}" } }, "docs": "Public ingestion endpoint used by the tracking script and server-side integrations. No API key required for basic tracking." } ] }, { "info": { "name": "Sessions", "type": "folder" }, "items": [ { "info": { "name": "List sessions for a site.", "type": "http" }, "http": { "method": "GET", "url": "https://app.rybbit.io/api/sites/:site/sessions", "params": [ { "name": "site", "value": "", "type": "path", "description": "The site ID scoping the query." } ] }, "docs": "Returns a paginated list of sessions with their analytics data." }, { "info": { "name": "Get a single session.", "type": "http" }, "http": { "method": "GET", "url": "https://app.rybbit.io/api/sites/:site/sessions/:sessionId", "params": [ { "name": "site", "value": "", "type": "path" }, { "name": "sessionId", "value": "", "type": "path" } ] }, "docs": "Returns session-level detail including the ordered list of pageviews and events." }, { "info": { "name": "List session locations.", "type": "http" }, "http": { "method": "GET", "url": "https://app.rybbit.io/api/sites/:site/session-locations", "params": [ { "name": "site", "value": "", "type": "path" } ] }, "docs": "Returns geographic location data for sessions." }, { "info": { "name": "Get cohort retention.", "type": "http" }, "http": { "method": "GET", "url": "https://app.rybbit.io/api/sites/:site/retention", "params": [ { "name": "site", "value": "", "type": "path" } ] }, "docs": "Returns cohort-based retention analysis grouped by first visit." } ] }, { "info": { "name": "Analytics", "type": "folder" }, "items": [ { "info": { "name": "List users for a site.", "type": "http" }, "http": { "method": "GET", "url": "https://app.rybbit.io/api/sites/:site/users", "params": [ { "name": "site", "value": "", "type": "path" } ] }, "docs": "Returns a list of users for the site." }, { "info": { "name": "Get a single user.", "type": "http" }, "http": { "method": "GET", "url": "https://app.rybbit.io/api/sites/:site/users/:userId", "params": [ { "name": "site", "value": "", "type": "path" }, { "name": "userId", "value": "", "type": "path" } ] }, "docs": "Returns detail for a single user." }, { "info": { "name": "List sessions for a user.", "type": "http" }, "http": { "method": "GET", "url": "https://app.rybbit.io/api/sites/:site/users/:userId/sessions", "params": [ { "name": "site", "value": "", "type": "path" }, { "name": "userId", "value": "", "type": "path" } ] }, "docs": "Returns the session history for a single user." }, { "info": { "name": "Get per-user session counts.", "type": "http" }, "http": { "method": "GET", "url": "https://app.rybbit.io/api/sites/:site/users/session-count", "params": [ { "name": "site", "value": "", "type": "path" } ] }, "docs": "Returns session counts grouped by user." }, { "info": { "name": "Get user journeys.", "type": "http" }, "http": { "method": "GET", "url": "https://app.rybbit.io/api/sites/:site/journeys", "params": [ { "name": "site", "value": "", "type": "path" } ] }, "docs": "Returns common navigation paths users take through the site." } ] } ], "bundled": true }