Meta tags:
description=Authentication, common parameters, and best practices for the Rybbit Stats API;
author=Rybbit Team;
keywords=web analytics,privacy analytics,open source analytics,Google Analytics alternative,website tracking,self-hosted analytics;

Headings (most frequently used words):

filter, parameters, api, error, only, examples, getting, started, playground, guides, authentication, generating, keys, common, responses, bearer, token, recommended, query, parameter, testing, rate, limits, cloud, time, response, format, on, this, page, object, structure, types, available,

Text of the page (most frequently used words):
string (38), api (26), the (21), #parameters (18), and (16), type (16), filter (12), parameter (12), your (11), keys (8), endpoints (8), all (8), value (8), prop (8), rybbit (8), error (7), number (7), query (6), week (6), with (6), time (5), rate (5), only (5), authentication (5), playground (5), traffic (5), events (5), time_zone (5), for (5), responses (4), examples (4), available (4), limits (4), last (4), requests (4), access (4), key (4), filters (4), equals (4), user (4), browser (4), 2024 (4), exact (4), date (4), getting (4), started (4), common (3), testing (3), bearer (3), recommended (3), guides (3), automated (3), weekly (3), report (3), not (3), site (3), lat (3), regex (3), pathname (3), contains (3), country (3), use (3), channel (3), past_minutes_start (3), past_minutes_end (3), relative (3), start_datetime (3), end_datetime (3), datetime (3), start_date (3), end_date (3), are (3), copy (3), real (3), build (3), live (3), performance (3), where (3), users (3), end (3), response (2), format (2), types (2), object (2), structure (2), cloud (2), generating (2), token (2), this (2), page (2), overview (2), into (2), scheduled (2), digest (2), over (2), change (2), top (2), pages (2), sources (2), what (2), server (2), limit (2), invalid (2), request (2), 200 (2), standard (2), less_than (2), greater_than (2), match (2), device_type (2), multiple (2), encoded (2), array (2), data (2), america (2), new_york (2), based (2), three (2), you (2), must (2), following (2), account (2), grant (2), sites (2), organization (2), per (2), minute (2), plan (2), dashboard (2), history (2), your_api_key_here (2), using (2), endpoint (2), visitor (2), feed (2), how (2), they (2), compare (2), see (2), find (2), drop (2), off (2), way (2), code (2), test (2), ranges (2), 688 (2), github (2), reference (2), combine, metric, that, summarizes, message, describing, went, wrong, internal, 500, too, many, exceeded, 429, found, doesn, exist, 404, forbidden, 403, unauthorized, missing, 401, bad, 400, success, return, http, status, codes, 22parameter, 22country, 22type, 22equals, 22value, 22us, geolocation, comparison, products, pattern, blog, substring, mobile, logic, url, numeric, single, event_name, user_id, utm_content, utm_term, utm_campaign, utm_medium, utm_source, utm, exit_page, entry_page, referrer, querystring, hostname, page_title, lon, timezone, city, region, location, language, dimensions, operating_system_version, operating_system, browser_version, device, not_regex, not_contains, not_equals, filtertype, filterparameter, accepts, json, objects, narrow, down, minutes, 2013, 2015, new, york, jan, sent, utc, days, both, provide, either, note, require, shared, across, analytics, tied, self, hosted, instances, have, pro, free, basic, depend, immediately, won, shown, again, click, create, enter, name, scroll, section, navigate, settings, scoped, level, expose, logs, quick, api_key, authorization, include, one, methods, backfill, full, event, keep, sync, incremental, job, export, warehouse, poll, activity, stream, can, render, alert, rank, acquisition, channels, well, convert, just, much, send, locate, biggest, leak, funnel, then, people, who, abandon, instead, looking, these, recipes, chain, together, solve, problem, familiarize, yourself, before, integrating, applications, ready, snippets, generation, actual, optional, start, times, configure, visual, interface, controls, browse, provides, easiest, explore, built, navigating, any, clicking, sidebar, currently, beta, there, may, breaking, changes, continue, improve, expand, open, markdown, best, practices, stats, imports, teams, organizations, management, insights, bots, errors, funnels, goals, traits, session, replay, sessions, post, sending, rest, documentation, search,

