Skip to content

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

Refactor API endpoints to standardize site path structure (#794)

Bill Yang80f618d39ed6
diff --git a/client/src/api/admin/endpoints/sites.ts b/client/src/api/admin/endpoints/sites.ts
index d009a1030..80f7b55e7 100644
--- a/client/src/api/admin/endpoints/sites.ts
+++ b/client/src/api/admin/endpoints/sites.ts
@@ -129,9 +129,9 @@ export function fetchSite(siteId: string | number) {
}
export function fetchSiteHasData(siteId: string) {
- return authedFetch<{ hasData: boolean }>(`/site-has-data/${siteId}`);
+ return authedFetch<{ hasData: boolean }>(`/sites/${siteId}/has-data`);
}
export function fetchSiteIsPublic(siteId: string | number) {
- return authedFetch<{ isPublic: boolean }>(`/site-is-public/${siteId}`);
+ return authedFetch<{ isPublic: boolean }>(`/sites/${siteId}/is-public`);
}
diff --git a/client/src/api/analytics/endpoints/errors.ts b/client/src/api/analytics/endpoints/errors.ts
index 992a50de0..a77a00527 100644
--- a/client/src/api/analytics/endpoints/errors.ts
+++ b/client/src/api/analytics/endpoints/errors.ts
@@ -86,7 +86,7 @@ export async function fetchErrorNames(
};
const response = await authedFetch<{ data: ErrorNamesPaginatedResponse }>(
- `/error-names/${site}`,
+ `/sites/${site}/error-names`,
queryParams
);
return response.data;
@@ -108,7 +108,7 @@ export async function fetchErrorEvents(
};
const response = await authedFetch<{ data: ErrorEventsPaginatedResponse }>(
- `/error-events/${site}`,
+ `/sites/${site}/error-events`,
queryParams
);
return response.data;
@@ -129,7 +129,7 @@ export async function fetchErrorBucketed(
};
const response = await authedFetch<{ data: GetErrorBucketedResponse }>(
- `/error-bucketed/${site}`,
+ `/sites/${site}/error-bucketed`,
queryParams
);
return response.data;
diff --git a/client/src/api/analytics/endpoints/events.ts b/client/src/api/analytics/endpoints/events.ts
index daea9208d..30bf32aeb 100644
--- a/client/src/api/analytics/endpoints/events.ts
+++ b/client/src/api/analytics/endpoints/events.ts
@@ -73,7 +73,7 @@ export async function fetchEvents(
};
const response = await authedFetch<EventsResponse>(
- `/events/${site}`,
+ `/sites/${site}/events`,
queryParams
);
return response;
@@ -88,7 +88,7 @@ export async function fetchEventNames(
params: CommonApiParams
): Promise<EventName[]> {
const response = await authedFetch<{ data: EventName[] }>(
- `/events/names/${site}`,
+ `/sites/${site}/events/names`,
toQueryParams(params)
);
return response.data;
@@ -108,7 +108,7 @@ export async function fetchEventProperties(
};
const response = await authedFetch<{ data: EventProperty[] }>(
- `/events/properties/${site}`,
+ `/sites/${site}/events/properties`,
queryParams
);
return response.data;
@@ -123,7 +123,7 @@ export async function fetchOutboundLinks(
params: CommonApiParams
): Promise<OutboundLink[]> {
const response = await authedFetch<{ data: OutboundLink[] }>(
- `/events/outbound/${site}`,
+ `/sites/${site}/events/outbound`,
toQueryParams(params)
);
return response.data;
diff --git a/client/src/api/analytics/endpoints/funnels.ts b/client/src/api/analytics/endpoints/funnels.ts
index 415c22f1f..606075034 100644
--- a/client/src/api/analytics/endpoints/funnels.ts
+++ b/client/src/api/analytics/endpoints/funnels.ts
@@ -70,7 +70,7 @@ export async function fetchFunnels(
site: string | number
): Promise<SavedFunnel[]> {
const response = await authedFetch<{ data: SavedFunnel[] }>(
- `/funnels/${site}`
+ `/sites/${site}/funnels`
);
return response.data;
}
@@ -86,7 +86,7 @@ export async function analyzeFunnel(
const queryParams = toQueryParams(params);
const response = await authedFetch<{ data: FunnelResponse[] }>(
- `/funnels/analyze/${site}`,
+ `/sites/${site}/funnels/analyze`,
queryParams,
{
method: "POST",
@@ -115,7 +115,7 @@ export async function fetchFunnelStepSessions(
};
const response = await authedFetch<{ data: GetSessionsResponse }>(
- `/funnels/${params.stepNumber}/sessions/${site}`,
+ `/sites/${site}/funnels/${params.stepNumber}/sessions`,
queryParams,
{
method: "POST",
@@ -134,7 +134,7 @@ export async function saveFunnel(
params: SaveFunnelParams
): Promise<{ success: boolean; funnelId: number }> {
const response = await authedFetch<{ success: boolean; funnelId: number }>(
- `/funnels/${site}`,
+ `/sites/${site}/funnels`,
undefined,
{
method: "POST",
@@ -153,7 +153,7 @@ export async function deleteFunnel(
funnelId: number
): Promise<{ success: boolean }> {
const response = await authedFetch<{ success: boolean }>(
- `/funnels/${funnelId}/${site}`,
+ `/sites/${site}/funnels/${funnelId}`,
undefined,
{
method: "DELETE",
diff --git a/client/src/api/analytics/endpoints/goals.ts b/client/src/api/analytics/endpoints/goals.ts
index 58cf890cc..a99404806 100644
--- a/client/src/api/analytics/endpoints/goals.ts
+++ b/client/src/api/analytics/endpoints/goals.ts
@@ -74,7 +74,7 @@ export async function fetchGoals(
order: params.order,
};
- const response = await authedFetch<GoalsResponse>(`/goals/${site}`, queryParams);
+ const response = await authedFetch<GoalsResponse>(`/sites/${site}/goals`, queryParams);
return response;
}
@@ -93,7 +93,7 @@ export async function fetchGoalSessions(
};
const response = await authedFetch<{ data: GetSessionsResponse }>(
- `/goals/${params.goalId}/sessions/${site}`,
+ `/sites/${site}/goals/${params.goalId}/sessions`,
queryParams
);
return response;
@@ -108,7 +108,7 @@ export async function createGoal(
params: CreateGoalParams
): Promise<{ success: boolean; goalId: number }> {
const response = await authedFetch<{ success: boolean; goalId: number }>(
- `/goals/${site}`,
+ `/sites/${site}/goals`,
undefined,
{
method: "POST",
@@ -127,7 +127,7 @@ export async function updateGoal(
params: UpdateGoalParams
): Promise<{ success: boolean; goalId: number }> {
const response = await authedFetch<{ success: boolean; goalId: number }>(
- `/goals/${params.goalId}/${site}`,
+ `/sites/${site}/goals/${params.goalId}`,
undefined,
{
method: "PUT",
@@ -146,7 +146,7 @@ export async function deleteGoal(
goalId: number
): Promise<{ success: boolean }> {
const response = await authedFetch<{ success: boolean }>(
- `/goals/${goalId}/${site}`,
+ `/sites/${site}/goals/${goalId}`,
undefined,
{
method: "DELETE",
diff --git a/client/src/api/analytics/endpoints/misc.ts b/client/src/api/analytics/endpoints/misc.ts
index c1e2440c1..65c9518f0 100644
--- a/client/src/api/analytics/endpoints/misc.ts
+++ b/client/src/api/analytics/endpoints/misc.ts
@@ -73,7 +73,7 @@ export async function fetchRetention(
const { mode = "week", range = 90 } = params;
const response = await authedFetch<{ data: ProcessedRetentionData }>(
- `/retention/${site}`,
+ `/sites/${site}/retention`,
{ mode, range }
);
return response.data;
@@ -98,7 +98,7 @@ export async function fetchJourneys(
};
const response = await authedFetch<JourneysResponse>(
- `/journeys/${site}`,
+ `/sites/${site}/journeys`,
queryParams
);
return response;
@@ -129,7 +129,7 @@ export async function fetchPageTitles(
};
const response = await authedFetch<{ data: PageTitlesPaginatedResponse }>(
- `/page-titles/${site}`,
+ `/sites/${site}/page-titles`,
queryParams
);
return response.data;
diff --git a/client/src/api/analytics/endpoints/overview.ts b/client/src/api/analytics/endpoints/overview.ts
index ad028c014..0f85c1595 100644
--- a/client/src/api/analytics/endpoints/overview.ts
+++ b/client/src/api/analytics/endpoints/overview.ts
@@ -55,7 +55,7 @@ export async function fetchOverview(
params: CommonApiParams
): Promise<GetOverviewResponse> {
const response = await authedFetch<{ data: GetOverviewResponse }>(
- `/overview/${site}`,
+ `/sites/${site}/overview`,
toQueryParams(params)
);
return response.data;
@@ -70,7 +70,7 @@ export async function fetchOverviewBucketed(
params: BucketedParams
): Promise<GetOverviewBucketedResponse> {
const response = await authedFetch<{ data: GetOverviewBucketedResponse }>(
- `/overview-bucketed/${site}`,
+ `/sites/${site}/overview-bucketed`,
toBucketedQueryParams(params)
);
return response.data;
@@ -86,7 +86,7 @@ export async function fetchMetric(
): Promise<{ data: MetricResponse[]; totalCount: number }> {
const response = await authedFetch<{
data: { data: MetricResponse[]; totalCount: number };
- }>(`/metric/${site}`, toMetricQueryParams(params));
+ }>(`/sites/${site}/metric`, toMetricQueryParams(params));
return response.data;
}
@@ -99,7 +99,7 @@ export async function fetchLiveUserCount(
minutes: number = 5
): Promise<LiveUserCountResponse> {
const response = await authedFetch<LiveUserCountResponse>(
- `/live-user-count/${site}`,
+ `/sites/${site}/live-user-count`,
{ minutes }
);
return response;
diff --git a/client/src/api/analytics/endpoints/performance.ts b/client/src/api/analytics/endpoints/performance.ts
index 5a3047b0d..b22ae8ff2 100644
--- a/client/src/api/analytics/endpoints/performance.ts
+++ b/client/src/api/analytics/endpoints/performance.ts
@@ -112,7 +112,7 @@ export async function fetchPerformanceOverview(
};
const response = await authedFetch<{ data: GetPerformanceOverviewResponse }>(
- `/performance/overview/${site}`,
+ `/sites/${site}/performance/overview`,
queryParams
);
return response.data;
@@ -132,7 +132,7 @@ export async function fetchPerformanceTimeSeries(
};
const response = await authedFetch<{ data: GetPerformanceTimeSeriesResponse }>(
- `/performance/time-series/${site}`,
+ `/sites/${site}/performance/time-series`,
queryParams
);
return response.data;
@@ -157,7 +157,7 @@ export async function fetchPerformanceByDimension(
};
const response = await authedFetch<{ data: PaginatedPerformanceResponse }>(
- `/performance/by-dimension/${site}`,
+ `/sites/${site}/performance/by-dimension`,
queryParams
);
return response.data;
diff --git a/client/src/api/analytics/endpoints/sessionReplay.ts b/client/src/api/analytics/endpoints/sessionReplay.ts
index 66a9f9622..ce0c44c5d 100644
--- a/client/src/api/analytics/endpoints/sessionReplay.ts
+++ b/client/src/api/analytics/endpoints/sessionReplay.ts
@@ -98,7 +98,7 @@ export async function fetchSessionReplays(
min_duration: params.minDuration,
};
- const response = await authedFetch<SessionReplayListResponse>(`/session-replay/list/${site}`, queryParams);
+ const response = await authedFetch<SessionReplayListResponse>(`/sites/${site}/session-replay/list`, queryParams);
return response;
}
@@ -110,7 +110,7 @@ export async function fetchSessionReplayEvents(
site: string | number,
sessionId: string
): Promise<GetSessionReplayEventsResponse> {
- const response = await authedFetch<GetSessionReplayEventsResponse>(`/session-replay/${sessionId}/${site}`);
+ const response = await authedFetch<GetSessionReplayEventsResponse>(`/sites/${site}/session-replay/${sessionId}`);
return response;
}
@@ -119,7 +119,7 @@ export async function fetchSessionReplayEvents(
* DELETE /api/session-replay/:sessionId/:site
*/
export async function deleteSessionReplay(site: string | number, sessionId: string): Promise<{ success: boolean }> {
- const response = await authedFetch<{ success: boolean }>(`/session-replay/${sessionId}/${site}`, undefined, {
+ const response = await authedFetch<{ success: boolean }>(`/sites/${site}/session-replay/${sessionId}`, undefined, {
method: "DELETE",
});
return response;
diff --git a/client/src/api/analytics/endpoints/sessions.ts b/client/src/api/analytics/endpoints/sessions.ts
index ab5380d3f..90ef131c8 100644
--- a/client/src/api/analytics/endpoints/sessions.ts
+++ b/client/src/api/analytics/endpoints/sessions.ts
@@ -139,7 +139,7 @@ export async function fetchSessions(
};
const response = await authedFetch<{ data: GetSessionsResponse }>(
- `/sessions/${site}`,
+ `/sites/${site}/sessions`,
queryParams
);
return response;
@@ -163,7 +163,7 @@ export async function fetchSession(
}
const response = await authedFetch<{ data: SessionPageviewsAndEvents }>(
- `/sessions/${params.sessionId}/${site}`,
+ `/sites/${site}/sessions/${params.sessionId}`,
queryParams
);
return response;
@@ -178,7 +178,7 @@ export async function fetchSessionLocations(
params: CommonApiParams
): Promise<LiveSessionLocation[]> {
const response = await authedFetch<{ data: LiveSessionLocation[] }>(
- `/session-locations/${site}`,
+ `/sites/${site}/session-locations`,
toQueryParams(params)
);
return response.data;
diff --git a/client/src/api/analytics/endpoints/users.ts b/client/src/api/analytics/endpoints/users.ts
index 372c908f9..3f03309d1 100644
--- a/client/src/api/analytics/endpoints/users.ts
+++ b/client/src/api/analytics/endpoints/users.ts
@@ -96,7 +96,7 @@ export async function fetchUsers(site: string | number, params: UsersParams): Pr
identified_only: params.identifiedOnly,
};
- const response = await authedFetch<UsersListResponse>(`/users/${site}`, queryParams);
+ const response = await authedFetch<UsersListResponse>(`/sites/${site}/users`, queryParams);
return response;
}
@@ -108,7 +108,7 @@ export async function fetchUserSessionCount(
site: string | number,
params: UserSessionCountParams
): Promise<{ data: UserSessionCountResponse[] }> {
- const response = await authedFetch<{ data: UserSessionCountResponse[] }>(`/users/session-count/${site}`, {
+ const response = await authedFetch<{ data: UserSessionCountResponse[] }>(`/sites/${site}/users/session-count`, {
user_id: params.userId,
time_zone: params.timeZone,
});
@@ -120,6 +120,6 @@ export async function fetchUserSessionCount(
* GET /api/users/:userId/:site
*/
export async function fetchUserInfo(site: string | number, userId: string): Promise<UserInfo> {
- const response = await authedFetch<{ data: UserInfo }>(`/users/${encodeURIComponent(userId)}/${site}`);
+ const response = await authedFetch<{ data: UserInfo }>(`/sites/${site}/users/${encodeURIComponent(userId)}`);
return response.data;
}
diff --git a/client/src/app/[site]/api-playground/utils/endpointConfig.ts b/client/src/app/[site]/api-playground/utils/endpointConfig.ts
index c9362621d..4143902be 100644
--- a/client/src/app/[site]/api-playground/utils/endpointConfig.ts
+++ b/client/src/app/[site]/api-playground/utils/endpointConfig.ts
@@ -24,14 +24,14 @@ export const endpointCategories: EndpointCategory[] = [
endpoints: [
{
method: "GET",
- path: "/overview/:site",
+ path: "/sites/:site/overview",
name: "Get Overview",
description: "Returns high-level analytics metrics for a site",
hasCommonParams: true,
},
{
method: "GET",
- path: "/overview-bucketed/:site",
+ path: "/sites/:site/overview-bucketed",
name: "Get Overview (Time Series)",
description: "Returns time-series analytics data broken down by time buckets",
hasCommonParams: true,
@@ -39,7 +39,7 @@ export const endpointCategories: EndpointCategory[] = [
},
{
method: "GET",
- path: "/metric/:site",
+ path: "/sites/:site/metric",
name: "Get Metric",
description: "Returns dimensional analytics broken down by a specific parameter",
hasCommonParams: true,
@@ -48,7 +48,7 @@ export const endpointCategories: EndpointCategory[] = [
},
{
method: "GET",
- path: "/live-user-count/:site",
+ path: "/sites/:site/live-user-count",
name: "Get Live Visitors",
description: "Returns the count of active sessions within the specified time window",
hasCommonParams: false,
@@ -61,7 +61,7 @@ export const endpointCategories: EndpointCategory[] = [
endpoints: [
{
method: "GET",
- path: "/events/:site",
+ path: "/sites/:site/events",
name: "Get Events",
description: "Returns a paginated list of events",
hasCommonParams: true,
@@ -69,14 +69,14 @@ export const endpointCategories: EndpointCategory[] = [
},
{
method: "GET",
- path: "/events/names/:site",
+ path: "/sites/:site/events/names",
name: "Get Event Names",
description: "Returns list of unique custom event names with counts",
hasCommonParams: true,
},
{
method: "GET",
- path: "/events/properties/:site",
+ path: "/sites/:site/events/properties",
name: "Get Event Properties",
description: "Returns property key-value pairs for a specific event",
hasCommonParams: true,
@@ -85,7 +85,7 @@ export const endpointCategories: EndpointCategory[] = [
},
{
method: "GET",
- path: "/events/outbound/:site",
+ path: "/sites/:site/events/outbound",
name: "Get Outbound Links",
description: "Returns outbound link clicks with occurrence counts",
hasCommonParams: true,
@@ -97,7 +97,7 @@ export const endpointCategories: EndpointCategory[] = [
endpoints: [
{
method: "GET",
- path: "/error-names/:site",
+ path: "/sites/:site/error-names",
name: "Get Error Names",
description: "Returns unique error messages with occurrence and session counts",
hasCommonParams: true,
@@ -105,7 +105,7 @@ export const endpointCategories: EndpointCategory[] = [
},
{
method: "GET",
- path: "/error-events/:site",
+ path: "/sites/:site/error-events",
name: "Get Error Events",
description: "Returns individual error occurrences with context and stack traces",
hasCommonParams: true,
@@ -114,7 +114,7 @@ export const endpointCategories: EndpointCategory[] = [
},
{
method: "GET",
- path: "/error-bucketed/:site",
+ path: "/sites/:site/error-bucketed",
name: "Get Error Time Series",
description: "Returns error occurrence counts over time",
hasCommonParams: true,
@@ -128,7 +128,7 @@ export const endpointCategories: EndpointCategory[] = [
endpoints: [
{
method: "GET",
- path: "/goals/:site",
+ path: "/sites/:site/goals",
name: "Get Goals",
description: "Returns paginated list of goals with conversion metrics",
hasCommonParams: true,
@@ -136,7 +136,7 @@ export const endpointCategories: EndpointCategory[] = [
},
{
method: "GET",
- path: "/goals/:goalId/sessions/:site",
+ path: "/sites/:site/goals/:goalId/sessions",
name: "Get Goal Sessions",
description: "Returns sessions that completed a specific goal",
hasCommonParams: true,
@@ -145,7 +145,7 @@ export const endpointCategories: EndpointCategory[] = [
},
{
method: "POST",
- path: "/goals/:site",
+ path: "/sites/:site/goals",
name: "Create Goal",
description: "Creates a new goal",
hasCommonParams: false,
@@ -160,7 +160,7 @@ export const endpointCategories: EndpointCategory[] = [
},
{
method: "PUT",
- path: "/goals/:goalId/:site",
+ path: "/sites/:site/goals/:goalId",
name: "Update Goal",
description: "Updates an existing goal",
hasCommonParams: false,
@@ -176,7 +176,7 @@ export const endpointCategories: EndpointCategory[] = [
},
{
method: "DELETE",
- path: "/goals/:goalId/:site",
+ path: "/sites/:site/goals/:goalId",
name: "Delete Goal",
description: "Deletes a goal",
hasCommonParams: false,
@@ -189,14 +189,14 @@ export const endpointCategories: EndpointCategory[] = [
endpoints: [
{
method: "GET",
- path: "/funnels/:site",
+ path: "/sites/:site/funnels",
name: "Get Funnels",
description: "Returns all saved funnels for a site",
hasCommonParams: false,
},
{
method: "POST",
- path: "/funnels/analyze/:site",
+ path: "/sites/:site/funnels/analyze",
name: "Analyze Funnel",
description: "Analyzes funnel conversion data step-by-step",
hasCommonParams: true,
@@ -211,7 +211,7 @@ export const endpointCategories: EndpointCategory[] = [
},
{
method: "POST",
- path: "/funnels/:stepNumber/sessions/:site",
+ path: "/sites/:site/funnels/:stepNumber/sessions",
name: "Get Funnel Step Sessions",
description: "Returns sessions that reached or dropped at a specific funnel step",
hasCommonParams: true,
@@ -227,7 +227,7 @@ export const endpointCategories: EndpointCategory[] = [
},
{
method: "POST",
- path: "/funnels/:site",
+ path: "/sites/:site/funnels",
name: "Create Funnel",
description: "Creates a saved funnel",
hasCommonParams: false,
@@ -242,7 +242,7 @@ export const endpointCategories: EndpointCategory[] = [
},
{
method: "DELETE",
- path: "/funnels/:funnelId/:site",
+ path: "/sites/:site/funnels/:funnelId",
name: "Delete Funnel",
description: "Deletes a saved funnel",
hasCommonParams: false,
@@ -255,14 +255,14 @@ export const endpointCategories: EndpointCategory[] = [
endpoints: [
{
method: "GET",
- path: "/performance/overview/:site",
+ path: "/sites/:site/performance/overview",
name: "Get Performance Overview",
description: "Returns aggregate Core Web Vitals metrics",
hasCommonParams: true,
},
{
method: "GET",
- path: "/performance/time-series/:site",
+ path: "/sites/:site/performance/time-series",
name: "Get Performance Time Series",
description: "Returns performance metrics over time",
hasCommonParams: true,
@@ -270,7 +270,7 @@ export const endpointCategories: EndpointCategory[] = [
},
{
method: "GET",
- path: "/performance/by-dimension/:site",
+ path: "/sites/:site/performance/by-dimension",
name: "Get Performance by Dimension",
description: "Returns performance breakdown by dimension",
hasCommonParams: true,
@@ -284,7 +284,7 @@ export const endpointCategories: EndpointCategory[] = [
endpoints: [
{
method: "GET",
- path: "/sessions/:site",
+ path: "/sites/:site/sessions",
name: "Get Sessions",
description: "Returns a paginated list of sessions",
hasCommonParams: true,
@@ -292,7 +292,7 @@ export const endpointCategories: EndpointCategory[] = [
},
{
method: "GET",
- path: "/sessions/:sessionId/:site",
+ path: "/sites/:site/sessions/:sessionId",
name: "Get Session",
description: "Returns detailed session information with events",
hasCommonParams: false,
@@ -301,7 +301,7 @@ export const endpointCategories: EndpointCategory[] = [
},
{
method: "GET",
- path: "/session-locations/:site",
+ path: "/sites/:site/session-locations",
name: "Get Session Locations",
description: "Returns aggregated session locations for map visualization",
hasCommonParams: true,
@@ -313,7 +313,7 @@ export const endpointCategories: EndpointCategory[] = [
endpoints: [
{
method: "GET",
- path: "/users/:site",
+ path: "/sites/:site/users",
name: "Get Users",
description: "Returns a paginated list of users",
hasCommonParams: true,
@@ -321,7 +321,7 @@ export const endpointCategories: EndpointCategory[] = [
},
{
method: "GET",
- path: "/users/session-count/:site",
+ path: "/sites/:site/users/session-count",
name: "Get User Session Count",
description: "Returns daily session counts for a specific user",
hasCommonParams: false,
@@ -329,7 +329,7 @@ export const endpointCategories: EndpointCategory[] = [
},
{
method: "GET",
- path: "/users/:userId/:site",
+ path: "/sites/:site/users/:userId",
name: "Get User Info",
description: "Returns detailed user profile information",
hasCommonParams: false,
@@ -342,7 +342,7 @@ export const endpointCategories: EndpointCategory[] = [
endpoints: [
{
method: "GET",
- path: "/retention/:site",
+ path: "/sites/:site/retention",
name: "Get Retention",
description: "Returns cohort-based retention analysis",
hasCommonParams: false,
@@ -350,7 +350,7 @@ export const endpointCategories: EndpointCategory[] = [
},
{
method: "GET",
- path: "/journeys/:site",
+ path: "/sites/:site/journeys",
name: "Get Journeys",
description: "Returns most common page navigation paths",
hasCommonParams: true,
diff --git a/docs/content/docs/api/stats/errors.mdx b/docs/content/docs/api/stats/errors.mdx
index c9a71bd48..3fd678a69 100644
--- a/docs/content/docs/api/stats/errors.mdx
+++ b/docs/content/docs/api/stats/errors.mdx
@@ -14,15 +14,15 @@ See the [API Reference](/docs/api/stats/reference) for authentication, common pa
<div className="flex flex-col gap-2 my-6">
<a href="#get-error-names" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/error-names/:site</code>
+ <code className="text-sm">/api/sites/:site/error-names</code>
</a>
<a href="#get-error-events" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/error-events/:site</code>
+ <code className="text-sm">/api/sites/:site/error-events</code>
</a>
<a href="#get-error-time-series" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/error-bucketed/:site</code>
+ <code className="text-sm">/api/sites/:site/error-bucketed</code>
</a>
</div>
@@ -34,7 +34,7 @@ See the [API Reference](/docs/api/stats/reference) for authentication, common pa
<div>
```
-GET /api/error-names/:site
+GET /api/sites/:site/error-names
```
Returns a list of unique error messages with occurrence counts and affected session counts.
@@ -114,14 +114,14 @@ Accepts all [Common Parameters](/docs/api/getting-started#common-parameters) plu
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X GET "https://api.rybbit.io/api/error-names/123?start_date=2024-01-01&end_date=2024-01-31" \
+curl -X GET "https://api.rybbit.io/api/sites/1/error-names23?start_date=2024-01-01&end_date=2024-01-31" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/error-names/123?start_date=2024-01-01&end_date=2024-01-31',
+ 'https://api.rybbit.io/api/sites/1/error-names23?start_date=2024-01-01&end_date=2024-01-31',
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -137,7 +137,7 @@ const data = await response.json();
import requests
response = requests.get(
- 'https://api.rybbit.io/api/error-names/123',
+ 'https://api.rybbit.io/api/sites/1/error-names23',
params={
'start_date': '2024-01-01',
'end_date': '2024-01-31'
@@ -153,7 +153,7 @@ data = response.json()
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/error-names/123?start_date=2024-01-01&end_date=2024-01-31');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/error-names23?start_date=2024-01-01&end_date=2024-01-31');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -170,7 +170,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/error-names/123?start_date=2024-01-01&end_date=2024-01-31')
+uri = URI('https://api.rybbit.io/api/sites/1/error-names23?start_date=2024-01-01&end_date=2024-01-31')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
@@ -180,7 +180,7 @@ data = JSON.parse(res.body)
</Tab>
<Tab value="Go">
```go title="Request"
-req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/error-names/123?start_date=2024-01-01&end_date=2024-01-31", nil)
+req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sites/1/error-names23?start_date=2024-01-01&end_date=2024-01-31", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
client := &http.Client{}
@@ -195,7 +195,7 @@ json.NewDecoder(resp.Body).Decode(&data)
```rust title="Request"
let client = reqwest::Client::new();
let res = client
- .get("https://api.rybbit.io/api/error-names/123?start_date=2024-01-01&end_date=2024-01-31")
+ .get("https://api.rybbit.io/api/sites/1/error-names23?start_date=2024-01-01&end_date=2024-01-31")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -207,7 +207,7 @@ let data: serde_json::Value = res.json().await?;
```java title="Request"
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/error-names/123?start_date=2024-01-01&end_date=2024-01-31"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/error-names23?start_date=2024-01-01&end_date=2024-01-31"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -220,7 +220,7 @@ HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.o
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
-var response = await client.GetAsync("https://api.rybbit.io/api/error-names/123?start_date=2024-01-01&end_date=2024-01-31");
+var response = await client.GetAsync("https://api.rybbit.io/api/sites/1/error-names23?start_date=2024-01-01&end_date=2024-01-31");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
@@ -265,7 +265,7 @@ var data = await response.Content.ReadAsStringAsync();
<div>
```
-GET /api/error-events/:site
+GET /api/sites/:site/error-events
```
Returns individual error occurrences for a specific error message, with full context including stack traces.
@@ -391,14 +391,14 @@ Accepts all [Common Parameters](/docs/api/getting-started#common-parameters) plu
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X GET "https://api.rybbit.io/api/error-events/123?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&limit=10" \
+curl -X GET "https://api.rybbit.io/api/sites/1/error-events23?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&limit=10" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- `https://api.rybbit.io/api/error-events/123?errorMessage=${encodeURIComponent("Cannot read property 'map' of undefined")}&limit=10`,
+ `https://api.rybbit.io/api/sites/1/error-events23?errorMessage=${encodeURIComponent("Cannot read property 'map' of undefined")}&limit=10`,
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -414,7 +414,7 @@ const data = await response.json();
import requests
response = requests.get(
- 'https://api.rybbit.io/api/error-events/123',
+ 'https://api.rybbit.io/api/sites/1/error-events23',
params={
'errorMessage': "Cannot read property 'map' of undefined",
'limit': 10
@@ -430,7 +430,7 @@ data = response.json()
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/error-events/123?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&limit=10');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/error-events23?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&limit=10');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -447,7 +447,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/error-events/123?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&limit=10')
+uri = URI('https://api.rybbit.io/api/sites/1/error-events23?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&limit=10')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
@@ -457,7 +457,7 @@ data = JSON.parse(res.body)
</Tab>
<Tab value="Go">
```go title="Request"
-req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/error-events/123?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&limit=10", nil)
+req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sites/1/error-events23?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&limit=10", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
client := &http.Client{}
@@ -472,7 +472,7 @@ json.NewDecoder(resp.Body).Decode(&data)
```rust title="Request"
let client = reqwest::Client::new();
let res = client
- .get("https://api.rybbit.io/api/error-events/123?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&limit=10")
+ .get("https://api.rybbit.io/api/sites/1/error-events23?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&limit=10")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -484,7 +484,7 @@ let data: serde_json::Value = res.json().await?;
```java title="Request"
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/error-events/123?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&limit=10"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/error-events23?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&limit=10"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -497,7 +497,7 @@ HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.o
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
-var response = await client.GetAsync("https://api.rybbit.io/api/error-events/123?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&limit=10");
+var response = await client.GetAsync("https://api.rybbit.io/api/sites/1/error-events23?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&limit=10");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
@@ -538,7 +538,7 @@ var data = await response.Content.ReadAsStringAsync();
<div>
```
-GET /api/error-bucketed/:site
+GET /api/sites/:site/error-bucketed
```
Returns error occurrence counts over time for a specific error message. Useful for tracking error trends and identifying when issues started.
@@ -612,14 +612,14 @@ Accepts all [Common Parameters](/docs/api/getting-started#common-parameters) plu
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X GET "https://api.rybbit.io/api/error-bucketed/123?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&bucket=hour&start_date=2024-01-30&end_date=2024-01-31&time_zone=UTC" \
+curl -X GET "https://api.rybbit.io/api/sites/1/error-bucketed23?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&bucket=hour&start_date=2024-01-30&end_date=2024-01-31&time_zone=UTC" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- `https://api.rybbit.io/api/error-bucketed/123?errorMessage=${encodeURIComponent("Cannot read property 'map' of undefined")}&bucket=hour&start_date=2024-01-30&end_date=2024-01-31&time_zone=UTC`,
+ `https://api.rybbit.io/api/sites/1/error-bucketed23?errorMessage=${encodeURIComponent("Cannot read property 'map' of undefined")}&bucket=hour&start_date=2024-01-30&end_date=2024-01-31&time_zone=UTC`,
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -635,7 +635,7 @@ const data = await response.json();
import requests
response = requests.get(
- 'https://api.rybbit.io/api/error-bucketed/123',
+ 'https://api.rybbit.io/api/sites/1/error-bucketed23',
params={
'errorMessage': "Cannot read property 'map' of undefined",
'bucket': 'hour',
@@ -654,7 +654,7 @@ data = response.json()
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/error-bucketed/123?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&bucket=hour&start_date=2024-01-30&end_date=2024-01-31&time_zone=UTC');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/error-bucketed23?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&bucket=hour&start_date=2024-01-30&end_date=2024-01-31&time_zone=UTC');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -671,7 +671,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/error-bucketed/123?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&bucket=hour&start_date=2024-01-30&end_date=2024-01-31&time_zone=UTC')
+uri = URI('https://api.rybbit.io/api/sites/1/error-bucketed23?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&bucket=hour&start_date=2024-01-30&end_date=2024-01-31&time_zone=UTC')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
@@ -681,7 +681,7 @@ data = JSON.parse(res.body)
</Tab>
<Tab value="Go">
```go title="Request"
-req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/error-bucketed/123?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&bucket=hour&start_date=2024-01-30&end_date=2024-01-31&time_zone=UTC", nil)
+req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sites/1/error-bucketed23?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&bucket=hour&start_date=2024-01-30&end_date=2024-01-31&time_zone=UTC", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
client := &http.Client{}
@@ -696,7 +696,7 @@ json.NewDecoder(resp.Body).Decode(&data)
```rust title="Request"
let client = reqwest::Client::new();
let res = client
- .get("https://api.rybbit.io/api/error-bucketed/123?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&bucket=hour&start_date=2024-01-30&end_date=2024-01-31&time_zone=UTC")
+ .get("https://api.rybbit.io/api/sites/1/error-bucketed23?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&bucket=hour&start_date=2024-01-30&end_date=2024-01-31&time_zone=UTC")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -708,7 +708,7 @@ let data: serde_json::Value = res.json().await?;
```java title="Request"
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/error-bucketed/123?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&bucket=hour&start_date=2024-01-30&end_date=2024-01-31&time_zone=UTC"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/error-bucketed23?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&bucket=hour&start_date=2024-01-30&end_date=2024-01-31&time_zone=UTC"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -721,7 +721,7 @@ HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.o
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
-var response = await client.GetAsync("https://api.rybbit.io/api/error-bucketed/123?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&bucket=hour&start_date=2024-01-30&end_date=2024-01-31&time_zone=UTC");
+var response = await client.GetAsync("https://api.rybbit.io/api/sites/1/error-bucketed23?errorMessage=Cannot%20read%20property%20%27map%27%20of%20undefined&bucket=hour&start_date=2024-01-30&end_date=2024-01-31&time_zone=UTC");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
diff --git a/docs/content/docs/api/stats/events.mdx b/docs/content/docs/api/stats/events.mdx
index 9ef1e71b5..0dc1ffe07 100644
--- a/docs/content/docs/api/stats/events.mdx
+++ b/docs/content/docs/api/stats/events.mdx
@@ -14,19 +14,19 @@ See the [API Reference](/docs/api/stats/reference) for authentication, common pa
<div className="flex flex-col gap-2 my-6">
<a href="#get-events" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/events/:site</code>
+ <code className="text-sm">/api/sites/:site/events</code>
</a>
<a href="#get-event-names" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/events/names/:site</code>
+ <code className="text-sm">/api/sites/:site/events/names</code>
</a>
<a href="#get-event-properties" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/events/properties/:site</code>
+ <code className="text-sm">/api/sites/:site/events/properties</code>
</a>
<a href="#get-outbound-links" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/events/outbound/:site</code>
+ <code className="text-sm">/api/sites/:site/events/outbound</code>
</a>
</div>
@@ -38,7 +38,7 @@ See the [API Reference](/docs/api/stats/reference) for authentication, common pa
<div>
```
-GET /api/events/:site
+GET /api/sites/:site/events
```
Returns a paginated list of events (pageviews, custom events, and outbound clicks).
@@ -156,14 +156,14 @@ Accepts all [Common Parameters](/docs/api/getting-started#common-parameters) plu
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X GET "https://api.rybbit.io/api/events/123?page=1&page_size=20&start_date=2024-01-01&end_date=2024-01-31" \
+curl -X GET "https://api.rybbit.io/api/sites/1/events23?page=1&page_size=20&start_date=2024-01-01&end_date=2024-01-31" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/events/123?page=1&page_size=20&start_date=2024-01-01&end_date=2024-01-31',
+ 'https://api.rybbit.io/api/sites/1/events23?page=1&page_size=20&start_date=2024-01-01&end_date=2024-01-31',
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -179,7 +179,7 @@ const data = await response.json();
import requests
response = requests.get(
- 'https://api.rybbit.io/api/events/123',
+ 'https://api.rybbit.io/api/sites/1/events23',
params={
'page': 1,
'page_size': 20,
@@ -197,7 +197,7 @@ data = response.json()
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/events/123?page=1&page_size=20&start_date=2024-01-01&end_date=2024-01-31');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/events23?page=1&page_size=20&start_date=2024-01-01&end_date=2024-01-31');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -214,7 +214,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/events/123?page=1&page_size=20&start_date=2024-01-01&end_date=2024-01-31')
+uri = URI('https://api.rybbit.io/api/sites/1/events23?page=1&page_size=20&start_date=2024-01-01&end_date=2024-01-31')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
@@ -224,7 +224,7 @@ data = JSON.parse(res.body)
</Tab>
<Tab value="Go">
```go title="Request"
-req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/events/123?page=1&page_size=20&start_date=2024-01-01&end_date=2024-01-31", nil)
+req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sites/1/events23?page=1&page_size=20&start_date=2024-01-01&end_date=2024-01-31", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
client := &http.Client{}
@@ -239,7 +239,7 @@ json.NewDecoder(resp.Body).Decode(&data)
```rust title="Request"
let client = reqwest::Client::new();
let res = client
- .get("https://api.rybbit.io/api/events/123?page=1&page_size=20&start_date=2024-01-01&end_date=2024-01-31")
+ .get("https://api.rybbit.io/api/sites/1/events23?page=1&page_size=20&start_date=2024-01-01&end_date=2024-01-31")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -251,7 +251,7 @@ let data: serde_json::Value = res.json().await?;
```java title="Request"
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/events/123?page=1&page_size=20&start_date=2024-01-01&end_date=2024-01-31"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/events23?page=1&page_size=20&start_date=2024-01-01&end_date=2024-01-31"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -264,7 +264,7 @@ HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.o
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
-var response = await client.GetAsync("https://api.rybbit.io/api/events/123?page=1&page_size=20&start_date=2024-01-01&end_date=2024-01-31");
+var response = await client.GetAsync("https://api.rybbit.io/api/sites/1/events23?page=1&page_size=20&start_date=2024-01-01&end_date=2024-01-31");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
@@ -322,7 +322,7 @@ var data = await response.Content.ReadAsStringAsync();
<div>
```
-GET /api/events/names/:site
+GET /api/sites/:site/events/names
```
Returns a list of unique custom event names with their occurrence counts.
@@ -375,14 +375,14 @@ Accepts all [Common Parameters](/docs/api/getting-started#common-parameters) (ti
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X GET "https://api.rybbit.io/api/events/names/123?start_date=2024-01-01&end_date=2024-01-31" \
+curl -X GET "https://api.rybbit.io/api/sites/1/events/names23?start_date=2024-01-01&end_date=2024-01-31" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/events/names/123?start_date=2024-01-01&end_date=2024-01-31',
+ 'https://api.rybbit.io/api/sites/1/events/names23?start_date=2024-01-01&end_date=2024-01-31',
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -398,7 +398,7 @@ const data = await response.json();
import requests
response = requests.get(
- 'https://api.rybbit.io/api/events/names/123',
+ 'https://api.rybbit.io/api/sites/1/events/names23',
params={
'start_date': '2024-01-01',
'end_date': '2024-01-31'
@@ -414,7 +414,7 @@ data = response.json()
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/events/names/123?start_date=2024-01-01&end_date=2024-01-31');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/events/names23?start_date=2024-01-01&end_date=2024-01-31');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -431,7 +431,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/events/names/123?start_date=2024-01-01&end_date=2024-01-31')
+uri = URI('https://api.rybbit.io/api/sites/1/events/names23?start_date=2024-01-01&end_date=2024-01-31')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
@@ -441,7 +441,7 @@ data = JSON.parse(res.body)
</Tab>
<Tab value="Go">
```go title="Request"
-req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/events/names/123?start_date=2024-01-01&end_date=2024-01-31", nil)
+req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sites/1/events/names23?start_date=2024-01-01&end_date=2024-01-31", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
client := &http.Client{}
@@ -456,7 +456,7 @@ json.NewDecoder(resp.Body).Decode(&data)
```rust title="Request"
let client = reqwest::Client::new();
let res = client
- .get("https://api.rybbit.io/api/events/names/123?start_date=2024-01-01&end_date=2024-01-31")
+ .get("https://api.rybbit.io/api/sites/1/events/names23?start_date=2024-01-01&end_date=2024-01-31")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -468,7 +468,7 @@ let data: serde_json::Value = res.json().await?;
```java title="Request"
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/events/names/123?start_date=2024-01-01&end_date=2024-01-31"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/events/names23?start_date=2024-01-01&end_date=2024-01-31"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -481,7 +481,7 @@ HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.o
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
-var response = await client.GetAsync("https://api.rybbit.io/api/events/names/123?start_date=2024-01-01&end_date=2024-01-31");
+var response = await client.GetAsync("https://api.rybbit.io/api/sites/1/events/names23?start_date=2024-01-01&end_date=2024-01-31");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
@@ -521,7 +521,7 @@ var data = await response.Content.ReadAsStringAsync();
<div>
```
-GET /api/events/properties/:site
+GET /api/sites/:site/events/properties
```
Returns property key-value pairs for a specific event name with their occurrence counts.
@@ -588,14 +588,14 @@ Accepts all [Common Parameters](/docs/api/getting-started#common-parameters) plu
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X GET "https://api.rybbit.io/api/events/properties/123?event_name=signup&start_date=2024-01-01&end_date=2024-01-31" \
+curl -X GET "https://api.rybbit.io/api/sites/1/events/properties23?event_name=signup&start_date=2024-01-01&end_date=2024-01-31" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/events/properties/123?event_name=signup&start_date=2024-01-01&end_date=2024-01-31',
+ 'https://api.rybbit.io/api/sites/1/events/properties23?event_name=signup&start_date=2024-01-01&end_date=2024-01-31',
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -611,7 +611,7 @@ const data = await response.json();
import requests
response = requests.get(
- 'https://api.rybbit.io/api/events/properties/123',
+ 'https://api.rybbit.io/api/sites/1/events/properties23',
params={
'event_name': 'signup',
'start_date': '2024-01-01',
@@ -628,7 +628,7 @@ data = response.json()
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/events/properties/123?event_name=signup&start_date=2024-01-01&end_date=2024-01-31');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/events/properties23?event_name=signup&start_date=2024-01-01&end_date=2024-01-31');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -645,7 +645,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/events/properties/123?event_name=signup&start_date=2024-01-01&end_date=2024-01-31')
+uri = URI('https://api.rybbit.io/api/sites/1/events/properties23?event_name=signup&start_date=2024-01-01&end_date=2024-01-31')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
@@ -655,7 +655,7 @@ data = JSON.parse(res.body)
</Tab>
<Tab value="Go">
```go title="Request"
-req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/events/properties/123?event_name=signup&start_date=2024-01-01&end_date=2024-01-31", nil)
+req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sites/1/events/properties23?event_name=signup&start_date=2024-01-01&end_date=2024-01-31", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
client := &http.Client{}
@@ -670,7 +670,7 @@ json.NewDecoder(resp.Body).Decode(&data)
```rust title="Request"
let client = reqwest::Client::new();
let res = client
- .get("https://api.rybbit.io/api/events/properties/123?event_name=signup&start_date=2024-01-01&end_date=2024-01-31")
+ .get("https://api.rybbit.io/api/sites/1/events/properties23?event_name=signup&start_date=2024-01-01&end_date=2024-01-31")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -682,7 +682,7 @@ let data: serde_json::Value = res.json().await?;
```java title="Request"
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/events/properties/123?event_name=signup&start_date=2024-01-01&end_date=2024-01-31"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/events/properties23?event_name=signup&start_date=2024-01-01&end_date=2024-01-31"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -695,7 +695,7 @@ HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.o
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
-var response = await client.GetAsync("https://api.rybbit.io/api/events/properties/123?event_name=signup&start_date=2024-01-01&end_date=2024-01-31");
+var response = await client.GetAsync("https://api.rybbit.io/api/sites/1/events/properties23?event_name=signup&start_date=2024-01-01&end_date=2024-01-31");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
@@ -744,7 +744,7 @@ var data = await response.Content.ReadAsStringAsync();
<div>
```
-GET /api/events/outbound/:site
+GET /api/sites/:site/events/outbound
```
Returns a list of outbound link clicks with their occurrence counts.
@@ -802,14 +802,14 @@ Accepts all [Common Parameters](/docs/api/getting-started#common-parameters) (ti
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X GET "https://api.rybbit.io/api/events/outbound/123?start_date=2024-01-01&end_date=2024-01-31" \
+curl -X GET "https://api.rybbit.io/api/sites/1/events/outbound23?start_date=2024-01-01&end_date=2024-01-31" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/events/outbound/123?start_date=2024-01-01&end_date=2024-01-31',
+ 'https://api.rybbit.io/api/sites/1/events/outbound23?start_date=2024-01-01&end_date=2024-01-31',
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -825,7 +825,7 @@ const data = await response.json();
import requests
response = requests.get(
- 'https://api.rybbit.io/api/events/outbound/123',
+ 'https://api.rybbit.io/api/sites/1/events/outbound23',
params={
'start_date': '2024-01-01',
'end_date': '2024-01-31'
@@ -841,7 +841,7 @@ data = response.json()
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/events/outbound/123?start_date=2024-01-01&end_date=2024-01-31');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/events/outbound23?start_date=2024-01-01&end_date=2024-01-31');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -858,7 +858,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/events/outbound/123?start_date=2024-01-01&end_date=2024-01-31')
+uri = URI('https://api.rybbit.io/api/sites/1/events/outbound23?start_date=2024-01-01&end_date=2024-01-31')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
@@ -868,7 +868,7 @@ data = JSON.parse(res.body)
</Tab>
<Tab value="Go">
```go title="Request"
-req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/events/outbound/123?start_date=2024-01-01&end_date=2024-01-31", nil)
+req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sites/1/events/outbound23?start_date=2024-01-01&end_date=2024-01-31", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
client := &http.Client{}
@@ -883,7 +883,7 @@ json.NewDecoder(resp.Body).Decode(&data)
```rust title="Request"
let client = reqwest::Client::new();
let res = client
- .get("https://api.rybbit.io/api/events/outbound/123?start_date=2024-01-01&end_date=2024-01-31")
+ .get("https://api.rybbit.io/api/sites/1/events/outbound23?start_date=2024-01-01&end_date=2024-01-31")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -895,7 +895,7 @@ let data: serde_json::Value = res.json().await?;
```java title="Request"
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/events/outbound/123?start_date=2024-01-01&end_date=2024-01-31"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/events/outbound23?start_date=2024-01-01&end_date=2024-01-31"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -908,7 +908,7 @@ HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.o
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
-var response = await client.GetAsync("https://api.rybbit.io/api/events/outbound/123?start_date=2024-01-01&end_date=2024-01-31");
+var response = await client.GetAsync("https://api.rybbit.io/api/sites/1/events/outbound23?start_date=2024-01-01&end_date=2024-01-31");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
diff --git a/docs/content/docs/api/stats/funnels.mdx b/docs/content/docs/api/stats/funnels.mdx
index 3d0eec81a..e4643df0c 100644
--- a/docs/content/docs/api/stats/funnels.mdx
+++ b/docs/content/docs/api/stats/funnels.mdx
@@ -14,23 +14,23 @@ See the [API Reference](/docs/api/stats/reference) for authentication, common pa
<div className="flex flex-col gap-2 my-6">
<a href="#get-funnels" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/funnels/:site</code>
+ <code className="text-sm">/api/sites/:site/funnels</code>
</a>
<a href="#analyze-funnel" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-blue-500/20 text-blue-600 dark:text-blue-400">POST</span>
- <code className="text-sm">/api/funnels/analyze/:site</code>
+ <code className="text-sm">/api/sites/:site/funnels/analyze</code>
</a>
<a href="#get-funnel-step-sessions" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-blue-500/20 text-blue-600 dark:text-blue-400">POST</span>
- <code className="text-sm">/api/funnels/:stepNumber/sessions/:site</code>
+ <code className="text-sm">/api/sites/:site/funnels/:stepNumber/sessions</code>
</a>
<a href="#create-funnel" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-blue-500/20 text-blue-600 dark:text-blue-400">POST</span>
- <code className="text-sm">/api/funnels/:site</code>
+ <code className="text-sm">/api/sites/:site/funnels</code>
</a>
<a href="#delete-funnel" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-red-500/20 text-red-600 dark:text-red-400">DELETE</span>
- <code className="text-sm">/api/funnels/:funnelId/:site</code>
+ <code className="text-sm">/api/sites/:site/funnels/:funnelId</code>
</a>
</div>
@@ -42,7 +42,7 @@ See the [API Reference](/docs/api/stats/reference) for authentication, common pa
<div>
```
-GET /api/funnels/:site
+GET /api/sites/:site/funnels
```
Returns all saved funnels for a site.
@@ -105,14 +105,14 @@ Returns all saved funnels for a site.
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X GET "https://api.rybbit.io/api/funnels/123" \
+curl -X GET "https://api.rybbit.io/api/sites/1/funnels23" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/funnels/123',
+ 'https://api.rybbit.io/api/sites/1/funnels23',
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -128,7 +128,7 @@ const data = await response.json();
import requests
response = requests.get(
- 'https://api.rybbit.io/api/funnels/123',
+ 'https://api.rybbit.io/api/sites/1/funnels23',
headers={
'Authorization': 'Bearer your_api_key_here'
}
@@ -140,7 +140,7 @@ data = response.json()
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/funnels/123');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/funnels23');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -157,7 +157,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/funnels/123')
+uri = URI('https://api.rybbit.io/api/sites/1/funnels23')
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer your_api_key_here'
@@ -180,7 +180,7 @@ import (
func main() {
client := &http.Client{}
- req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/funnels/123", nil)
+ req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sites/1/funnels23", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
resp, _ := client.Do(req)
@@ -201,7 +201,7 @@ use serde_json::Value;
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = reqwest::Client::new();
let response = client
- .get("https://api.rybbit.io/api/funnels/123")
+ .get("https://api.rybbit.io/api/sites/1/funnels23")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -220,7 +220,7 @@ import java.net.http.HttpResponse;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/funnels/123"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/funnels23"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -240,7 +240,7 @@ client.DefaultRequestHeaders.Authorization =
new AuthenticationHeaderValue("Bearer", "your_api_key_here");
var response = await client.GetAsync(
- "https://api.rybbit.io/api/funnels/123");
+ "https://api.rybbit.io/api/sites/1/funnels23");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
@@ -276,7 +276,7 @@ var data = await response.Content.ReadAsStringAsync();
<div>
```
-POST /api/funnels/analyze/:site
+POST /api/sites/:site/funnels/analyze
```
Analyzes a funnel and returns step-by-step conversion data. Sessions must complete steps in order (step 2 must occur after step 1, etc.).
@@ -393,7 +393,7 @@ Accepts all [Common Parameters](/docs/api/getting-started#common-parameters) (ti
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X POST "https://api.rybbit.io/api/funnels/analyze/123?start_date=2024-01-01&end_date=2024-01-31" \
+curl -X POST "https://api.rybbit.io/api/sites/1/funnels/analyze23?start_date=2024-01-01&end_date=2024-01-31" \
-H "Authorization: Bearer your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
@@ -409,7 +409,7 @@ curl -X POST "https://api.rybbit.io/api/funnels/analyze/123?start_date=2024-01-0
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/funnels/analyze/123?start_date=2024-01-01&end_date=2024-01-31',
+ 'https://api.rybbit.io/api/sites/1/funnels/analyze23?start_date=2024-01-01&end_date=2024-01-31',
{
method: 'POST',
headers: {
@@ -435,7 +435,7 @@ const data = await response.json();
import requests
response = requests.post(
- 'https://api.rybbit.io/api/funnels/analyze/123',
+ 'https://api.rybbit.io/api/sites/1/funnels/analyze23',
params={
'start_date': '2024-01-01',
'end_date': '2024-01-31'
@@ -468,7 +468,7 @@ $body = [
];
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/funnels/analyze/123?start_date=2024-01-01&end_date=2024-01-31');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/funnels/analyze23?start_date=2024-01-01&end_date=2024-01-31');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($body));
@@ -488,7 +488,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/funnels/analyze/123?start_date=2024-01-01&end_date=2024-01-31')
+uri = URI('https://api.rybbit.io/api/sites/1/funnels/analyze23?start_date=2024-01-01&end_date=2024-01-31')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer your_api_key_here'
request['Content-Type'] = 'application/json'
@@ -531,7 +531,7 @@ func main() {
jsonBody, _ := json.Marshal(body)
client := &http.Client{}
- req, _ := http.NewRequest("POST", "https://api.rybbit.io/api/funnels/analyze/123?start_date=2024-01-01&end_date=2024-01-31", bytes.NewBuffer(jsonBody))
+ req, _ := http.NewRequest("POST", "https://api.rybbit.io/api/sites/1/funnels/analyze23?start_date=2024-01-01&end_date=2024-01-31", bytes.NewBuffer(jsonBody))
req.Header.Set("Authorization", "Bearer your_api_key_here")
req.Header.Set("Content-Type", "application/json")
@@ -562,7 +562,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = reqwest::Client::new();
let response = client
- .post("https://api.rybbit.io/api/funnels/analyze/123?start_date=2024-01-01&end_date=2024-01-31")
+ .post("https://api.rybbit.io/api/sites/1/funnels/analyze23?start_date=2024-01-01&end_date=2024-01-31")
.header("Authorization", "Bearer your_api_key_here")
.header("Content-Type", "application/json")
.json(&body)
@@ -594,7 +594,7 @@ String json = """
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/funnels/analyze/123?start_date=2024-01-01&end_date=2024-01-31"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/funnels/analyze23?start_date=2024-01-01&end_date=2024-01-31"))
.header("Authorization", "Bearer your_api_key_here")
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(json))
@@ -633,7 +633,7 @@ var content = new StringContent(
"application/json");
var response = await client.PostAsync(
- "https://api.rybbit.io/api/funnels/analyze/123?start_date=2024-01-01&end_date=2024-01-31",
+ "https://api.rybbit.io/api/sites/1/funnels/analyze23?start_date=2024-01-01&end_date=2024-01-31",
content);
var data = await response.Content.ReadAsStringAsync();
```
@@ -686,7 +686,7 @@ var data = await response.Content.ReadAsStringAsync();
<div>
```
-POST /api/funnels/:stepNumber/sessions/:site
+POST /api/sites/:site/funnels/:stepNumber/sessions
```
Returns sessions that either reached or dropped off at a specific funnel step. Useful for analyzing user behavior at each stage.
@@ -762,7 +762,7 @@ Accepts all [Common Parameters](/docs/api/getting-started#common-parameters) plu
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Get sessions that dropped off at step 2"
-curl -X POST "https://api.rybbit.io/api/funnels/2/sessions/123?mode=dropped&page=1" \
+curl -X POST "https://api.rybbit.io/api/sites/1/funnels/2/sessions23?mode=dropped&page=1" \
-H "Authorization: Bearer your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
@@ -777,7 +777,7 @@ curl -X POST "https://api.rybbit.io/api/funnels/2/sessions/123?mode=dropped&page
<Tab value="JavaScript">
```javascript title="Get sessions that reached step 3"
const response = await fetch(
- 'https://api.rybbit.io/api/funnels/3/sessions/123?mode=reached&page=1',
+ 'https://api.rybbit.io/api/sites/1/funnels/3/sessions23?mode=reached&page=1',
{
method: 'POST',
headers: {
@@ -802,7 +802,7 @@ const data = await response.json();
import requests
response = requests.post(
- 'https://api.rybbit.io/api/funnels/2/sessions/123',
+ 'https://api.rybbit.io/api/sites/1/funnels/2/sessions23',
params={
'mode': 'dropped',
'page': 1
@@ -833,7 +833,7 @@ $body = [
];
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/funnels/2/sessions/123?mode=dropped&page=1');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/funnels/2/sessions23?mode=dropped&page=1');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($body));
@@ -853,7 +853,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/funnels/2/sessions/123?mode=dropped&page=1')
+uri = URI('https://api.rybbit.io/api/sites/1/funnels/2/sessions23?mode=dropped&page=1')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer your_api_key_here'
request['Content-Type'] = 'application/json'
@@ -883,7 +883,7 @@ body := map[string]interface{}{
}
jsonBody, _ := json.Marshal(body)
-req, _ := http.NewRequest("POST", "https://api.rybbit.io/api/funnels/2/sessions/123?mode=dropped&page=1", bytes.NewBuffer(jsonBody))
+req, _ := http.NewRequest("POST", "https://api.rybbit.io/api/sites/1/funnels/2/sessions23?mode=dropped&page=1", bytes.NewBuffer(jsonBody))
req.Header.Set("Authorization", "Bearer your_api_key_here")
req.Header.Set("Content-Type", "application/json")
@@ -907,7 +907,7 @@ let body = serde_json::json!({
let client = reqwest::Client::new();
let res = client
- .post("https://api.rybbit.io/api/funnels/2/sessions/123?mode=dropped&page=1")
+ .post("https://api.rybbit.io/api/sites/1/funnels/2/sessions23?mode=dropped&page=1")
.header("Authorization", "Bearer your_api_key_here")
.json(&body)
.send()
@@ -930,7 +930,7 @@ String json = """
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/funnels/2/sessions/123?mode=dropped&page=1"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/funnels/2/sessions23?mode=dropped&page=1"))
.header("Authorization", "Bearer your_api_key_here")
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(json))
@@ -960,7 +960,7 @@ var content = new StringContent(
"application/json");
var response = await client.PostAsync(
- "https://api.rybbit.io/api/funnels/2/sessions/123?mode=dropped&page=1",
+ "https://api.rybbit.io/api/sites/1/funnels/2/sessions23?mode=dropped&page=1",
content);
var data = await response.Content.ReadAsStringAsync();
```
@@ -1001,7 +1001,7 @@ var data = await response.Content.ReadAsStringAsync();
<div>
```
-POST /api/funnels/:site
+POST /api/sites/:site/funnels
```
Creates or updates a saved funnel. If `reportId` is provided, updates the existing funnel.
@@ -1061,7 +1061,7 @@ Creates or updates a saved funnel. If `reportId` is provided, updates the existi
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Create New Funnel"
-curl -X POST "https://api.rybbit.io/api/funnels/123" \
+curl -X POST "https://api.rybbit.io/api/sites/1/funnels23" \
-H "Authorization: Bearer your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
@@ -1078,7 +1078,7 @@ curl -X POST "https://api.rybbit.io/api/funnels/123" \
<Tab value="JavaScript">
```javascript title="Update Existing Funnel"
const response = await fetch(
- 'https://api.rybbit.io/api/funnels/123',
+ 'https://api.rybbit.io/api/sites/1/funnels23',
{
method: 'POST',
headers: {
@@ -1106,7 +1106,7 @@ const data = await response.json();
import requests
response = requests.post(
- 'https://api.rybbit.io/api/funnels/123',
+ 'https://api.rybbit.io/api/sites/1/funnels23',
json={
'name': 'Onboarding Funnel',
'steps': [
@@ -1137,7 +1137,7 @@ $body = [
];
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/funnels/123');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/funnels23');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($body));
@@ -1157,7 +1157,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/funnels/123')
+uri = URI('https://api.rybbit.io/api/sites/1/funnels23')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer your_api_key_here'
request['Content-Type'] = 'application/json'
@@ -1191,7 +1191,7 @@ body := map[string]interface{}{
}
jsonBody, _ := json.Marshal(body)
-req, _ := http.NewRequest("POST", "https://api.rybbit.io/api/funnels/123", bytes.NewBuffer(jsonBody))
+req, _ := http.NewRequest("POST", "https://api.rybbit.io/api/sites/1/funnels23", bytes.NewBuffer(jsonBody))
req.Header.Set("Authorization", "Bearer your_api_key_here")
req.Header.Set("Content-Type", "application/json")
@@ -1217,7 +1217,7 @@ let body = serde_json::json!({
let client = reqwest::Client::new();
let res = client
- .post("https://api.rybbit.io/api/funnels/123")
+ .post("https://api.rybbit.io/api/sites/1/funnels23")
.header("Authorization", "Bearer your_api_key_here")
.json(&body)
.send()
@@ -1242,7 +1242,7 @@ String json = """
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/funnels/123"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/funnels23"))
.header("Authorization", "Bearer your_api_key_here")
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(json))
@@ -1273,7 +1273,7 @@ var content = new StringContent(
Encoding.UTF8,
"application/json");
-var response = await client.PostAsync("https://api.rybbit.io/api/funnels/123", content);
+var response = await client.PostAsync("https://api.rybbit.io/api/sites/1/funnels23", content);
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
@@ -1297,7 +1297,7 @@ var data = await response.Content.ReadAsStringAsync();
<div>
```
-DELETE /api/funnels/:funnelId/:site
+DELETE /api/sites/:site/funnels/:funnelId
```
Deletes a saved funnel. This action cannot be undone.
@@ -1336,14 +1336,14 @@ Deletes a saved funnel. This action cannot be undone.
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X DELETE "https://api.rybbit.io/api/funnels/1/123" \
+curl -X DELETE "https://api.rybbit.io/api/sites/1/funnels/123" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/funnels/1/123',
+ 'https://api.rybbit.io/api/sites/1/funnels/123',
{
method: 'DELETE',
headers: {
@@ -1360,7 +1360,7 @@ const data = await response.json();
import requests
response = requests.delete(
- 'https://api.rybbit.io/api/funnels/1/123',
+ 'https://api.rybbit.io/api/sites/1/funnels/123',
headers={
'Authorization': 'Bearer your_api_key_here'
}
@@ -1372,7 +1372,7 @@ data = response.json()
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/funnels/1/123');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/funnels/123');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
@@ -1390,7 +1390,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/funnels/1/123')
+uri = URI('https://api.rybbit.io/api/sites/1/funnels/123')
request = Net::HTTP::Delete.new(uri)
request['Authorization'] = 'Bearer your_api_key_here'
@@ -1403,7 +1403,7 @@ data = JSON.parse(response.body)
</Tab>
<Tab value="Go">
```go title="Request"
-req, _ := http.NewRequest("DELETE", "https://api.rybbit.io/api/funnels/1/123", nil)
+req, _ := http.NewRequest("DELETE", "https://api.rybbit.io/api/sites/1/funnels/123", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
client := &http.Client{}
@@ -1418,7 +1418,7 @@ json.NewDecoder(resp.Body).Decode(&data)
```rust title="Request"
let client = reqwest::Client::new();
let res = client
- .delete("https://api.rybbit.io/api/funnels/1/123")
+ .delete("https://api.rybbit.io/api/sites/1/funnels/123")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -1430,7 +1430,7 @@ let data: serde_json::Value = res.json().await?;
```java title="Request"
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/funnels/1/123"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/funnels/123"))
.header("Authorization", "Bearer your_api_key_here")
.DELETE()
.build();
@@ -1443,7 +1443,7 @@ HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.o
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
-var response = await client.DeleteAsync("https://api.rybbit.io/api/funnels/1/123");
+var response = await client.DeleteAsync("https://api.rybbit.io/api/sites/1/funnels/123");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
diff --git a/docs/content/docs/api/stats/goals.mdx b/docs/content/docs/api/stats/goals.mdx
index 805aee57a..3c00481b5 100644
--- a/docs/content/docs/api/stats/goals.mdx
+++ b/docs/content/docs/api/stats/goals.mdx
@@ -14,23 +14,23 @@ See the [API Reference](/docs/api/stats/reference) for authentication, common pa
<div className="flex flex-col gap-2 my-6">
<a href="#get-goals" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/goals/:site</code>
+ <code className="text-sm">/api/sites/:site/goals</code>
</a>
<a href="#get-goal-sessions" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/goals/:goalId/sessions/:site</code>
+ <code className="text-sm">/api/sites/:site/goals/:goalId/sessions</code>
</a>
<a href="#create-goal" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-blue-500/20 text-blue-600 dark:text-blue-400">POST</span>
- <code className="text-sm">/api/goals/:site</code>
+ <code className="text-sm">/api/sites/:site/goals</code>
</a>
<a href="#update-goal" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-yellow-500/20 text-yellow-600 dark:text-yellow-400">PUT</span>
- <code className="text-sm">/api/goals/:goalId/:site</code>
+ <code className="text-sm">/api/sites/:site/goals/:goalId</code>
</a>
<a href="#delete-goal" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-red-500/20 text-red-600 dark:text-red-400">DELETE</span>
- <code className="text-sm">/api/goals/:goalId/:site</code>
+ <code className="text-sm">/api/sites/:site/goals/:goalId</code>
</a>
</div>
@@ -42,7 +42,7 @@ See the [API Reference](/docs/api/stats/reference) for authentication, common pa
<div>
```
-GET /api/goals/:site
+GET /api/sites/:site/goals
```
Returns a paginated list of goals with their conversion metrics.
@@ -179,14 +179,14 @@ Accepts all [Common Parameters](/docs/api/getting-started#common-parameters) plu
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X GET "https://api.rybbit.io/api/goals/123?start_date=2024-01-01&end_date=2024-01-31" \
+curl -X GET "https://api.rybbit.io/api/sites/1/goals23?start_date=2024-01-01&end_date=2024-01-31" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/goals/123?start_date=2024-01-01&end_date=2024-01-31',
+ 'https://api.rybbit.io/api/sites/1/goals23?start_date=2024-01-01&end_date=2024-01-31',
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -202,7 +202,7 @@ const data = await response.json();
import requests
response = requests.get(
- 'https://api.rybbit.io/api/goals/123',
+ 'https://api.rybbit.io/api/sites/1/goals23',
params={
'start_date': '2024-01-01',
'end_date': '2024-01-31'
@@ -220,7 +220,7 @@ data = response.json()
<?php
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/goals/123?start_date=2024-01-01&end_date=2024-01-31');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/goals23?start_date=2024-01-01&end_date=2024-01-31');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -239,7 +239,7 @@ require 'net/http'
require 'json'
require 'uri'
-uri = URI('https://api.rybbit.io/api/goals/123?start_date=2024-01-01&end_date=2024-01-31')
+uri = URI('https://api.rybbit.io/api/sites/1/goals23?start_date=2024-01-01&end_date=2024-01-31')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
@@ -261,7 +261,7 @@ import (
)
func main() {
- url := "https://api.rybbit.io/api/goals/123?start_date=2024-01-01&end_date=2024-01-31"
+ url := "https://api.rybbit.io/api/sites/1/goals23?start_date=2024-01-01&end_date=2024-01-31"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer your_api_key_here")
@@ -287,7 +287,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = reqwest::Client::new();
let response = client
- .get("https://api.rybbit.io/api/goals/123?start_date=2024-01-01&end_date=2024-01-31")
+ .get("https://api.rybbit.io/api/sites/1/goals23?start_date=2024-01-01&end_date=2024-01-31")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -310,7 +310,7 @@ public class Main {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/goals/123?start_date=2024-01-01&end_date=2024-01-31"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/goals23?start_date=2024-01-01&end_date=2024-01-31"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -338,7 +338,7 @@ class Program
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
var response = await client.GetAsync(
- "https://api.rybbit.io/api/goals/123?start_date=2024-01-01&end_date=2024-01-31");
+ "https://api.rybbit.io/api/sites/1/goals23?start_date=2024-01-01&end_date=2024-01-31");
var data = await response.Content.ReadAsStringAsync();
}
@@ -397,7 +397,7 @@ class Program
<div>
```
-GET /api/goals/:goalId/sessions/:site
+GET /api/sites/:site/goals/:goalId/sessions
```
Returns sessions that completed a specific goal. Useful for analyzing the behavior of converting users.
@@ -512,14 +512,14 @@ Accepts all [Common Parameters](/docs/api/getting-started#common-parameters) plu
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X GET "https://api.rybbit.io/api/goals/1/sessions/123?page=1&limit=10" \
+curl -X GET "https://api.rybbit.io/api/sites/1/goals/1/sessions23?page=1&limit=10" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/goals/1/sessions/123?page=1&limit=10',
+ 'https://api.rybbit.io/api/sites/1/goals/1/sessions23?page=1&limit=10',
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -535,7 +535,7 @@ const data = await response.json();
import requests
response = requests.get(
- 'https://api.rybbit.io/api/goals/1/sessions/123',
+ 'https://api.rybbit.io/api/sites/1/goals/1/sessions23',
params={
'page': 1,
'limit': 10
@@ -553,7 +553,7 @@ data = response.json()
<?php
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/goals/1/sessions/123?page=1&limit=10');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/goals/1/sessions23?page=1&limit=10');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -572,7 +572,7 @@ require 'net/http'
require 'json'
require 'uri'
-uri = URI('https://api.rybbit.io/api/goals/1/sessions/123?page=1&limit=10')
+uri = URI('https://api.rybbit.io/api/sites/1/goals/1/sessions23?page=1&limit=10')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
@@ -594,7 +594,7 @@ import (
)
func main() {
- url := "https://api.rybbit.io/api/goals/1/sessions/123?page=1&limit=10"
+ url := "https://api.rybbit.io/api/sites/1/goals/1/sessions23?page=1&limit=10"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer your_api_key_here")
@@ -620,7 +620,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = reqwest::Client::new();
let response = client
- .get("https://api.rybbit.io/api/goals/1/sessions/123?page=1&limit=10")
+ .get("https://api.rybbit.io/api/sites/1/goals/1/sessions23?page=1&limit=10")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -643,7 +643,7 @@ public class Main {
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/goals/1/sessions/123?page=1&limit=10"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/goals/1/sessions23?page=1&limit=10"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -671,7 +671,7 @@ class Program
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
var response = await client.GetAsync(
- "https://api.rybbit.io/api/goals/1/sessions/123?page=1&limit=10");
+ "https://api.rybbit.io/api/sites/1/goals/1/sessions23?page=1&limit=10");
var data = await response.Content.ReadAsStringAsync();
}
@@ -714,7 +714,7 @@ class Program
<div>
```
-POST /api/goals/:site
+POST /api/sites/:site/goals
```
Creates a new goal for tracking conversions.
@@ -810,7 +810,7 @@ Creates a new goal for tracking conversions.
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Path Goal"
-curl -X POST "https://api.rybbit.io/api/goals/123" \
+curl -X POST "https://api.rybbit.io/api/sites/1/goals23" \
-H "Authorization: Bearer your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
@@ -825,7 +825,7 @@ curl -X POST "https://api.rybbit.io/api/goals/123" \
<Tab value="JavaScript">
```javascript title="Event Goal"
const response = await fetch(
- 'https://api.rybbit.io/api/goals/123',
+ 'https://api.rybbit.io/api/sites/1/goals23',
{
method: 'POST',
headers: {
@@ -852,7 +852,7 @@ const data = await response.json();
import requests
response = requests.post(
- 'https://api.rybbit.io/api/goals/123',
+ 'https://api.rybbit.io/api/sites/1/goals23',
json={
'name': 'Signup Complete',
'goalType': 'path',
@@ -879,7 +879,7 @@ $body = [
];
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/goals/123');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/goals23');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($body));
@@ -899,7 +899,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/goals/123')
+uri = URI('https://api.rybbit.io/api/sites/1/goals23')
request = Net::HTTP::Post.new(uri)
request['Authorization'] = 'Bearer your_api_key_here'
request['Content-Type'] = 'application/json'
@@ -927,7 +927,7 @@ body := map[string]interface{}{
}
jsonBody, _ := json.Marshal(body)
-req, _ := http.NewRequest("POST", "https://api.rybbit.io/api/goals/123", bytes.NewBuffer(jsonBody))
+req, _ := http.NewRequest("POST", "https://api.rybbit.io/api/sites/1/goals23", bytes.NewBuffer(jsonBody))
req.Header.Set("Authorization", "Bearer your_api_key_here")
req.Header.Set("Content-Type", "application/json")
@@ -951,7 +951,7 @@ let body = serde_json::json!({
let client = reqwest::Client::new();
let res = client
- .post("https://api.rybbit.io/api/goals/123")
+ .post("https://api.rybbit.io/api/sites/1/goals23")
.header("Authorization", "Bearer your_api_key_here")
.json(&body)
.send()
@@ -974,7 +974,7 @@ String json = """
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/goals/123"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/goals23"))
.header("Authorization", "Bearer your_api_key_here")
.header("Content-Type", "application/json")
.POST(HttpRequest.BodyPublishers.ofString(json))
@@ -1000,7 +1000,7 @@ var content = new StringContent(
Encoding.UTF8,
"application/json");
-var response = await client.PostAsync("https://api.rybbit.io/api/goals/123", content);
+var response = await client.PostAsync("https://api.rybbit.io/api/sites/1/goals23", content);
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
@@ -1024,7 +1024,7 @@ var data = await response.Content.ReadAsStringAsync();
<div>
```
-PUT /api/goals/:goalId/:site
+PUT /api/sites/:site/goals/:goalId
```
Updates an existing goal.
@@ -1090,7 +1090,7 @@ Updates an existing goal.
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X PUT "https://api.rybbit.io/api/goals/1/123" \
+curl -X PUT "https://api.rybbit.io/api/sites/1/goals/123" \
-H "Authorization: Bearer your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
@@ -1105,7 +1105,7 @@ curl -X PUT "https://api.rybbit.io/api/goals/1/123" \
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/goals/1/123',
+ 'https://api.rybbit.io/api/sites/1/goals/123',
{
method: 'PUT',
headers: {
@@ -1130,7 +1130,7 @@ const data = await response.json();
import requests
response = requests.put(
- 'https://api.rybbit.io/api/goals/1/123',
+ 'https://api.rybbit.io/api/sites/1/goals/123',
json={
'name': 'Signup Completed (Updated)',
'goalType': 'path',
@@ -1157,7 +1157,7 @@ $body = [
];
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/goals/1/123');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/goals/123');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($body));
@@ -1177,7 +1177,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/goals/1/123')
+uri = URI('https://api.rybbit.io/api/sites/1/goals/123')
request = Net::HTTP::Put.new(uri)
request['Authorization'] = 'Bearer your_api_key_here'
request['Content-Type'] = 'application/json'
@@ -1205,7 +1205,7 @@ body := map[string]interface{}{
}
jsonBody, _ := json.Marshal(body)
-req, _ := http.NewRequest("PUT", "https://api.rybbit.io/api/goals/1/123", bytes.NewBuffer(jsonBody))
+req, _ := http.NewRequest("PUT", "https://api.rybbit.io/api/sites/1/goals/123", bytes.NewBuffer(jsonBody))
req.Header.Set("Authorization", "Bearer your_api_key_here")
req.Header.Set("Content-Type", "application/json")
@@ -1229,7 +1229,7 @@ let body = serde_json::json!({
let client = reqwest::Client::new();
let res = client
- .put("https://api.rybbit.io/api/goals/1/123")
+ .put("https://api.rybbit.io/api/sites/1/goals/123")
.header("Authorization", "Bearer your_api_key_here")
.json(&body)
.send()
@@ -1252,7 +1252,7 @@ String json = """
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/goals/1/123"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/goals/123"))
.header("Authorization", "Bearer your_api_key_here")
.header("Content-Type", "application/json")
.PUT(HttpRequest.BodyPublishers.ofString(json))
@@ -1278,7 +1278,7 @@ var content = new StringContent(
Encoding.UTF8,
"application/json");
-var response = await client.PutAsync("https://api.rybbit.io/api/goals/1/123", content);
+var response = await client.PutAsync("https://api.rybbit.io/api/sites/1/goals/123", content);
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
@@ -1302,7 +1302,7 @@ var data = await response.Content.ReadAsStringAsync();
<div>
```
-DELETE /api/goals/:goalId/:site
+DELETE /api/sites/:site/goals/:goalId
```
Deletes a goal. This action cannot be undone.
@@ -1341,14 +1341,14 @@ Deletes a goal. This action cannot be undone.
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X DELETE "https://api.rybbit.io/api/goals/1/123" \
+curl -X DELETE "https://api.rybbit.io/api/sites/1/goals/123" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/goals/1/123',
+ 'https://api.rybbit.io/api/sites/1/goals/123',
{
method: 'DELETE',
headers: {
@@ -1365,7 +1365,7 @@ const data = await response.json();
import requests
response = requests.delete(
- 'https://api.rybbit.io/api/goals/1/123',
+ 'https://api.rybbit.io/api/sites/1/goals/123',
headers={
'Authorization': 'Bearer your_api_key_here'
}
@@ -1377,7 +1377,7 @@ data = response.json()
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/goals/1/123');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/goals/123');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
@@ -1395,7 +1395,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/goals/1/123')
+uri = URI('https://api.rybbit.io/api/sites/1/goals/123')
request = Net::HTTP::Delete.new(uri)
request['Authorization'] = 'Bearer your_api_key_here'
@@ -1408,7 +1408,7 @@ data = JSON.parse(response.body)
</Tab>
<Tab value="Go">
```go title="Request"
-req, _ := http.NewRequest("DELETE", "https://api.rybbit.io/api/goals/1/123", nil)
+req, _ := http.NewRequest("DELETE", "https://api.rybbit.io/api/sites/1/goals/123", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
client := &http.Client{}
@@ -1423,7 +1423,7 @@ json.NewDecoder(resp.Body).Decode(&data)
```rust title="Request"
let client = reqwest::Client::new();
let res = client
- .delete("https://api.rybbit.io/api/goals/1/123")
+ .delete("https://api.rybbit.io/api/sites/1/goals/123")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -1435,7 +1435,7 @@ let data: serde_json::Value = res.json().await?;
```java title="Request"
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/goals/1/123"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/goals/123"))
.header("Authorization", "Bearer your_api_key_here")
.DELETE()
.build();
@@ -1448,7 +1448,7 @@ HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.o
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
-var response = await client.DeleteAsync("https://api.rybbit.io/api/goals/1/123");
+var response = await client.DeleteAsync("https://api.rybbit.io/api/sites/1/goals/123");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
diff --git a/docs/content/docs/api/stats/misc.mdx b/docs/content/docs/api/stats/misc.mdx
index 032287dd2..5cf6d0295 100644
--- a/docs/content/docs/api/stats/misc.mdx
+++ b/docs/content/docs/api/stats/misc.mdx
@@ -14,11 +14,11 @@ See the [API Reference](/docs/api/stats/reference) for authentication, common pa
<div className="flex flex-col gap-2 my-6">
<a href="#get-retention" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/retention/:site</code>
+ <code className="text-sm">/api/sites/:site/retention</code>
</a>
<a href="#get-journeys" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/journeys/:site</code>
+ <code className="text-sm">/api/sites/:site/journeys</code>
</a>
</div>
@@ -30,7 +30,7 @@ See the [API Reference](/docs/api/stats/reference) for authentication, common pa
<div>
```
-GET /api/retention/:site
+GET /api/sites/:site/retention
```
Returns cohort-based retention analysis data. Users are grouped into cohorts based on their first visit, and retention is tracked over subsequent time periods.
@@ -122,14 +122,14 @@ Returns cohort-based retention analysis data. Users are grouped into cohorts bas
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X GET "https://api.rybbit.io/api/retention/123?mode=week&range=90" \
+curl -X GET "https://api.rybbit.io/api/sites/1/retention23?mode=week&range=90" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/retention/123?mode=week&range=90',
+ 'https://api.rybbit.io/api/sites/1/retention23?mode=week&range=90',
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -145,7 +145,7 @@ const data = await response.json();
import requests
response = requests.get(
- 'https://api.rybbit.io/api/retention/123',
+ 'https://api.rybbit.io/api/sites/1/retention23',
params={
'mode': 'week',
'range': 90
@@ -161,7 +161,7 @@ data = response.json()
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/retention/123?mode=week&range=90');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/retention23?mode=week&range=90');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -178,7 +178,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/retention/123?mode=week&range=90')
+uri = URI('https://api.rybbit.io/api/sites/1/retention23?mode=week&range=90')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
@@ -188,7 +188,7 @@ data = JSON.parse(res.body)
</Tab>
<Tab value="Go">
```go title="Request"
-req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/retention/123?mode=week&range=90", nil)
+req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sites/1/retention23?mode=week&range=90", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
client := &http.Client{}
@@ -203,7 +203,7 @@ json.NewDecoder(resp.Body).Decode(&data)
```rust title="Request"
let client = reqwest::Client::new();
let res = client
- .get("https://api.rybbit.io/api/retention/123?mode=week&range=90")
+ .get("https://api.rybbit.io/api/sites/1/retention23?mode=week&range=90")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -215,7 +215,7 @@ let data: serde_json::Value = res.json().await?;
```java title="Request"
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/retention/123?mode=week&range=90"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/retention23?mode=week&range=90"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -228,7 +228,7 @@ HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.o
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
-var response = await client.GetAsync("https://api.rybbit.io/api/retention/123?mode=week&range=90");
+var response = await client.GetAsync("https://api.rybbit.io/api/sites/1/retention23?mode=week&range=90");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
@@ -309,7 +309,7 @@ Object.entries(cohorts).forEach(([date, cohort]) => {
<div>
```
-GET /api/journeys/:site
+GET /api/sites/:site/journeys
```
Returns the most common page navigation paths (user journeys) within sessions. Useful for understanding how users navigate through your site.
@@ -387,14 +387,14 @@ Accepts all [Common Parameters](/docs/api/getting-started#common-parameters) plu
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X GET "https://api.rybbit.io/api/journeys/123?steps=4&limit=20&start_date=2024-01-01&end_date=2024-01-31" \
+curl -X GET "https://api.rybbit.io/api/sites/1/journeys23?steps=4&limit=20&start_date=2024-01-01&end_date=2024-01-31" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/journeys/123?steps=4&limit=20&start_date=2024-01-01&end_date=2024-01-31',
+ 'https://api.rybbit.io/api/sites/1/journeys23?steps=4&limit=20&start_date=2024-01-01&end_date=2024-01-31',
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -410,7 +410,7 @@ const data = await response.json();
import requests
response = requests.get(
- 'https://api.rybbit.io/api/journeys/123',
+ 'https://api.rybbit.io/api/sites/1/journeys23',
params={
'steps': 4,
'limit': 20,
@@ -428,7 +428,7 @@ data = response.json()
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/journeys/123?steps=4&limit=20&start_date=2024-01-01&end_date=2024-01-31');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/journeys23?steps=4&limit=20&start_date=2024-01-01&end_date=2024-01-31');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -445,7 +445,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/journeys/123?steps=4&limit=20&start_date=2024-01-01&end_date=2024-01-31')
+uri = URI('https://api.rybbit.io/api/sites/1/journeys23?steps=4&limit=20&start_date=2024-01-01&end_date=2024-01-31')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
@@ -455,7 +455,7 @@ data = JSON.parse(res.body)
</Tab>
<Tab value="Go">
```go title="Request"
-req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/journeys/123?steps=4&limit=20&start_date=2024-01-01&end_date=2024-01-31", nil)
+req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sites/1/journeys23?steps=4&limit=20&start_date=2024-01-01&end_date=2024-01-31", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
client := &http.Client{}
@@ -470,7 +470,7 @@ json.NewDecoder(resp.Body).Decode(&data)
```rust title="Request"
let client = reqwest::Client::new();
let res = client
- .get("https://api.rybbit.io/api/journeys/123?steps=4&limit=20&start_date=2024-01-01&end_date=2024-01-31")
+ .get("https://api.rybbit.io/api/sites/1/journeys23?steps=4&limit=20&start_date=2024-01-01&end_date=2024-01-31")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -482,7 +482,7 @@ let data: serde_json::Value = res.json().await?;
```java title="Request"
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/journeys/123?steps=4&limit=20&start_date=2024-01-01&end_date=2024-01-31"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/journeys23?steps=4&limit=20&start_date=2024-01-01&end_date=2024-01-31"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -495,7 +495,7 @@ HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.o
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
-var response = await client.GetAsync("https://api.rybbit.io/api/journeys/123?steps=4&limit=20&start_date=2024-01-01&end_date=2024-01-31");
+var response = await client.GetAsync("https://api.rybbit.io/api/sites/1/journeys23?steps=4&limit=20&start_date=2024-01-01&end_date=2024-01-31");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
@@ -540,7 +540,7 @@ You can filter journeys that include specific pages at specific steps:
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Filter journeys starting from homepage"
-curl -X GET "https://api.rybbit.io/api/journeys/123?steps=3&stepFilters=%7B%220%22%3A%22%2F%22%7D" \
+curl -X GET "https://api.rybbit.io/api/sites/1/journeys23?steps=3&stepFilters=%7B%220%22%3A%22%2F%22%7D" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
@@ -549,7 +549,7 @@ curl -X GET "https://api.rybbit.io/api/journeys/123?steps=3&stepFilters=%7B%220%
const stepFilters = JSON.stringify({ "0": "/" });
const response = await fetch(
- `https://api.rybbit.io/api/journeys/123?steps=3&stepFilters=${encodeURIComponent(stepFilters)}`,
+ `https://api.rybbit.io/api/sites/1/journeys23?steps=3&stepFilters=${encodeURIComponent(stepFilters)}`,
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -563,7 +563,7 @@ const response = await fetch(
import requests
response = requests.get(
- 'https://api.rybbit.io/api/journeys/123?steps=3&stepFilters=%7B%220%22%3A%22%2F%22%7D',
+ 'https://api.rybbit.io/api/sites/1/journeys23?steps=3&stepFilters=%7B%220%22%3A%22%2F%22%7D',
headers={
'Authorization': 'Bearer your_api_key_here'
}
@@ -575,7 +575,7 @@ data = response.json()
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/journeys/123?steps=3&stepFilters=%7B%220%22%3A%22%2F%22%7D');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/journeys23?steps=3&stepFilters=%7B%220%22%3A%22%2F%22%7D');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -592,7 +592,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/journeys/123?steps=3&stepFilters=%7B%220%22%3A%22%2F%22%7D')
+uri = URI('https://api.rybbit.io/api/sites/1/journeys23?steps=3&stepFilters=%7B%220%22%3A%22%2F%22%7D')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
@@ -602,7 +602,7 @@ data = JSON.parse(res.body)
</Tab>
<Tab value="Go">
```go title="Request"
-req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/journeys/123?steps=3&stepFilters=%7B%220%22%3A%22%2F%22%7D", nil)
+req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sites/1/journeys23?steps=3&stepFilters=%7B%220%22%3A%22%2F%22%7D", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
client := &http.Client{}
@@ -617,7 +617,7 @@ json.NewDecoder(resp.Body).Decode(&data)
```rust title="Request"
let client = reqwest::Client::new();
let res = client
- .get("https://api.rybbit.io/api/journeys/123?steps=3&stepFilters=%7B%220%22%3A%22%2F%22%7D")
+ .get("https://api.rybbit.io/api/sites/1/journeys23?steps=3&stepFilters=%7B%220%22%3A%22%2F%22%7D")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -629,7 +629,7 @@ let data: serde_json::Value = res.json().await?;
```java title="Request"
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/journeys/123?steps=3&stepFilters=%7B%220%22%3A%22%2F%22%7D"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/journeys23?steps=3&stepFilters=%7B%220%22%3A%22%2F%22%7D"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -642,7 +642,7 @@ HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.o
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
-var response = await client.GetAsync("https://api.rybbit.io/api/journeys/123?steps=3&stepFilters=%7B%220%22%3A%22%2F%22%7D");
+var response = await client.GetAsync("https://api.rybbit.io/api/sites/1/journeys23?steps=3&stepFilters=%7B%220%22%3A%22%2F%22%7D");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
diff --git a/docs/content/docs/api/stats/overview.mdx b/docs/content/docs/api/stats/overview.mdx
index a8ab3ab9f..d7dc7647d 100644
--- a/docs/content/docs/api/stats/overview.mdx
+++ b/docs/content/docs/api/stats/overview.mdx
@@ -14,19 +14,19 @@ See the [API Reference](/docs/api/stats/reference) for authentication, common pa
<div className="flex flex-col gap-2 my-6">
<a href="#get-overview" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/overview/:site</code>
+ <code className="text-sm">/api/sites/:site/overview</code>
</a>
<a href="#get-overview-time-series" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/overview-bucketed/:site</code>
+ <code className="text-sm">/api/sites/:site/overview-bucketed</code>
</a>
<a href="#get-metric" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/metric/:site</code>
+ <code className="text-sm">/api/sites/:site/metric</code>
</a>
<a href="#get-live-visitors" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/live-user-count/:site</code>
+ <code className="text-sm">/api/sites/:site/live-user-count</code>
</a>
</div>
@@ -38,7 +38,7 @@ See the [API Reference](/docs/api/stats/reference) for authentication, common pa
<div>
```
-GET /api/overview/:site
+GET /api/sites/:site/overview
```
Returns high-level analytics metrics for a site.
@@ -97,14 +97,14 @@ Accepts all [Common Parameters](/docs/api/getting-started#common-parameters) (ti
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X GET "https://api.rybbit.io/api/overview/123?start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York" \
+curl -X GET "https://api.rybbit.io/api/sites/123/overview?start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/overview/123?start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York',
+ 'https://api.rybbit.io/api/sites/123/overview?start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York',
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -120,7 +120,7 @@ const data = await response.json();
import requests
response = requests.get(
- 'https://api.rybbit.io/api/overview/123',
+ 'https://api.rybbit.io/api/sites/123/overview',
params={
'start_date': '2024-01-01',
'end_date': '2024-01-31',
@@ -137,7 +137,7 @@ data = response.json()
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/overview/123?start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/123/overview?start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -154,7 +154,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/overview/123?start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York')
+uri = URI('https://api.rybbit.io/api/sites/123/overview?start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
@@ -164,7 +164,7 @@ data = JSON.parse(res.body)
</Tab>
<Tab value="Go">
```go title="Request"
-req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/overview/123?start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York", nil)
+req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sites/123/overview?start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
client := &http.Client{}
@@ -179,7 +179,7 @@ json.NewDecoder(resp.Body).Decode(&data)
```rust title="Request"
let client = reqwest::Client::new();
let res = client
- .get("https://api.rybbit.io/api/overview/123?start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York")
+ .get("https://api.rybbit.io/api/sites/123/overview?start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -191,7 +191,7 @@ let data: serde_json::Value = res.json().await?;
```java title="Request"
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/overview/123?start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/123/overview?start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -204,7 +204,7 @@ HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.o
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
-var response = await client.GetAsync("https://api.rybbit.io/api/overview/123?start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York");
+var response = await client.GetAsync("https://api.rybbit.io/api/sites/123/overview?start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
@@ -234,7 +234,7 @@ var data = await response.Content.ReadAsStringAsync();
<div>
```
-GET /api/overview-bucketed/:site
+GET /api/sites/:site/overview-bucketed
```
Returns time-series analytics data broken down by configurable time buckets. Useful for charting trends over time.
@@ -320,14 +320,14 @@ Accepts all [Common Parameters](/docs/api/getting-started#common-parameters) plu
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X GET "https://api.rybbit.io/api/overview-bucketed/123?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=America/New_York" \
+curl -X GET "https://api.rybbit.io/api/sites/123/overview-bucketed?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=America/New_York" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/overview-bucketed/123?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=America/New_York',
+ 'https://api.rybbit.io/api/sites/123/overview-bucketed?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=America/New_York',
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -343,7 +343,7 @@ const data = await response.json();
import requests
response = requests.get(
- 'https://api.rybbit.io/api/overview-bucketed/123',
+ 'https://api.rybbit.io/api/sites/123/overview-bucketed',
params={
'bucket': 'day',
'start_date': '2024-01-01',
@@ -361,7 +361,7 @@ data = response.json()
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/overview-bucketed/123?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=America/New_York');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/123/overview-bucketed?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=America/New_York');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -378,7 +378,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/overview-bucketed/123?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=America/New_York')
+uri = URI('https://api.rybbit.io/api/sites/123/overview-bucketed?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=America/New_York')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
@@ -388,7 +388,7 @@ data = JSON.parse(res.body)
</Tab>
<Tab value="Go">
```go title="Request"
-req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/overview-bucketed/123?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=America/New_York", nil)
+req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sites/123/overview-bucketed?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=America/New_York", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
client := &http.Client{}
@@ -403,7 +403,7 @@ json.NewDecoder(resp.Body).Decode(&data)
```rust title="Request"
let client = reqwest::Client::new();
let res = client
- .get("https://api.rybbit.io/api/overview-bucketed/123?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=America/New_York")
+ .get("https://api.rybbit.io/api/sites/123/overview-bucketed?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=America/New_York")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -415,7 +415,7 @@ let data: serde_json::Value = res.json().await?;
```java title="Request"
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/overview-bucketed/123?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=America/New_York"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/123/overview-bucketed?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=America/New_York"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -428,7 +428,7 @@ HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.o
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
-var response = await client.GetAsync("https://api.rybbit.io/api/overview-bucketed/123?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=America/New_York");
+var response = await client.GetAsync("https://api.rybbit.io/api/sites/123/overview-bucketed?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=America/New_York");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
@@ -479,7 +479,7 @@ var data = await response.Content.ReadAsStringAsync();
<div>
```
-GET /api/metric/:site
+GET /api/sites/:site/metric
```
Returns dimensional analytics data broken down by a specific parameter. Supports pagination.
@@ -575,14 +575,14 @@ Accepts all [Common Parameters](/docs/api/getting-started#common-parameters) plu
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X GET "https://api.rybbit.io/api/metric/123?parameter=country&start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York&limit=10" \
+curl -X GET "https://api.rybbit.io/api/sites/123/metric?parameter=country&start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York&limit=10" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/metric/123?parameter=country&start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York&limit=10',
+ 'https://api.rybbit.io/api/sites/123/metric?parameter=country&start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York&limit=10',
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -598,7 +598,7 @@ const data = await response.json();
import requests
response = requests.get(
- 'https://api.rybbit.io/api/metric/123',
+ 'https://api.rybbit.io/api/sites/123/metric',
params={
'parameter': 'country',
'start_date': '2024-01-01',
@@ -617,7 +617,7 @@ data = response.json()
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/metric/123?parameter=country&start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York&limit=10');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/123/metric?parameter=country&start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York&limit=10');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -634,7 +634,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/metric/123?parameter=country&start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York&limit=10')
+uri = URI('https://api.rybbit.io/api/sites/123/metric?parameter=country&start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York&limit=10')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
@@ -644,7 +644,7 @@ data = JSON.parse(res.body)
</Tab>
<Tab value="Go">
```go title="Request"
-req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/metric/123?parameter=country&start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York&limit=10", nil)
+req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sites/123/metric?parameter=country&start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York&limit=10", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
client := &http.Client{}
@@ -659,7 +659,7 @@ json.NewDecoder(resp.Body).Decode(&data)
```rust title="Request"
let client = reqwest::Client::new();
let res = client
- .get("https://api.rybbit.io/api/metric/123?parameter=country&start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York&limit=10")
+ .get("https://api.rybbit.io/api/sites/123/metric?parameter=country&start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York&limit=10")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -671,7 +671,7 @@ let data: serde_json::Value = res.json().await?;
```java title="Request"
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/metric/123?parameter=country&start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York&limit=10"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/123/metric?parameter=country&start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York&limit=10"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -684,7 +684,7 @@ HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.o
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
-var response = await client.GetAsync("https://api.rybbit.io/api/metric/123?parameter=country&start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York&limit=10");
+var response = await client.GetAsync("https://api.rybbit.io/api/sites/123/metric?parameter=country&start_date=2024-01-01&end_date=2024-01-31&time_zone=America/New_York&limit=10");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
@@ -727,7 +727,7 @@ var data = await response.Content.ReadAsStringAsync();
<div>
```
-GET /api/live-user-count/:site
+GET /api/sites/:site/live-user-count
```
Returns the count of unique active sessions within the specified time window. Useful for displaying real-time visitor counts.
@@ -783,14 +783,14 @@ Returns the count of unique active sessions within the specified time window. Us
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X GET "https://api.rybbit.io/api/live-user-count/123?minutes=5" \
+curl -X GET "https://api.rybbit.io/api/sites/123/live-user-count?minutes=5" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/live-user-count/123?minutes=5',
+ 'https://api.rybbit.io/api/sites/123/live-user-count?minutes=5',
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -807,7 +807,7 @@ console.log(`Live visitors: ${count}`);
import requests
response = requests.get(
- 'https://api.rybbit.io/api/live-user-count/123',
+ 'https://api.rybbit.io/api/sites/123/live-user-count',
params={'minutes': 5},
headers={
'Authorization': 'Bearer your_api_key_here'
@@ -821,7 +821,7 @@ print(f"Live visitors: {data['count']}")
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/live-user-count/123?minutes=5');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/123/live-user-count?minutes=5');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -839,7 +839,7 @@ echo "Live visitors: " . $data['count'];
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/live-user-count/123?minutes=5')
+uri = URI('https://api.rybbit.io/api/sites/123/live-user-count?minutes=5')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
@@ -850,7 +850,7 @@ puts "Live visitors: #{data['count']}"
</Tab>
<Tab value="Go">
```go title="Request"
-req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/live-user-count/123?minutes=5", nil)
+req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sites/123/live-user-count?minutes=5", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
client := &http.Client{}
@@ -866,7 +866,7 @@ fmt.Printf("Live visitors: %v\n", data["count"])
```rust title="Request"
let client = reqwest::Client::new();
let res = client
- .get("https://api.rybbit.io/api/live-user-count/123?minutes=5")
+ .get("https://api.rybbit.io/api/sites/123/live-user-count?minutes=5")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -879,7 +879,7 @@ println!("Live visitors: {}", data["count"]);
```java title="Request"
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/live-user-count/123?minutes=5"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/123/live-user-count?minutes=5"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -892,7 +892,7 @@ HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.o
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
-var response = await client.GetAsync("https://api.rybbit.io/api/live-user-count/123?minutes=5");
+var response = await client.GetAsync("https://api.rybbit.io/api/sites/123/live-user-count?minutes=5");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
@@ -909,7 +909,7 @@ var data = await response.Content.ReadAsStringAsync();
```javascript title="Real-time Widget"
async function updateLiveCount() {
const response = await fetch(
- 'https://api.rybbit.io/api/live-user-count/123?minutes=5',
+ 'https://api.rybbit.io/api/sites/123/live-user-count?minutes=5',
{
headers: {
'Authorization': 'Bearer your_api_key'
diff --git a/docs/content/docs/api/stats/performance.mdx b/docs/content/docs/api/stats/performance.mdx
index 5e35312c0..7805ce38e 100644
--- a/docs/content/docs/api/stats/performance.mdx
+++ b/docs/content/docs/api/stats/performance.mdx
@@ -26,15 +26,15 @@ The performance endpoints return data for the following Core Web Vitals metrics:
<div className="flex flex-col gap-2 my-6">
<a href="#get-performance-overview" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/performance/overview/:site</code>
+ <code className="text-sm">/api/sites/:site/performance/overview</code>
</a>
<a href="#get-performance-time-series" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/performance/time-series/:site</code>
+ <code className="text-sm">/api/sites/:site/performance/time-series</code>
</a>
<a href="#get-performance-by-dimension" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/performance/by-dimension/:site</code>
+ <code className="text-sm">/api/sites/:site/performance/by-dimension</code>
</a>
</div>
@@ -46,7 +46,7 @@ The performance endpoints return data for the following Core Web Vitals metrics:
<div>
```
-GET /api/performance/overview/:site
+GET /api/sites/:site/performance/overview
```
Returns aggregate performance metrics with percentile breakdowns for all Core Web Vitals.
@@ -117,14 +117,14 @@ Each metric (lcp, cls, inp, fcp, ttfb) includes the following percentiles:
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X GET "https://api.rybbit.io/api/performance/overview/123?start_date=2024-01-01&end_date=2024-01-31" \
+curl -X GET "https://api.rybbit.io/api/sites/1/performance/overview23?start_date=2024-01-01&end_date=2024-01-31" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/performance/overview/123?start_date=2024-01-01&end_date=2024-01-31',
+ 'https://api.rybbit.io/api/sites/1/performance/overview23?start_date=2024-01-01&end_date=2024-01-31',
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -140,7 +140,7 @@ const data = await response.json();
import requests
response = requests.get(
- 'https://api.rybbit.io/api/performance/overview/123',
+ 'https://api.rybbit.io/api/sites/1/performance/overview23',
params={
'start_date': '2024-01-01',
'end_date': '2024-01-31'
@@ -156,7 +156,7 @@ data = response.json()
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/performance/overview/123?start_date=2024-01-01&end_date=2024-01-31');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/performance/overview23?start_date=2024-01-01&end_date=2024-01-31');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -173,7 +173,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/performance/overview/123?start_date=2024-01-01&end_date=2024-01-31')
+uri = URI('https://api.rybbit.io/api/sites/1/performance/overview23?start_date=2024-01-01&end_date=2024-01-31')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
@@ -183,7 +183,7 @@ data = JSON.parse(res.body)
</Tab>
<Tab value="Go">
```go title="Request"
-req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/performance/overview/123?start_date=2024-01-01&end_date=2024-01-31", nil)
+req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sites/1/performance/overview23?start_date=2024-01-01&end_date=2024-01-31", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
client := &http.Client{}
@@ -198,7 +198,7 @@ json.NewDecoder(resp.Body).Decode(&data)
```rust title="Request"
let client = reqwest::Client::new();
let res = client
- .get("https://api.rybbit.io/api/performance/overview/123?start_date=2024-01-01&end_date=2024-01-31")
+ .get("https://api.rybbit.io/api/sites/1/performance/overview23?start_date=2024-01-01&end_date=2024-01-31")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -210,7 +210,7 @@ let data: serde_json::Value = res.json().await?;
```java title="Request"
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/performance/overview/123?start_date=2024-01-01&end_date=2024-01-31"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/performance/overview23?start_date=2024-01-01&end_date=2024-01-31"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -223,7 +223,7 @@ HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.o
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
-var response = await client.GetAsync("https://api.rybbit.io/api/performance/overview/123?start_date=2024-01-01&end_date=2024-01-31");
+var response = await client.GetAsync("https://api.rybbit.io/api/sites/1/performance/overview23?start_date=2024-01-01&end_date=2024-01-31");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
@@ -268,7 +268,7 @@ var data = await response.Content.ReadAsStringAsync();
<div>
```
-GET /api/performance/time-series/:site
+GET /api/sites/:site/performance/time-series
```
Returns performance metrics over time, broken down by configurable time buckets. Useful for charting performance trends.
@@ -335,14 +335,14 @@ Each point includes all percentiles for each metric plus:
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X GET "https://api.rybbit.io/api/performance/time-series/123?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=UTC" \
+curl -X GET "https://api.rybbit.io/api/sites/1/performance/time-series23?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=UTC" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/performance/time-series/123?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=UTC',
+ 'https://api.rybbit.io/api/sites/1/performance/time-series23?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=UTC',
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -358,7 +358,7 @@ const data = await response.json();
import requests
response = requests.get(
- 'https://api.rybbit.io/api/performance/time-series/123',
+ 'https://api.rybbit.io/api/sites/1/performance/time-series23',
params={
'bucket': 'day',
'start_date': '2024-01-01',
@@ -376,7 +376,7 @@ data = response.json()
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/performance/time-series/123?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=UTC');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/performance/time-series23?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=UTC');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -393,7 +393,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/performance/time-series/123?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=UTC')
+uri = URI('https://api.rybbit.io/api/sites/1/performance/time-series23?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=UTC')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
@@ -403,7 +403,7 @@ data = JSON.parse(res.body)
</Tab>
<Tab value="Go">
```go title="Request"
-req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/performance/time-series/123?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=UTC", nil)
+req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sites/1/performance/time-series23?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=UTC", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
client := &http.Client{}
@@ -418,7 +418,7 @@ json.NewDecoder(resp.Body).Decode(&data)
```rust title="Request"
let client = reqwest::Client::new();
let res = client
- .get("https://api.rybbit.io/api/performance/time-series/123?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=UTC")
+ .get("https://api.rybbit.io/api/sites/1/performance/time-series23?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=UTC")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -430,7 +430,7 @@ let data: serde_json::Value = res.json().await?;
```java title="Request"
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/performance/time-series/123?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=UTC"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/performance/time-series23?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=UTC"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -443,7 +443,7 @@ HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.o
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
-var response = await client.GetAsync("https://api.rybbit.io/api/performance/time-series/123?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=UTC");
+var response = await client.GetAsync("https://api.rybbit.io/api/sites/1/performance/time-series23?bucket=day&start_date=2024-01-01&end_date=2024-01-07&time_zone=UTC");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
@@ -499,7 +499,7 @@ var data = await response.Content.ReadAsStringAsync();
<div>
```
-GET /api/performance/by-dimension/:site
+GET /api/sites/:site/performance/by-dimension
```
Returns performance metrics broken down by a specific dimension (page, country, browser, etc.). Useful for identifying performance issues on specific pages or for specific user segments.
@@ -606,14 +606,14 @@ Each object includes the dimension value plus all percentiles:
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X GET "https://api.rybbit.io/api/performance/by-dimension/123?dimension=pathname&sort_by=lcp_p75&sort_order=desc&limit=10" \
+curl -X GET "https://api.rybbit.io/api/sites/1/performance/by-dimension23?dimension=pathname&sort_by=lcp_p75&sort_order=desc&limit=10" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/performance/by-dimension/123?dimension=pathname&sort_by=lcp_p75&sort_order=desc&limit=10',
+ 'https://api.rybbit.io/api/sites/1/performance/by-dimension23?dimension=pathname&sort_by=lcp_p75&sort_order=desc&limit=10',
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -629,7 +629,7 @@ const data = await response.json();
import requests
response = requests.get(
- 'https://api.rybbit.io/api/performance/by-dimension/123',
+ 'https://api.rybbit.io/api/sites/1/performance/by-dimension23',
params={
'dimension': 'pathname',
'sort_by': 'lcp_p75',
@@ -647,7 +647,7 @@ data = response.json()
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/performance/by-dimension/123?dimension=pathname&sort_by=lcp_p75&sort_order=desc&limit=10');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/performance/by-dimension23?dimension=pathname&sort_by=lcp_p75&sort_order=desc&limit=10');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -664,7 +664,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/performance/by-dimension/123?dimension=pathname&sort_by=lcp_p75&sort_order=desc&limit=10')
+uri = URI('https://api.rybbit.io/api/sites/1/performance/by-dimension23?dimension=pathname&sort_by=lcp_p75&sort_order=desc&limit=10')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
@@ -674,7 +674,7 @@ data = JSON.parse(res.body)
</Tab>
<Tab value="Go">
```go title="Request"
-req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/performance/by-dimension/123?dimension=pathname&sort_by=lcp_p75&sort_order=desc&limit=10", nil)
+req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sites/1/performance/by-dimension23?dimension=pathname&sort_by=lcp_p75&sort_order=desc&limit=10", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
client := &http.Client{}
@@ -689,7 +689,7 @@ json.NewDecoder(resp.Body).Decode(&data)
```rust title="Request"
let client = reqwest::Client::new();
let res = client
- .get("https://api.rybbit.io/api/performance/by-dimension/123?dimension=pathname&sort_by=lcp_p75&sort_order=desc&limit=10")
+ .get("https://api.rybbit.io/api/sites/1/performance/by-dimension23?dimension=pathname&sort_by=lcp_p75&sort_order=desc&limit=10")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -701,7 +701,7 @@ let data: serde_json::Value = res.json().await?;
```java title="Request"
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/performance/by-dimension/123?dimension=pathname&sort_by=lcp_p75&sort_order=desc&limit=10"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/performance/by-dimension23?dimension=pathname&sort_by=lcp_p75&sort_order=desc&limit=10"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -714,7 +714,7 @@ HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.o
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
-var response = await client.GetAsync("https://api.rybbit.io/api/performance/by-dimension/123?dimension=pathname&sort_by=lcp_p75&sort_order=desc&limit=10");
+var response = await client.GetAsync("https://api.rybbit.io/api/sites/1/performance/by-dimension23?dimension=pathname&sort_by=lcp_p75&sort_order=desc&limit=10");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
diff --git a/docs/content/docs/api/stats/sessions.mdx b/docs/content/docs/api/stats/sessions.mdx
index c5d7d0bbb..8252e0f6c 100644
--- a/docs/content/docs/api/stats/sessions.mdx
+++ b/docs/content/docs/api/stats/sessions.mdx
@@ -14,15 +14,15 @@ See the [API Reference](/docs/api/stats/reference) for authentication, common pa
<div className="flex flex-col gap-2 my-6">
<a href="#get-sessions" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/sessions/:site</code>
+ <code className="text-sm">/api/sites/:site/sessions</code>
</a>
<a href="#get-session" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/sessions/:sessionId/:site</code>
+ <code className="text-sm">/api/sites/:site/sessions/:sessionId</code>
</a>
<a href="#get-session-locations" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/session-locations/:site</code>
+ <code className="text-sm">/api/sites/:site/session-locations</code>
</a>
</div>
@@ -34,7 +34,7 @@ See the [API Reference](/docs/api/stats/reference) for authentication, common pa
<div>
```
-GET /api/sessions/:site
+GET /api/sites/:site/sessions
```
Returns a paginated list of sessions with their analytics data.
@@ -195,14 +195,14 @@ Accepts all [Common Parameters](/docs/api/getting-started#common-parameters) plu
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X GET "https://api.rybbit.io/api/sessions/123?page=1&limit=20&start_date=2024-01-01&end_date=2024-01-31" \
+curl -X GET "https://api.rybbit.io/api/sites/1/sessions23?page=1&limit=20&start_date=2024-01-01&end_date=2024-01-31" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/sessions/123?page=1&limit=20&start_date=2024-01-01&end_date=2024-01-31',
+ 'https://api.rybbit.io/api/sites/1/sessions23?page=1&limit=20&start_date=2024-01-01&end_date=2024-01-31',
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -218,7 +218,7 @@ const data = await response.json();
import requests
response = requests.get(
- 'https://api.rybbit.io/api/sessions/123',
+ 'https://api.rybbit.io/api/sites/1/sessions23',
params={
'page': 1,
'limit': 20,
@@ -236,7 +236,7 @@ data = response.json()
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sessions/123?page=1&limit=20&start_date=2024-01-01&end_date=2024-01-31');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/sessions23?page=1&limit=20&start_date=2024-01-01&end_date=2024-01-31');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -253,7 +253,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/sessions/123?page=1&limit=20&start_date=2024-01-01&end_date=2024-01-31')
+uri = URI('https://api.rybbit.io/api/sites/1/sessions23?page=1&limit=20&start_date=2024-01-01&end_date=2024-01-31')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
@@ -263,7 +263,7 @@ data = JSON.parse(res.body)
</Tab>
<Tab value="Go">
```go title="Request"
-req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sessions/123?page=1&limit=20&start_date=2024-01-01&end_date=2024-01-31", nil)
+req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sites/1/sessions23?page=1&limit=20&start_date=2024-01-01&end_date=2024-01-31", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
client := &http.Client{}
@@ -278,7 +278,7 @@ json.NewDecoder(resp.Body).Decode(&data)
```rust title="Request"
let client = reqwest::Client::new();
let res = client
- .get("https://api.rybbit.io/api/sessions/123?page=1&limit=20&start_date=2024-01-01&end_date=2024-01-31")
+ .get("https://api.rybbit.io/api/sites/1/sessions23?page=1&limit=20&start_date=2024-01-01&end_date=2024-01-31")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -290,7 +290,7 @@ let data: serde_json::Value = res.json().await?;
```java title="Request"
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/sessions/123?page=1&limit=20&start_date=2024-01-01&end_date=2024-01-31"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/sessions23?page=1&limit=20&start_date=2024-01-01&end_date=2024-01-31"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -303,7 +303,7 @@ HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.o
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
-var response = await client.GetAsync("https://api.rybbit.io/api/sessions/123?page=1&limit=20&start_date=2024-01-01&end_date=2024-01-31");
+var response = await client.GetAsync("https://api.rybbit.io/api/sites/1/sessions23?page=1&limit=20&start_date=2024-01-01&end_date=2024-01-31");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
@@ -351,7 +351,7 @@ var data = await response.Content.ReadAsStringAsync();
<div>
```
-GET /api/sessions/:sessionId/:site
+GET /api/sites/:site/sessions/:sessionId
```
Returns detailed information about a specific session including all events and pageviews.
@@ -468,14 +468,14 @@ Returns detailed information about a specific session including all events and p
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X GET "https://api.rybbit.io/api/sessions/sess_abc123/123?limit=50" \
+curl -X GET "https://api.rybbit.io/api/sites/123/sessions/sess_abc123/123?limit=50" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/sessions/sess_abc123/123?limit=50',
+ 'https://api.rybbit.io/api/sites/123/sessions/sess_abc123/123?limit=50',
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -491,7 +491,7 @@ const data = await response.json();
import requests
response = requests.get(
- 'https://api.rybbit.io/api/sessions/sess_abc123/123',
+ 'https://api.rybbit.io/api/sites/123/sessions/sess_abc123/123',
params={'limit': 50},
headers={
'Authorization': 'Bearer your_api_key_here'
@@ -504,7 +504,7 @@ data = response.json()
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sessions/sess_abc123/123?limit=50');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/123/sessions/sess_abc123/123?limit=50');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -521,7 +521,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/sessions/sess_abc123/123?limit=50')
+uri = URI('https://api.rybbit.io/api/sites/123/sessions/sess_abc123/123?limit=50')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
@@ -531,7 +531,7 @@ data = JSON.parse(res.body)
</Tab>
<Tab value="Go">
```go title="Request"
-req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sessions/sess_abc123/123?limit=50", nil)
+req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sites/123/sessions/sess_abc123/123?limit=50", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
client := &http.Client{}
@@ -546,7 +546,7 @@ json.NewDecoder(resp.Body).Decode(&data)
```rust title="Request"
let client = reqwest::Client::new();
let res = client
- .get("https://api.rybbit.io/api/sessions/sess_abc123/123?limit=50")
+ .get("https://api.rybbit.io/api/sites/123/sessions/sess_abc123/123?limit=50")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -558,7 +558,7 @@ let data: serde_json::Value = res.json().await?;
```java title="Request"
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/sessions/sess_abc123/123?limit=50"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/123/sessions/sess_abc123/123?limit=50"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -571,7 +571,7 @@ HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.o
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
-var response = await client.GetAsync("https://api.rybbit.io/api/sessions/sess_abc123/123?limit=50");
+var response = await client.GetAsync("https://api.rybbit.io/api/sites/123/sessions/sess_abc123/123?limit=50");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
@@ -634,7 +634,7 @@ var data = await response.Content.ReadAsStringAsync();
<div>
```
-GET /api/session-locations/:site
+GET /api/sites/:site/session-locations
```
Returns aggregated session locations with coordinates for map visualization.
@@ -699,14 +699,14 @@ Accepts all [Common Parameters](/docs/api/getting-started#common-parameters) (ti
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X GET "https://api.rybbit.io/api/session-locations/123?start_date=2024-01-01&end_date=2024-01-31" \
+curl -X GET "https://api.rybbit.io/api/sites/1/session-locations23?start_date=2024-01-01&end_date=2024-01-31" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/session-locations/123?start_date=2024-01-01&end_date=2024-01-31',
+ 'https://api.rybbit.io/api/sites/1/session-locations23?start_date=2024-01-01&end_date=2024-01-31',
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -722,7 +722,7 @@ const data = await response.json();
import requests
response = requests.get(
- 'https://api.rybbit.io/api/session-locations/123',
+ 'https://api.rybbit.io/api/sites/1/session-locations23',
params={
'start_date': '2024-01-01',
'end_date': '2024-01-31'
@@ -738,7 +738,7 @@ data = response.json()
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/session-locations/123?start_date=2024-01-01&end_date=2024-01-31');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/session-locations23?start_date=2024-01-01&end_date=2024-01-31');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -755,7 +755,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/session-locations/123?start_date=2024-01-01&end_date=2024-01-31')
+uri = URI('https://api.rybbit.io/api/sites/1/session-locations23?start_date=2024-01-01&end_date=2024-01-31')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
@@ -765,7 +765,7 @@ data = JSON.parse(res.body)
</Tab>
<Tab value="Go">
```go title="Request"
-req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/session-locations/123?start_date=2024-01-01&end_date=2024-01-31", nil)
+req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sites/1/session-locations23?start_date=2024-01-01&end_date=2024-01-31", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
client := &http.Client{}
@@ -780,7 +780,7 @@ json.NewDecoder(resp.Body).Decode(&data)
```rust title="Request"
let client = reqwest::Client::new();
let res = client
- .get("https://api.rybbit.io/api/session-locations/123?start_date=2024-01-01&end_date=2024-01-31")
+ .get("https://api.rybbit.io/api/sites/1/session-locations23?start_date=2024-01-01&end_date=2024-01-31")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -792,7 +792,7 @@ let data: serde_json::Value = res.json().await?;
```java title="Request"
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/session-locations/123?start_date=2024-01-01&end_date=2024-01-31"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/session-locations23?start_date=2024-01-01&end_date=2024-01-31"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -805,7 +805,7 @@ HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.o
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
-var response = await client.GetAsync("https://api.rybbit.io/api/session-locations/123?start_date=2024-01-01&end_date=2024-01-31");
+var response = await client.GetAsync("https://api.rybbit.io/api/sites/1/session-locations23?start_date=2024-01-01&end_date=2024-01-31");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
diff --git a/docs/content/docs/api/stats/users.mdx b/docs/content/docs/api/stats/users.mdx
index 4169e0ed9..2cc65d297 100644
--- a/docs/content/docs/api/stats/users.mdx
+++ b/docs/content/docs/api/stats/users.mdx
@@ -14,19 +14,19 @@ See the [API Reference](/docs/api/stats/reference) for authentication, common pa
<div className="flex flex-col gap-2 my-6">
<a href="#get-users" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/users/:site</code>
+ <code className="text-sm">/api/sites/:site/users</code>
</a>
<a href="#get-user-sessions" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/users/:userId/sessions/:site</code>
+ <code className="text-sm">/api/sites/:site/users/:userId/sessions</code>
</a>
<a href="#get-user-session-count" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/users/session-count/:site</code>
+ <code className="text-sm">/api/sites/:site/users/session-count</code>
</a>
<a href="#get-user-info" className="flex items-center gap-3 p-3 rounded-lg bg-fd-secondary/50 hover:bg-fd-secondary transition-colors no-underline">
<span className="px-2 py-1 text-xs font-bold rounded bg-green-500/20 text-green-600 dark:text-green-400">GET</span>
- <code className="text-sm">/api/users/:userId/:site</code>
+ <code className="text-sm">/api/sites/:site/users/:userId</code>
</a>
</div>
@@ -38,7 +38,7 @@ See the [API Reference](/docs/api/stats/reference) for authentication, common pa
<div>
```
-GET /api/users/:site
+GET /api/sites/:site/users
```
Returns a paginated list of users with their analytics data. Supports filtering by identified users only.
@@ -194,14 +194,14 @@ Accepts all [Common Parameters](/docs/api/getting-started#common-parameters) plu
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X GET "https://api.rybbit.io/api/users/123?page=1&page_size=10&sort_by=last_seen&sort_order=desc" \
+curl -X GET "https://api.rybbit.io/api/sites/1/users23?page=1&page_size=10&sort_by=last_seen&sort_order=desc" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/users/123?page=1&page_size=10&sort_by=last_seen&sort_order=desc',
+ 'https://api.rybbit.io/api/sites/1/users23?page=1&page_size=10&sort_by=last_seen&sort_order=desc',
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -217,7 +217,7 @@ const data = await response.json();
import requests
response = requests.get(
- 'https://api.rybbit.io/api/users/123',
+ 'https://api.rybbit.io/api/sites/1/users23',
params={
'page': 1,
'page_size': 10,
@@ -235,7 +235,7 @@ data = response.json()
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/users/123?page=1&page_size=10&sort_by=last_seen&sort_order=desc');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/users23?page=1&page_size=10&sort_by=last_seen&sort_order=desc');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -252,7 +252,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/users/123?page=1&page_size=10&sort_by=last_seen&sort_order=desc')
+uri = URI('https://api.rybbit.io/api/sites/1/users23?page=1&page_size=10&sort_by=last_seen&sort_order=desc')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
@@ -262,7 +262,7 @@ data = JSON.parse(res.body)
</Tab>
<Tab value="Go">
```go title="Request"
-req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/users/123?page=1&page_size=10&sort_by=last_seen&sort_order=desc", nil)
+req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sites/1/users23?page=1&page_size=10&sort_by=last_seen&sort_order=desc", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
client := &http.Client{}
@@ -277,7 +277,7 @@ json.NewDecoder(resp.Body).Decode(&data)
```rust title="Request"
let client = reqwest::Client::new();
let res = client
- .get("https://api.rybbit.io/api/users/123?page=1&page_size=10&sort_by=last_seen&sort_order=desc")
+ .get("https://api.rybbit.io/api/sites/1/users23?page=1&page_size=10&sort_by=last_seen&sort_order=desc")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -289,7 +289,7 @@ let data: serde_json::Value = res.json().await?;
```java title="Request"
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/users/123?page=1&page_size=10&sort_by=last_seen&sort_order=desc"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/users23?page=1&page_size=10&sort_by=last_seen&sort_order=desc"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -302,7 +302,7 @@ HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.o
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
-var response = await client.GetAsync("https://api.rybbit.io/api/users/123?page=1&page_size=10&sort_by=last_seen&sort_order=desc");
+var response = await client.GetAsync("https://api.rybbit.io/api/sites/1/users23?page=1&page_size=10&sort_by=last_seen&sort_order=desc");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
@@ -350,7 +350,7 @@ var data = await response.Content.ReadAsStringAsync();
<div>
```
-GET /api/users/session-count/:site
+GET /api/sites/:site/users/session-count
```
Returns the number of sessions per day for a specific user. Useful for visualizing user engagement over time.
@@ -418,14 +418,14 @@ Returns the number of sessions per day for a specific user. Useful for visualizi
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X GET "https://api.rybbit.io/api/users/session-count/123?user_id=abc123def456&time_zone=America/New_York" \
+curl -X GET "https://api.rybbit.io/api/sites/1/users/session-count23?user_id=abc123def456&time_zone=America/New_York" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/users/session-count/123?user_id=abc123def456&time_zone=America/New_York',
+ 'https://api.rybbit.io/api/sites/1/users/session-count23?user_id=abc123def456&time_zone=America/New_York',
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -441,7 +441,7 @@ const data = await response.json();
import requests
response = requests.get(
- 'https://api.rybbit.io/api/users/session-count/123',
+ 'https://api.rybbit.io/api/sites/1/users/session-count23',
params={
'user_id': 'abc123def456',
'time_zone': 'America/New_York'
@@ -457,7 +457,7 @@ data = response.json()
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/users/session-count/123?user_id=abc123def456&time_zone=America/New_York');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/1/users/session-count23?user_id=abc123def456&time_zone=America/New_York');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -474,7 +474,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/users/session-count/123?user_id=abc123def456&time_zone=America/New_York')
+uri = URI('https://api.rybbit.io/api/sites/1/users/session-count23?user_id=abc123def456&time_zone=America/New_York')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
@@ -484,7 +484,7 @@ data = JSON.parse(res.body)
</Tab>
<Tab value="Go">
```go title="Request"
-req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/users/session-count/123?user_id=abc123def456&time_zone=America/New_York", nil)
+req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sites/1/users/session-count23?user_id=abc123def456&time_zone=America/New_York", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
client := &http.Client{}
@@ -499,7 +499,7 @@ json.NewDecoder(resp.Body).Decode(&data)
```rust title="Request"
let client = reqwest::Client::new();
let res = client
- .get("https://api.rybbit.io/api/users/session-count/123?user_id=abc123def456&time_zone=America/New_York")
+ .get("https://api.rybbit.io/api/sites/1/users/session-count23?user_id=abc123def456&time_zone=America/New_York")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -511,7 +511,7 @@ let data: serde_json::Value = res.json().await?;
```java title="Request"
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/users/session-count/123?user_id=abc123def456&time_zone=America/New_York"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/1/users/session-count23?user_id=abc123def456&time_zone=America/New_York"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -524,7 +524,7 @@ HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.o
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
-var response = await client.GetAsync("https://api.rybbit.io/api/users/session-count/123?user_id=abc123def456&time_zone=America/New_York");
+var response = await client.GetAsync("https://api.rybbit.io/api/sites/1/users/session-count23?user_id=abc123def456&time_zone=America/New_York");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
@@ -564,7 +564,7 @@ var data = await response.Content.ReadAsStringAsync();
<div>
```
-GET /api/users/:userId/:site
+GET /api/sites/:site/users/:userId
```
Returns detailed information about a specific user, including their profile traits and linked devices.
@@ -712,14 +712,14 @@ Returns detailed information about a specific user, including their profile trai
<Tabs items={['cURL', 'JavaScript', 'Python', 'PHP', 'Ruby', 'Go', 'Rust', 'Java', '.NET']}>
<Tab value="cURL">
```bash title="Request"
-curl -X GET "https://api.rybbit.io/api/users/[email protected]/123" \
+curl -X GET "https://api.rybbit.io/api/sites/123/users/[email protected]/123" \
-H "Authorization: Bearer your_api_key_here"
```
</Tab>
<Tab value="JavaScript">
```javascript title="Request"
const response = await fetch(
- 'https://api.rybbit.io/api/users/[email protected]/123',
+ 'https://api.rybbit.io/api/sites/123/users/[email protected]/123',
{
headers: {
'Authorization': 'Bearer your_api_key_here'
@@ -735,7 +735,7 @@ const data = await response.json();
import requests
response = requests.get(
- 'https://api.rybbit.io/api/users/[email protected]/123',
+ 'https://api.rybbit.io/api/sites/123/users/[email protected]/123',
headers={
'Authorization': 'Bearer your_api_key_here'
}
@@ -747,7 +747,7 @@ data = response.json()
<Tab value="PHP">
```php title="Request"
$ch = curl_init();
-curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/users/[email protected]/123');
+curl_setopt($ch, CURLOPT_URL, 'https://api.rybbit.io/api/sites/123/users/[email protected]/123');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'Authorization: Bearer your_api_key_here'
@@ -764,7 +764,7 @@ $data = json_decode($response, true);
require 'net/http'
require 'json'
-uri = URI('https://api.rybbit.io/api/users/[email protected]/123')
+uri = URI('https://api.rybbit.io/api/sites/123/users/[email protected]/123')
req = Net::HTTP::Get.new(uri)
req['Authorization'] = 'Bearer your_api_key_here'
@@ -774,7 +774,7 @@ data = JSON.parse(res.body)
</Tab>
<Tab value="Go">
```go title="Request"
-req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/users/[email protected]/123", nil)
+req, _ := http.NewRequest("GET", "https://api.rybbit.io/api/sites/123/users/[email protected]/123", nil)
req.Header.Set("Authorization", "Bearer your_api_key_here")
client := &http.Client{}
@@ -789,7 +789,7 @@ json.NewDecoder(resp.Body).Decode(&data)
```rust title="Request"
let client = reqwest::Client::new();
let res = client
- .get("https://api.rybbit.io/api/users/[email protected]/123")
+ .get("https://api.rybbit.io/api/sites/123/users/[email protected]/123")
.header("Authorization", "Bearer your_api_key_here")
.send()
.await?;
@@ -801,7 +801,7 @@ let data: serde_json::Value = res.json().await?;
```java title="Request"
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
- .uri(URI.create("https://api.rybbit.io/api/users/[email protected]/123"))
+ .uri(URI.create("https://api.rybbit.io/api/sites/123/users/[email protected]/123"))
.header("Authorization", "Bearer your_api_key_here")
.GET()
.build();
@@ -814,7 +814,7 @@ HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.o
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("Authorization", "Bearer your_api_key_here");
-var response = await client.GetAsync("https://api.rybbit.io/api/users/[email protected]/123");
+var response = await client.GetAsync("https://api.rybbit.io/api/sites/123/users/[email protected]/123");
var data = await response.Content.ReadAsStringAsync();
```
</Tab>
diff --git a/server/src/index.ts b/server/src/index.ts
index 103cf2aa1..89e9b8d93 100644
--- a/server/src/index.ts
+++ b/server/src/index.ts
@@ -103,7 +103,6 @@ import { auth } from "./lib/auth.js";
import { IS_CLOUD } from "./lib/const.js";
import { trackEvent } from "./services/tracker/trackEvent.js";
import { handleIdentify } from "./services/tracker/identifyService.js";
-// need to import telemetry service here to start it
import { telemetryService } from "./services/telemetryService.js";
import { weeklyReportService } from "./services/weekyReports/weeklyReportService.js";
import {
@@ -245,52 +244,52 @@ async function analyticsRoutes(fastify: FastifyInstance) {
// WEB & PRODUCT ANALYTICS
// This endpoint gets called a lot so we don't want to log it
- fastify.get("/live-user-count/:siteId", { logLevel: "silent", ...publicSite }, getLiveUsercount);
- fastify.get("/overview/:siteId", publicSite, getOverview);
- fastify.get("/overview-bucketed/:siteId", publicSite, getOverviewBucketed);
- fastify.get("/metric/:siteId", publicSite, getMetric);
- fastify.get("/page-titles/:siteId", publicSite, getPageTitles);
- fastify.get("/error-names/:siteId", publicSite, getErrorNames);
- fastify.get("/error-events/:siteId", publicSite, getErrorEvents);
- fastify.get("/error-bucketed/:siteId", publicSite, getErrorBucketed);
- fastify.get("/retention/:siteId", publicSite, getRetention);
- fastify.get("/site-has-data/:siteId", publicSite, getSiteHasData);
- fastify.get("/site-is-public/:siteId", publicSite, getSiteIsPublic);
- fastify.get("/sessions/:siteId", publicSite, getSessions);
- fastify.get("/sessions/:sessionId/:siteId", publicSite, getSession);
- fastify.get("/events/:siteId", publicSite, getEvents);
- fastify.get("/users/:siteId", publicSite, getUsers);
- fastify.get("/users/session-count/:siteId", publicSite, getUserSessionCount);
- fastify.get("/users/:userId/:siteId", publicSite, getUserInfo);
- fastify.get("/session-locations/:siteId", publicSite, getSessionLocations);
- fastify.get("/funnels/:siteId", publicSite, getFunnels);
- fastify.get("/journeys/:siteId", publicSite, getJourneys);
- fastify.post("/funnels/analyze/:siteId", publicSite, getFunnel);
- fastify.post("/funnels/:stepNumber/sessions/:siteId", publicSite, getFunnelStepSessions);
- fastify.post("/funnels/:siteId", authSite, createFunnel);
- fastify.delete("/funnels/:funnelId/:siteId", authSite, deleteFunnel);
- fastify.get("/goals/:siteId", publicSite, getGoals);
- fastify.get("/goals/:goalId/sessions/:siteId", publicSite, getGoalSessions);
- fastify.post("/goals/:siteId", authSite, createGoal);
- fastify.delete("/goals/:goalId/:siteId", authSite, deleteGoal);
- fastify.put("/goals/:goalId/:siteId", authSite, updateGoal);
- fastify.get("/events/names/:siteId", publicSite, getEventNames);
- fastify.get("/events/properties/:siteId", publicSite, getEventProperties);
- fastify.get("/events/outbound/:siteId", publicSite, getOutboundLinks);
+ fastify.get("/sites/:siteId/live-user-count", { logLevel: "silent", ...publicSite }, getLiveUsercount);
+ fastify.get("/sites/:siteId/overview", publicSite, getOverview);
+ fastify.get("/sites/:siteId/overview-bucketed", publicSite, getOverviewBucketed);
+ fastify.get("/sites/:siteId/metric", publicSite, getMetric);
+ fastify.get("/sites/:siteId/page-titles", publicSite, getPageTitles);
+ fastify.get("/sites/:siteId/error-names", publicSite, getErrorNames);
+ fastify.get("/sites/:siteId/error-events", publicSite, getErrorEvents);
+ fastify.get("/sites/:siteId/error-bucketed", publicSite, getErrorBucketed);
+ fastify.get("/sites/:siteId/retention", publicSite, getRetention);
+ fastify.get("/sites/:siteId/has-data", publicSite, getSiteHasData);
+ fastify.get("/sites/:siteId/is-public", publicSite, getSiteIsPublic);
+ fastify.get("/sites/:siteId/sessions", publicSite, getSessions);
+ fastify.get("/sites/:siteId/sessions/:sessionId", publicSite, getSession);
+ fastify.get("/sites/:siteId/events", publicSite, getEvents);
+ fastify.get("/sites/:siteId/users", publicSite, getUsers);
+ fastify.get("/sites/:siteId/users/session-count", publicSite, getUserSessionCount);
+ fastify.get("/sites/:siteId/users/:userId", publicSite, getUserInfo);
+ fastify.get("/sites/:siteId/session-locations", publicSite, getSessionLocations);
+ fastify.get("/sites/:siteId/funnels", publicSite, getFunnels);
+ fastify.get("/sites/:siteId/journeys", publicSite, getJourneys);
+ fastify.post("/sites/:siteId/funnels/analyze", publicSite, getFunnel);
+ fastify.post("/sites/:siteId/funnels/:stepNumber/sessions", publicSite, getFunnelStepSessions);
+ fastify.post("/sites/:siteId/funnels", authSite, createFunnel);
+ fastify.delete("/sites/:siteId/funnels/:funnelId", authSite, deleteFunnel);
+ fastify.get("/sites/:siteId/goals", publicSite, getGoals);
+ fastify.get("/sites/:siteId/goals/:goalId/sessions", publicSite, getGoalSessions);
+ fastify.post("/sites/:siteId/goals", authSite, createGoal);
+ fastify.delete("/sites/:siteId/goals/:goalId", authSite, deleteGoal);
+ fastify.put("/sites/:siteId/goals/:goalId", authSite, updateGoal);
+ fastify.get("/sites/:siteId/events/names", publicSite, getEventNames);
+ fastify.get("/sites/:siteId/events/properties", publicSite, getEventProperties);
+ fastify.get("/sites/:siteId/events/outbound", publicSite, getOutboundLinks);
fastify.get("/org-event-count/:organizationId", orgMember, getOrgEventCount);
// Performance Analytics
- fastify.get("/performance/overview/:siteId", publicSite, getPerformanceOverview);
- fastify.get("/performance/time-series/:siteId", publicSite, getPerformanceTimeSeries);
- fastify.get("/performance/by-dimension/:siteId", publicSite, getPerformanceByDimension);
+ fastify.get("/sites/:siteId/performance/overview", publicSite, getPerformanceOverview);
+ fastify.get("/sites/:siteId/performance/time-series", publicSite, getPerformanceTimeSeries);
+ fastify.get("/sites/:siteId/performance/by-dimension", publicSite, getPerformanceByDimension);
}
async function sessionReplayRoutes(fastify: FastifyInstance) {
// Session Replay
- fastify.post("/session-replay/record/:siteId", recordSessionReplay); // Public - tracking endpoint
- fastify.get("/session-replay/list/:siteId", publicSite, getSessionReplays);
- fastify.get("/session-replay/:sessionId/:siteId", publicSite, getSessionReplayEvents);
- fastify.delete("/session-replay/:sessionId/:siteId", authSite, deleteSessionReplay);
+ fastify.post("/sites/:siteId/session-replay/record", recordSessionReplay); // Public - tracking endpoint
+ fastify.get("/sites/:siteId/session-replay/list", publicSite, getSessionReplays);
+ fastify.get("/sites/:siteId/session-replay/:sessionId", publicSite, getSessionReplayEvents);
+ fastify.delete("/sites/:siteId/session-replay/:sessionId", authSite, deleteSessionReplay);
}
async function sitesRoutes(fastify: FastifyInstance) {
@@ -331,12 +330,12 @@ async function userRoutes(fastify: FastifyInstance) {
async function gscRoutes(fastify: FastifyInstance) {
// GOOGLE SEARCH CONSOLE
- fastify.get("/gsc/connect/:siteId", authSite, connectGSC);
+ fastify.get("/sites/:siteId/gsc/connect", authSite, connectGSC);
fastify.get("/gsc/callback", gscCallback); // Public - OAuth callback
- fastify.get("/gsc/status/:siteId", publicSite, getGSCStatus);
- fastify.delete("/gsc/disconnect/:siteId", authSite, disconnectGSC);
- fastify.post("/gsc/select-property/:siteId", authSite, selectGSCProperty);
- fastify.get("/gsc/data/:siteId", publicSite, getGSCData);
+ fastify.get("/sites/:siteId/gsc/status", publicSite, getGSCStatus);
+ fastify.delete("/sites/:siteId/gsc/disconnect", authSite, disconnectGSC);
+ fastify.post("/sites/:siteId/gsc/select-property", authSite, selectGSCProperty);
+ fastify.get("/sites/:siteId/gsc/data", publicSite, getGSCData);
}
async function stripeAdminRoutes(fastify: FastifyInstance) {