Skip to content

🐸 Rybbit - open-source and privacy-friendly alternative to Google Analytics that is 10x more intuitive.

Refactor FilterBuilder and ParameterControls components to improve filter handling and parameter metadata

Bill Yangd23eda7d6ae2
diff --git a/client/src/app/[site]/api-playground/components/FilterBuilder.tsx b/client/src/app/[site]/api-playground/components/FilterBuilder.tsx
index 32f6b366f..14f4f4b1c 100644
--- a/client/src/app/[site]/api-playground/components/FilterBuilder.tsx
+++ b/client/src/app/[site]/api-playground/components/FilterBuilder.tsx
@@ -3,6 +3,7 @@
import { Button } from "@/components/ui/button";
import { Input } from "@/components/ui/input";
import { Select, SelectContent, SelectItem, SelectTrigger, SelectValue } from "@/components/ui/select";
+import { FilterParameter, FilterType } from "@rybbit/shared";
import { Plus, X } from "lucide-react";
import { useExtracted } from "next-intl";
import { filterOperators, filterParameters, usePlaygroundStore } from "../hooks/usePlaygroundStore";
@@ -27,56 +28,67 @@ export function FilterBuilder() {
</p>
) : (
<div className="space-y-2">
- {filters.map((filter, index) => (
- <div key={index} className="flex items-center gap-2">
- <Select
- value={filter.parameter}
- onValueChange={value => updateFilter(index, { ...filter, parameter: value })}
- >
- <SelectTrigger className="w-[140px] h-8 text-xs">
- <SelectValue placeholder={t("Parameter")} />
- </SelectTrigger>
- <SelectContent>
- {filterParameters.map(param => (
- <SelectItem key={param.value} value={param.value} className="text-xs">
- {param.label}
- </SelectItem>
- ))}
- </SelectContent>
- </Select>
+ {filters.map((filter, index) => {
+ const operatorNeedsValue = filter.operator !== "is_null" && filter.operator !== "is_not_null";
- <Select
- value={filter.operator}
- onValueChange={value => updateFilter(index, { ...filter, operator: value })}
- >
- <SelectTrigger className="w-[120px] h-8 text-xs">
- <SelectValue placeholder={t("Operator")} />
- </SelectTrigger>
- <SelectContent>
- {filterOperators.map(op => (
- <SelectItem key={op.value} value={op.value} className="text-xs">
- {op.label}
- </SelectItem>
- ))}
- </SelectContent>
- </Select>
+ return (
+ <div key={index} className="flex items-center gap-2">
+ <Select
+ value={filter.parameter}
+ onValueChange={value => updateFilter(index, { ...filter, parameter: value as FilterParameter })}
+ >
+ <SelectTrigger className="w-[170px] h-8 text-xs">
+ <SelectValue placeholder={t("Parameter")} />
+ </SelectTrigger>
+ <SelectContent>
+ {filterParameters.map(param => (
+ <SelectItem key={param.value} value={param.value} className="text-xs">
+ {param.label}
+ </SelectItem>
+ ))}
+ </SelectContent>
+ </Select>
- <Input
- value={filter.value}
- onChange={e => updateFilter(index, { ...filter, value: e.target.value })}
- placeholder={t("Value")}
- className="flex-1 h-8 text-xs"
- />
+ <Select
+ value={filter.operator}
+ onValueChange={value =>
+ updateFilter(index, {
+ ...filter,
+ operator: value as FilterType,
+ value: value === "is_null" || value === "is_not_null" ? "" : filter.value,
+ })
+ }
+ >
+ <SelectTrigger className="w-[170px] h-8 text-xs">
+ <SelectValue placeholder={t("Operator")} />
+ </SelectTrigger>
+ <SelectContent>
+ {filterOperators.map(op => (
+ <SelectItem key={op.value} value={op.value} className="text-xs">
+ {op.label}
+ </SelectItem>
+ ))}
+ </SelectContent>
+ </Select>
- <Button
- variant="ghost"
- onClick={() => removeFilter(index)}
- className="h-5 w-5 p-0 text-neutral-500 hover:text-red-500"
- >
- <X className="h-3 w-3" />
- </Button>
- </div>
- ))}
+ <Input
+ value={filter.value}
+ onChange={e => updateFilter(index, { ...filter, value: e.target.value })}
+ placeholder={operatorNeedsValue ? t("Value") : t("No value needed")}
+ disabled={!operatorNeedsValue}
+ className="flex-1 min-w-0 h-8 text-xs"
+ />
+
+ <Button
+ variant="ghost"
+ onClick={() => removeFilter(index)}
+ className="h-5 w-5 p-0 text-neutral-500 hover:text-red-500"
+ >
+ <X className="h-3 w-3" />
+ </Button>
+ </div>
+ );
+ })}
</div>
)}
</div>
diff --git a/client/src/app/[site]/api-playground/components/ParameterControls.tsx b/client/src/app/[site]/api-playground/components/ParameterControls.tsx
index 2f66f5a0a..42755c518 100644
--- a/client/src/app/[site]/api-playground/components/ParameterControls.tsx
+++ b/client/src/app/[site]/api-playground/components/ParameterControls.tsx
@@ -92,7 +92,10 @@ export function ParameterControls() {
const queryParams: Record<string, any> = {};
if (selectedEndpoint.hasCommonParams) {
- Object.assign(queryParams, buildCommonQueryParams({ startDate, endDate, startTime, endTime, timeZone, filters }));
+ Object.assign(
+ queryParams,
+ buildCommonQueryParams({ startDate, endDate, startTime, endTime, timeZone, filters })
+ );
}
// Add endpoint-specific params
@@ -156,6 +159,8 @@ export function ParameterControls() {
});
};
+ const getParamMetadata = (param: string) => selectedEndpoint.parameterMetadata?.[param] ?? parameterMetadata[param];
+
return (
<div className="h-full overflow-y-auto p-4 space-y-6">
{/* Header */}
@@ -206,7 +211,7 @@ export function ParameterControls() {
{t("Path Parameters")}
</h3>
{selectedEndpoint.pathParams.map(param => {
- const meta = parameterMetadata[param];
+ const meta = getParamMetadata(param);
return (
<div key={param} className="space-y-1">
<label className="text-sm font-medium text-neutral-700 dark:text-neutral-300">
@@ -280,7 +285,7 @@ export function ParameterControls() {
{selectedEndpoint.hasCommonParams ? t("Additional Parameters") : t("Parameters")}
</h3>
{selectedEndpoint.specificParams.map(param => {
- const meta = parameterMetadata[param];
+ const meta = getParamMetadata(param);
const isRequired = selectedEndpoint.requiredParams?.includes(param);
if (!meta) {
return (
diff --git a/client/src/app/[site]/api-playground/components/ResponsePanel.tsx b/client/src/app/[site]/api-playground/components/ResponsePanel.tsx
index 544e54a2c..741a8e90f 100644
--- a/client/src/app/[site]/api-playground/components/ResponsePanel.tsx
+++ b/client/src/app/[site]/api-playground/components/ResponsePanel.tsx
@@ -129,7 +129,7 @@ export function ResponsePanel() {
</div>
) : (
<div className="p-3 bg-neutral-100 dark:bg-neutral-800 rounded text-xs text-neutral-500 dark:text-neutral-400">
- {t('Click "Execute Request" to see the response')}
+ {t('Click "Run" to see the response')}
</div>
)}
</div>
diff --git a/client/src/app/[site]/api-playground/hooks/usePlaygroundStore.ts b/client/src/app/[site]/api-playground/hooks/usePlaygroundStore.ts
index 6349ebd57..6d253c8b0 100644
--- a/client/src/app/[site]/api-playground/hooks/usePlaygroundStore.ts
+++ b/client/src/app/[site]/api-playground/hooks/usePlaygroundStore.ts
@@ -1,11 +1,11 @@
-import { Filter } from "@rybbit/shared";
+import { Filter, FilterParameter, FilterType } from "@rybbit/shared";
import { DateTime } from "luxon";
import { create } from "zustand";
import { EndpointConfig } from "../utils/endpointConfig";
interface PlaygroundFilter {
- parameter: string;
- operator: string;
+ parameter: FilterParameter;
+ operator: FilterType;
value: string;
}
@@ -78,14 +78,12 @@ const getToday = () => DateTime.now().toISODate() ?? "";
export const usePlaygroundStore = create<PlaygroundState>((set, get) => ({
// Selected endpoint
selectedEndpoint: null,
- setSelectedEndpoint: (endpoint) =>
+ setSelectedEndpoint: endpoint =>
set({
selectedEndpoint: endpoint,
endpointParams: {},
pathParams: {},
- requestBody: endpoint?.requestBodyExample
- ? JSON.stringify(endpoint.requestBodyExample, null, 2)
- : "",
+ requestBody: endpoint?.requestBodyExample ? JSON.stringify(endpoint.requestBodyExample, null, 2) : "",
response: null,
responseError: null,
responseTime: null,
@@ -97,27 +95,24 @@ export const usePlaygroundStore = create<PlaygroundState>((set, get) => ({
startTime: "",
endTime: "",
timeZone: getDefaultTimezone(),
- setStartDate: (date) => set({ startDate: date }),
- setEndDate: (date) => set({ endDate: date }),
- setStartTime: (time) => set({ startTime: time }),
- setEndTime: (time) => set({ endTime: time }),
- setTimeZone: (tz) => set({ timeZone: tz }),
+ setStartDate: date => set({ startDate: date }),
+ setEndDate: date => set({ endDate: date }),
+ setStartTime: time => set({ startTime: time }),
+ setEndTime: time => set({ endTime: time }),
+ setTimeZone: tz => set({ timeZone: tz }),
// Filters
filters: [],
addFilter: () =>
- set((state) => ({
- filters: [
- ...state.filters,
- { parameter: "country", operator: "equals", value: "" },
- ],
+ set(state => ({
+ filters: [...state.filters, { parameter: "country", operator: "equals", value: "" }],
})),
updateFilter: (index, filter) =>
- set((state) => ({
+ set(state => ({
filters: state.filters.map((f, i) => (i === index ? filter : f)),
})),
- removeFilter: (index) =>
- set((state) => ({
+ removeFilter: index =>
+ set(state => ({
filters: state.filters.filter((_, i) => i !== index),
})),
clearFilters: () => set({ filters: [] }),
@@ -125,18 +120,18 @@ export const usePlaygroundStore = create<PlaygroundState>((set, get) => ({
getApiFilters: () => {
const { filters } = get();
return filters
- .filter((f) => f.value.trim() !== "")
- .map((f) => ({
- parameter: f.parameter as Filter["parameter"],
- type: f.operator as Filter["type"],
- value: [f.value] as (string | number)[],
+ .filter(f => f.operator === "is_null" || f.operator === "is_not_null" || f.value.trim() !== "")
+ .map(f => ({
+ parameter: f.parameter,
+ type: f.operator,
+ value: f.operator === "is_null" || f.operator === "is_not_null" ? [] : ([f.value] as (string | number)[]),
}));
},
// Endpoint params
endpointParams: {},
setEndpointParam: (key, value) =>
- set((state) => ({
+ set(state => ({
endpointParams: { ...state.endpointParams, [key]: value },
})),
clearEndpointParams: () => set({ endpointParams: {} }),
@@ -144,14 +139,14 @@ export const usePlaygroundStore = create<PlaygroundState>((set, get) => ({
// Path params
pathParams: {},
setPathParam: (key, value) =>
- set((state) => ({
+ set(state => ({
pathParams: { ...state.pathParams, [key]: value },
})),
clearPathParams: () => set({ pathParams: {} }),
// Request body
requestBody: "",
- setRequestBody: (body) => set({ requestBody: body }),
+ setRequestBody: body => set({ requestBody: body }),
// Response
response: null,
@@ -165,15 +160,14 @@ export const usePlaygroundStore = create<PlaygroundState>((set, get) => ({
responseError: null,
isLoading: false,
}),
- setResponseError: (error) =>
+ setResponseError: error =>
set({
responseError: error,
response: null,
isLoading: false,
}),
- setIsLoading: (loading) => set({ isLoading: loading }),
- clearResponse: () =>
- set({ response: null, responseError: null, responseTime: null }),
+ setIsLoading: loading => set({ isLoading: loading }),
+ clearResponse: () => set({ response: null, responseError: null, responseTime: null }),
// Reset
reset: () =>
@@ -197,27 +191,50 @@ export const usePlaygroundStore = create<PlaygroundState>((set, get) => ({
// Filter parameter options (hardcoded, no dynamic fetching)
export const filterParameters = [
+ { value: "pathname", label: "Path" },
+ { value: "page_title", label: "Page Title" },
+ { value: "querystring", label: "Query" },
+ { value: "hostname", label: "Hostname" },
+ { value: "user_id", label: "User ID" },
+ { value: "event_name", label: "Event Name" },
+ { value: "referrer", label: "Referrer" },
+ { value: "channel", label: "Channel" },
+ { value: "entry_page", label: "Entry Page" },
+ { value: "exit_page", label: "Exit Page" },
{ value: "country", label: "Country" },
{ value: "region", label: "Region" },
{ value: "city", label: "City" },
- { value: "browser", label: "Browser" },
- { value: "operating_system", label: "Operating System" },
{ value: "device_type", label: "Device Type" },
- { value: "pathname", label: "Path" },
- { value: "referrer", label: "Referrer" },
+ { value: "operating_system", label: "Operating System" },
+ { value: "operating_system_version", label: "Operating System Version" },
+ { value: "browser", label: "Browser" },
+ { value: "browser_version", label: "Browser Version" },
+ { value: "language", label: "Language" },
+ { value: "dimensions", label: "Screen Dimensions" },
{ value: "utm_source", label: "UTM Source" },
{ value: "utm_medium", label: "UTM Medium" },
{ value: "utm_campaign", label: "UTM Campaign" },
- { value: "channel", label: "Channel" },
- { value: "entry_page", label: "Entry Page" },
- { value: "exit_page", label: "Exit Page" },
- { value: "language", label: "Language" },
-];
+ { value: "utm_term", label: "UTM Term" },
+ { value: "utm_content", label: "UTM Content" },
+ { value: "tag", label: "Tag" },
+ { value: "lat", label: "Lat" },
+ { value: "lon", label: "Lon" },
+ { value: "timezone", label: "Timezone" },
+] satisfies { value: FilterParameter; label: string }[];
export const filterOperators = [
{ value: "equals", label: "Equals" },
{ value: "not_equals", label: "Not Equals" },
{ value: "contains", label: "Contains" },
{ value: "not_contains", label: "Not Contains" },
+ { value: "starts_with", label: "Starts With" },
+ { value: "ends_with", label: "Ends With" },
{ value: "regex", label: "Regex" },
-];
+ { value: "not_regex", label: "Not Regex" },
+ { value: "is_null", label: "Is Null" },
+ { value: "is_not_null", label: "Is Not Null" },
+ { value: "greater_than", label: "Greater Than" },
+ { value: "less_than", label: "Less Than" },
+ { value: "greater_than_or_equal", label: "Greater Than or Equal" },
+ { value: "less_than_or_equal", label: "Less Than or Equal" },
+] satisfies { value: FilterType; label: string }[];
diff --git a/client/src/app/[site]/api-playground/utils/endpointConfig.ts b/client/src/app/[site]/api-playground/utils/endpointConfig.ts
index 342c69d02..a691dda2c 100644
--- a/client/src/app/[site]/api-playground/utils/endpointConfig.ts
+++ b/client/src/app/[site]/api-playground/utils/endpointConfig.ts
@@ -1,5 +1,12 @@
export type HttpMethod = "GET" | "POST" | "PUT" | "DELETE";
+type ParameterMetadata = {
+ label: string;
+ type: "text" | "number" | "select";
+ options?: string[];
+ placeholder?: string;
+};
+
export interface EndpointConfig {
method: HttpMethod;
path: string;
@@ -11,6 +18,7 @@ export interface EndpointConfig {
pathParams?: string[];
hasRequestBody?: boolean;
requestBodyExample?: object;
+ parameterMetadata?: Record<string, ParameterMetadata>;
}
export interface EndpointCategory {
@@ -29,6 +37,20 @@ export const endpointCategories: EndpointCategory[] = [
description: "Returns details for a specific site",
hasCommonParams: false,
},
+ {
+ method: "GET",
+ path: "/sites/:site/has-data",
+ name: "Get Site Has Data",
+ description: "Returns whether the site has received analytics events",
+ hasCommonParams: false,
+ },
+ {
+ method: "GET",
+ path: "/sites/:site/is-public",
+ name: "Get Site Public Status",
+ description: "Returns whether the site is publicly accessible",
+ hasCommonParams: false,
+ },
{
method: "DELETE",
path: "/sites/:site",
@@ -63,6 +85,13 @@ export const endpointCategories: EndpointCategory[] = [
description: "Returns the list of excluded country codes",
hasCommonParams: false,
},
+ {
+ method: "GET",
+ path: "/sites/:site/verify-script",
+ name: "Verify Tracking Script",
+ description: "Checks whether the site has the tracking script installed",
+ hasCommonParams: false,
+ },
{
method: "GET",
path: "/sites/:site/private-link-config",
@@ -90,7 +119,8 @@ export const endpointCategories: EndpointCategory[] = [
method: "GET",
path: "/organizations",
name: "Get My Organizations",
- description: "Returns all organizations the authenticated user is a member of, including all members for each organization",
+ description:
+ "Returns all organizations the authenticated user is a member of, including all members for each organization",
hasCommonParams: false,
},
{
@@ -123,6 +153,14 @@ export const endpointCategories: EndpointCategory[] = [
tags: [],
},
},
+ {
+ method: "GET",
+ path: "/organizations/:organizationId/sites",
+ name: "Get Organization Sites",
+ description: "Returns all sites in an organization visible to the authenticated user",
+ hasCommonParams: false,
+ pathParams: ["organizationId"],
+ },
{
method: "GET",
path: "/organizations/:organizationId/members",
@@ -173,6 +211,14 @@ export const endpointCategories: EndpointCategory[] = [
specificParams: ["parameter", "limit", "page"],
requiredParams: ["parameter"],
},
+ {
+ method: "GET",
+ path: "/sites/:site/page-titles",
+ name: "Get Page Titles",
+ description: "Returns page title metrics with pagination",
+ hasCommonParams: true,
+ specificParams: ["limit", "page"],
+ },
{
method: "GET",
path: "/sites/:site/live-user-count",
@@ -201,6 +247,22 @@ export const endpointCategories: EndpointCategory[] = [
description: "Returns list of unique custom event names with counts",
hasCommonParams: true,
},
+ {
+ method: "GET",
+ path: "/sites/:site/events/bucketed",
+ name: "Get Event Time Series",
+ description: "Returns time-series counts for top custom events",
+ hasCommonParams: true,
+ specificParams: ["bucket", "limit"],
+ },
+ {
+ method: "GET",
+ path: "/sites/:site/events/count",
+ name: "Get Event Counts",
+ description: "Returns time-series event counts grouped by event type",
+ hasCommonParams: true,
+ specificParams: ["bucket"],
+ },
{
method: "GET",
path: "/sites/:site/events/properties",
@@ -344,6 +406,10 @@ export const endpointCategories: EndpointCategory[] = [
hasCommonParams: true,
pathParams: ["stepNumber"],
specificParams: ["mode", "page", "limit"],
+ requiredParams: ["mode"],
+ parameterMetadata: {
+ mode: { label: "Mode", type: "select", options: ["reached", "dropped"] },
+ },
hasRequestBody: true,
requestBodyExample: {
steps: [
@@ -403,6 +469,51 @@ export const endpointCategories: EndpointCategory[] = [
hasCommonParams: true,
requiredParams: ["dimension"],
specificParams: ["dimension", "page", "limit", "sort_by", "sort_order"],
+ parameterMetadata: {
+ dimension: {
+ label: "Dimension",
+ type: "select",
+ options: ["pathname", "country", "region", "browser", "operating_system", "device_type"],
+ },
+ sort_by: {
+ label: "Sort By",
+ type: "select",
+ options: [
+ "pathname",
+ "country",
+ "region",
+ "browser",
+ "operating_system",
+ "device_type",
+ "event_count",
+ "lcp_avg",
+ "lcp_p50",
+ "lcp_p75",
+ "lcp_p90",
+ "lcp_p99",
+ "cls_avg",
+ "cls_p50",
+ "cls_p75",
+ "cls_p90",
+ "cls_p99",
+ "inp_avg",
+ "inp_p50",
+ "inp_p75",
+ "inp_p90",
+ "inp_p99",
+ "fcp_avg",
+ "fcp_p50",
+ "fcp_p75",
+ "fcp_p90",
+ "fcp_p99",
+ "ttfb_avg",
+ "ttfb_p50",
+ "ttfb_p75",
+ "ttfb_p90",
+ "ttfb_p99",
+ ],
+ },
+ },
},
],
},
@@ -415,7 +526,7 @@ export const endpointCategories: EndpointCategory[] = [
name: "Get Sessions",
description: "Returns a paginated list of sessions",
hasCommonParams: true,
- specificParams: ["page", "limit", "user_id", "identified_only"],
+ specificParams: ["page", "limit", "user_id", "identified_only", "min_pageviews", "min_events", "min_duration"],
},
{
method: "GET",
@@ -424,7 +535,7 @@ export const endpointCategories: EndpointCategory[] = [
description: "Returns detailed session information with events",
hasCommonParams: false,
pathParams: ["sessionId"],
- specificParams: ["limit", "offset"],
+ specificParams: ["limit", "offset", "minutes"],
},
{
method: "GET",
@@ -435,6 +546,35 @@ export const endpointCategories: EndpointCategory[] = [
},
],
},
+ {
+ name: "Session Replay",
+ endpoints: [
+ {
+ method: "GET",
+ path: "/sites/:site/session-replay/list",
+ name: "Get Session Replays",
+ description: "Returns session replay recordings with pagination",
+ hasCommonParams: true,
+ specificParams: ["limit", "offset", "userId", "minDuration"],
+ },
+ {
+ method: "GET",
+ path: "/sites/:site/session-replay/:sessionId",
+ name: "Get Session Replay Events",
+ description: "Returns rrweb events and metadata for a session replay",
+ hasCommonParams: false,
+ pathParams: ["sessionId"],
+ },
+ {
+ method: "DELETE",
+ path: "/sites/:site/session-replay/:sessionId",
+ name: "Delete Session Replay",
+ description: "Deletes a session replay recording",
+ hasCommonParams: false,
+ pathParams: ["sessionId"],
+ },
+ ],
+ },
{
name: "Users",
endpoints: [
@@ -444,7 +584,14 @@ export const endpointCategories: EndpointCategory[] = [
name: "Get Users",
description: "Returns a paginated list of users",
hasCommonParams: true,
- specificParams: ["page", "page_size", "sort_by", "sort_order", "identified_only"],
+ specificParams: ["page", "page_size", "sort_by", "sort_order", "identified_only", "search", "search_field"],
+ parameterMetadata: {
+ sort_by: {
+ label: "Sort By",
+ type: "select",
+ options: ["first_seen", "last_seen", "pageviews", "sessions", "events"],
+ },
+ },
},
{
method: "GET",
@@ -452,6 +599,7 @@ export const endpointCategories: EndpointCategory[] = [
name: "Get User Session Count",
description: "Returns daily session counts for a specific user",
hasCommonParams: false,
+ requiredParams: ["user_id"],
specificParams: ["user_id", "time_zone"],
},
{
@@ -464,6 +612,36 @@ export const endpointCategories: EndpointCategory[] = [
},
],
},
+ {
+ name: "User Traits",
+ endpoints: [
+ {
+ method: "GET",
+ path: "/sites/:site/user-traits/keys",
+ name: "Get User Trait Keys",
+ description: "Returns known user trait keys with user counts",
+ hasCommonParams: false,
+ },
+ {
+ method: "GET",
+ path: "/sites/:site/user-traits/values",
+ name: "Get User Trait Values",
+ description: "Returns values for a user trait key",
+ hasCommonParams: false,
+ requiredParams: ["key"],
+ specificParams: ["key", "limit", "offset"],
+ },
+ {
+ method: "GET",
+ path: "/sites/:site/user-traits/users",
+ name: "Get Users by Trait",
+ description: "Returns users matching a trait key and value",
+ hasCommonParams: false,
+ requiredParams: ["key", "value"],
+ specificParams: ["key", "value", "limit", "offset"],
+ },
+ ],
+ },
{
name: "Misc",
endpoints: [
@@ -474,6 +652,9 @@ export const endpointCategories: EndpointCategory[] = [
description: "Returns cohort-based retention analysis",
hasCommonParams: false,
specificParams: ["mode", "range"],
+ parameterMetadata: {
+ mode: { label: "Mode", type: "select", options: ["day", "week"] },
+ },
},
{
method: "GET",
@@ -481,7 +662,16 @@ export const endpointCategories: EndpointCategory[] = [
name: "Get Journeys",
description: "Returns most common page navigation paths",
hasCommonParams: true,
- specificParams: ["steps", "limit"],
+ specificParams: ["steps", "limit", "stepFilters"],
+ },
+ {
+ method: "GET",
+ path: "/org-event-count/:organizationId",
+ name: "Get Organization Event Count",
+ description: "Returns daily event usage counts for an organization",
+ hasCommonParams: false,
+ pathParams: ["organizationId"],
+ specificParams: ["start_date", "end_date", "time_zone"],
},
],
},
@@ -491,10 +681,7 @@ export const endpointCategories: EndpointCategory[] = [
export const allEndpoints: EndpointConfig[] = endpointCategories.flatMap(cat => cat.endpoints);
// Parameter metadata for dynamic form generation
-export const parameterMetadata: Record<
- string,
- { label: string; type: "text" | "number" | "select"; options?: string[]; placeholder?: string }
-> = {
+export const parameterMetadata: Record<string, ParameterMetadata> = {
bucket: {
label: "Bucket",
type: "select",
@@ -506,29 +693,39 @@ export const parameterMetadata: Record<
options: [
"pathname",
"page_title",
+ "querystring",
+ "hostname",
+ "user_id",
+ "event_name",
+ "referrer",
+ "channel",
+ "entry_page",
+ "exit_page",
"country",
"region",
"city",
- "browser",
- "operating_system",
"device_type",
- "referrer",
- "channel",
+ "operating_system",
+ "operating_system_version",
+ "browser",
+ "browser_version",
+ "language",
+ "dimensions",
"utm_source",
"utm_medium",
"utm_campaign",
"utm_term",
"utm_content",
- "language",
- "entry_page",
- "exit_page",
- "event_name",
+ "tag",
+ "lat",
+ "lon",
+ "timezone",
],
},
dimension: {
label: "Dimension",
type: "select",
- options: ["pathname", "country", "browser", "operating_system", "device_type"],
+ options: ["pathname", "country", "region", "browser", "operating_system", "device_type"],
},
mode: {
label: "Mode",
@@ -558,15 +755,27 @@ export const parameterMetadata: Record<
page: { label: "Page", type: "number", placeholder: "1" },
limit: { label: "Limit", type: "number", placeholder: "10" },
page_size: { label: "Page Size", type: "number", placeholder: "10" },
+ min_pageviews: { label: "Min Pageviews", type: "number", placeholder: "0" },
+ min_events: { label: "Min Events", type: "number", placeholder: "0" },
+ min_duration: { label: "Min Duration (s)", type: "number", placeholder: "0" },
+ minDuration: { label: "Min Duration (s)", type: "number", placeholder: "30" },
minutes: { label: "Minutes", type: "number", placeholder: "5" },
steps: { label: "Steps", type: "number", placeholder: "3" },
+ stepFilters: { label: "Step Filters", type: "text", placeholder: 'JSON, e.g. {"1":"/pricing"}' },
range: { label: "Range (days)", type: "number", placeholder: "90" },
offset: { label: "Offset", type: "number", placeholder: "0" },
+ start_date: { label: "Start Date", type: "text", placeholder: "YYYY-MM-DD" },
+ end_date: { label: "End Date", type: "text", placeholder: "YYYY-MM-DD" },
since_timestamp: { label: "Since Timestamp", type: "text", placeholder: "ISO 8601, e.g. 2024-01-31T14:00:00.000Z" },
before_timestamp: { label: "Before Timestamp", type: "text", placeholder: "ISO 8601, e.g. 2024-01-31T14:00:00.000Z" },
event_name: { label: "Event Name", type: "text", placeholder: "e.g., purchase" },
errorMessage: { label: "Error Message", type: "text", placeholder: "Error message to filter by" },
user_id: { label: "User ID", type: "text", placeholder: "User ID" },
+ userId: { label: "User ID", type: "text", placeholder: "User ID" },
+ key: { label: "Key", type: "text", placeholder: "Trait key" },
+ value: { label: "Value", type: "text", placeholder: "Trait value" },
+ search: { label: "Search", type: "text", placeholder: "Search users" },
+ search_field: { label: "Search Field", type: "select", options: ["username", "name", "email", "user_id"] },
time_zone: { label: "Time Zone", type: "text", placeholder: "America/New_York" },
identified_only: { label: "Identified Only", type: "select", options: ["true", "false"] },
// Path params
@@ -574,7 +783,6 @@ export const parameterMetadata: Record<
goalId: { label: "Goal ID", type: "number", placeholder: "Goal ID" },
funnelId: { label: "Funnel ID", type: "number", placeholder: "Funnel ID" },
sessionId: { label: "Session ID", type: "text", placeholder: "Session ID" },
- userId: { label: "User ID", type: "text", placeholder: "User ID" },
stepNumber: { label: "Step Number", type: "number", placeholder: "Step number (1-indexed)" },
siteId: { label: "Site ID", type: "number", placeholder: "Site ID" },
organizationId: { label: "Organization ID", type: "text", placeholder: "org_abc123" },
diff --git a/client/src/app/[site]/api-playground/utils/queryParams.ts b/client/src/app/[site]/api-playground/utils/queryParams.ts
index afbbe0452..5fcb402d4 100644
--- a/client/src/app/[site]/api-playground/utils/queryParams.ts
+++ b/client/src/app/[site]/api-playground/utils/queryParams.ts
@@ -1,8 +1,9 @@
import { DateTime } from "luxon";
+import { FilterParameter, FilterType } from "@rybbit/shared";
type PlaygroundFilter = {
- parameter: string;
- operator: string;
+ parameter: FilterParameter;
+ operator: FilterType;
value: string;
};
@@ -16,9 +17,7 @@ type CommonQueryParamInput = {
};
const toUtcDateTimeParam = (date: string, time: string, timeZone: string) =>
- DateTime.fromISO(`${date}T${time}`, { zone: timeZone })
- .toUTC()
- .toFormat("yyyy-MM-dd HH:mm:ss");
+ DateTime.fromISO(`${date}T${time}`, { zone: timeZone }).toUTC().toFormat("yyyy-MM-dd HH:mm:ss");
export const buildCommonQueryParams = ({
startDate,
@@ -42,11 +41,11 @@ export const buildCommonQueryParams = ({
};
const apiFilters = filters
- .filter(f => f.value.trim() !== "")
+ .filter(f => f.operator === "is_null" || f.operator === "is_not_null" || f.value.trim() !== "")
.map(f => ({
parameter: f.parameter,
type: f.operator,
- value: [f.value],
+ value: f.operator === "is_null" || f.operator === "is_not_null" ? [] : [f.value],
}));
if (apiFilters.length > 0) {
diff --git a/docs/content/docs/self-host-vs-cloud.mdx b/docs/content/docs/self-host-vs-cloud.mdx
index 56953309c..761320d29 100644
--- a/docs/content/docs/self-host-vs-cloud.mdx
+++ b/docs/content/docs/self-host-vs-cloud.mdx
@@ -24,10 +24,9 @@ Rybbit offers two deployment options: a fully-managed [cloud version](https://ry
| **Users** | <Check className="w-5 h-5 inline" color="green" strokeWidth={3}/> | <Check className="w-5 h-5 inline" color="green" strokeWidth={3} /> |
| **Retention** | <Check className="w-5 h-5 inline" color="green" strokeWidth={3}/> | <Check className="w-5 h-5 inline" color="green" strokeWidth={3} /> |
| **Error tracking** | <Check className="w-5 h-5 inline" color="green" strokeWidth={3}/> | <Check className="w-5 h-5 inline" color="green" strokeWidth={3} /> |
-| **Organizations** | <Check className="w-5 h-5 inline" color="green" strokeWidth={3}/> | <Check className="w-5 h-5 inline" color="green" strokeWidth={3} /> |
+| **Organizations/Teams** | <Check className="w-5 h-5 inline" color="green" strokeWidth={3}/> | <Check className="w-5 h-5 inline" color="green" strokeWidth={3} /> |
| **Pages View** | <Check className="w-5 h-5 inline" color="green" strokeWidth={3}/> | <Minus className="w-5 h-5 inline" color="gray" strokeWidth={3} /> |
| **Web Vitals** | <Check className="w-5 h-5 inline" color="green" strokeWidth={3}/> | <Minus className="w-5 h-5 inline" color="gray" strokeWidth={3} /> |
| **Email reports** | <Check className="w-5 h-5 inline" color="green" strokeWidth={3}/> | <Minus className="w-5 h-5 inline" color="gray" strokeWidth={3} /> |
| **Google Search Console integration** | <Check className="w-5 h-5 inline" color="green" strokeWidth={3}/> | <Minus className="w-5 h-5 inline" color="gray" strokeWidth={3} /> |
-| **VPN/Crawler/ASN tracking** | <Check className="w-5 h-5 inline" color="green" strokeWidth={3}/> | <Minus className="w-5 h-5 inline" color="gray" strokeWidth={3} /> |