Text of the page (random words):
getting started rybbit search k github rybbit io rybbit 12 4k 688 documentation api reference api reference rest api endpoints and authentication github rybbit io rybbit 12 4k 688 getting started guides automated weekly report find where users drop off compare channel performance build a live visitor feed endpoints sending events post overview sessions session replay users user traits events goals funnels performance errors bots insights management organizations teams sites imports api keys getting started getting started authentication common parameters and best practices for the rybbit stats api copy markdown open the api is currently in beta there may be breaking changes as we continue to improve and expand the api api playground the easiest way to explore and test the api is using the built in api playground in your rybbit dashboard access it by navigating to any site and clicking api playground in the sidebar the playground provides endpoint browser browse all available api endpoints parameter controls configure request parameters with a visual interface exact time ranges test date ranges with optional start and end times live responses see real api responses with your actual data code generation copy ready to use code snippets this is the recommended way to familiarize yourself with the api before integrating it into your applications guides looking for what to build with the api these end to end recipes chain endpoints together to solve a real problem automated weekly report a scheduled digest of last week s traffic week over week change and top pages and sources find where users drop off locate the biggest leak in a funnel then see where the people who abandon go instead compare channel performance rank acquisition channels by how well they convert not just how much traffic they send build a live visitor feed poll the events endpoint for a real time activity stream you can render or alert on export events to a warehouse backfill your full event history and keep it in sync with an incremental job authentication all api requests must include authentication using one of the following methods bearer token recommended authorization bearer your_api_key_here query parameter testing only api_key your_api_key_here query parameters expose api keys in server logs and browser history use only for quick testing generating api keys api keys are user scoped and grant organization level access navigate to settings account in your rybbit dashboard scroll to the api keys section enter a name for your api key click create copy the key immediately it won t be shown again rate limits cloud only api key rate limits depend on your plan plan limit free basic api keys not available standard 20 requests per minute pro 200 requests per minute self hosted instances have no rate limits keys are tied to your user account and grant access to all sites in your organization s common parameters the following parameters are shared across all analytics endpoints time parameters all endpoints require date based exact datetime or relative time parameters prop type start_date string end_date string time_zone string start_datetime string end_datetime string past_minutes_start number past_minutes_end number note you must provide either all three date parameters start_date end_date time_zone or all three exact datetime parameters start_datetime end_datetime time_zone or both relative parameters past_minutes_start past_minutes_end examples date based query last 30 days start_date 2024 01 01 end_date 2024 01 31 time_zone america new_york exact datetime query 8 am to 10 am in new york on jan 15 sent as utc start_datetime 2024 01 15 2013 00 00 end_datetime 2024 01 15 2015 00 00 time_zone america new_york relative query last 60 minutes past_minutes_start 60 past_minutes_end 0 filter parameters the filters parameter accepts a json encoded array of filter objects to narrow down your data filter object structure prop type parameter filterparameter type filtertype value array string number filter types prop type equals string not_equals string contains string not_contains string regex string not_regex string greater_than number less_than number available filter parameters browser device prop type browser string browser_version string operating_system string operating_system_version string device_type string dimensions string language string location prop type country string region string city string timezone string lat number lon number page traffic prop type pathname string page_title string hostname string querystring string referrer string entry_page string exit_page string channel string utm parameters prop type utm_source string utm_medium string utm_campaign string utm_term string utm_content string user events prop type user_id string event_name string filter examples single filter multiple filters contains regex numeric url encoded parameter country type equals value us multiple filters use and logic parameter country type equals value us ca parameter device_type type equals value mobile substring match parameter pathname type contains value blog pattern match parameter pathname type regex value products 0 9 geolocation comparison parameter lat type greater_than value 37 0 parameter lat type less_than value 38 0 filters 5b 7b 22parameter 22 3a 22country 22 2c 22type 22 3a 22equals 22 2c 22value 22 3a 5b 22us 22 5d 7d 5d error responses all endpoints return standard http status codes 200 success 400 bad request invalid parameters 401 unauthorized missing or invalid api key 403 forbidden no access to site 404 not found site doesn t exist 429 too many requests rate limit exceeded 500 internal server error error response format error error message describing what went wrong automated weekly report combine the overview and metric endpoints into a scheduled digest that summarizes last week s traffic the week over week change and your top pages and traffic sources on this page api playground guides authentication bearer token recommended query parameter testing only generating api keys rate limits cloud only common parameters time parameters examples filter parameters filter object structure filter types available filter parameters filter examples error responses error response format