@keystrokehq/plausible_analytics 0.1.0 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/action.cjs.map +1 -1
- package/dist/action.mjs.map +1 -1
- package/dist/actions/check-health.cjs.map +1 -1
- package/dist/actions/check-health.d.cts +6 -3
- package/dist/actions/check-health.d.cts.map +1 -1
- package/dist/actions/check-health.d.mts +6 -3
- package/dist/actions/check-health.d.mts.map +1 -1
- package/dist/actions/check-health.mjs.map +1 -1
- package/dist/actions/get-breakdown-stats.cjs.map +1 -1
- package/dist/actions/get-breakdown-stats.d.cts +52 -3
- package/dist/actions/get-breakdown-stats.d.cts.map +1 -1
- package/dist/actions/get-breakdown-stats.d.mts +52 -3
- package/dist/actions/get-breakdown-stats.d.mts.map +1 -1
- package/dist/actions/get-breakdown-stats.mjs.map +1 -1
- package/dist/actions/get-plugin-capabilities.cjs +11 -11
- package/dist/actions/get-plugin-capabilities.cjs.map +1 -1
- package/dist/actions/get-plugin-capabilities.d.cts +19 -3
- package/dist/actions/get-plugin-capabilities.d.cts.map +1 -1
- package/dist/actions/get-plugin-capabilities.d.mts +19 -3
- package/dist/actions/get-plugin-capabilities.d.mts.map +1 -1
- package/dist/actions/get-plugin-capabilities.mjs +11 -11
- package/dist/actions/get-plugin-capabilities.mjs.map +1 -1
- package/dist/actions/get-realtime-visitors.cjs +1 -1
- package/dist/actions/get-realtime-visitors.cjs.map +1 -1
- package/dist/actions/get-realtime-visitors.d.cts +9 -3
- package/dist/actions/get-realtime-visitors.d.cts.map +1 -1
- package/dist/actions/get-realtime-visitors.d.mts +9 -3
- package/dist/actions/get-realtime-visitors.d.mts.map +1 -1
- package/dist/actions/get-realtime-visitors.mjs +1 -1
- package/dist/actions/get-realtime-visitors.mjs.map +1 -1
- package/dist/actions/get-site.cjs +11 -11
- package/dist/actions/get-site.cjs.map +1 -1
- package/dist/actions/get-site.d.cts +23 -3
- package/dist/actions/get-site.d.cts.map +1 -1
- package/dist/actions/get-site.d.mts +23 -3
- package/dist/actions/get-site.d.mts.map +1 -1
- package/dist/actions/get-site.mjs +11 -11
- package/dist/actions/get-site.mjs.map +1 -1
- package/dist/actions/get-timeseries-stats.cjs +1 -1
- package/dist/actions/get-timeseries-stats.cjs.map +1 -1
- package/dist/actions/get-timeseries-stats.d.cts +32 -3
- package/dist/actions/get-timeseries-stats.d.cts.map +1 -1
- package/dist/actions/get-timeseries-stats.d.mts +32 -3
- package/dist/actions/get-timeseries-stats.d.mts.map +1 -1
- package/dist/actions/get-timeseries-stats.mjs +1 -1
- package/dist/actions/get-timeseries-stats.mjs.map +1 -1
- package/dist/actions/list-custom-props.cjs +1 -1
- package/dist/actions/list-custom-props.cjs.map +1 -1
- package/dist/actions/list-custom-props.d.cts +11 -3
- package/dist/actions/list-custom-props.d.cts.map +1 -1
- package/dist/actions/list-custom-props.d.mts +11 -3
- package/dist/actions/list-custom-props.d.mts.map +1 -1
- package/dist/actions/list-custom-props.mjs +1 -1
- package/dist/actions/list-custom-props.mjs.map +1 -1
- package/dist/actions/list-goals.cjs.map +1 -1
- package/dist/actions/list-goals.d.cts +27 -3
- package/dist/actions/list-goals.d.cts.map +1 -1
- package/dist/actions/list-goals.d.mts +27 -3
- package/dist/actions/list-goals.d.mts.map +1 -1
- package/dist/actions/list-goals.mjs.map +1 -1
- package/dist/actions/list-guests.cjs +3 -3
- package/dist/actions/list-guests.cjs.map +1 -1
- package/dist/actions/list-guests.d.cts +13 -3
- package/dist/actions/list-guests.d.cts.map +1 -1
- package/dist/actions/list-guests.d.mts +13 -3
- package/dist/actions/list-guests.d.mts.map +1 -1
- package/dist/actions/list-guests.mjs +3 -3
- package/dist/actions/list-guests.mjs.map +1 -1
- package/dist/actions/list-sites.cjs +3 -3
- package/dist/actions/list-sites.cjs.map +1 -1
- package/dist/actions/list-sites.d.cts +23 -3
- package/dist/actions/list-sites.d.cts.map +1 -1
- package/dist/actions/list-sites.d.mts +23 -3
- package/dist/actions/list-sites.d.mts.map +1 -1
- package/dist/actions/list-sites.mjs +3 -3
- package/dist/actions/list-sites.mjs.map +1 -1
- package/dist/actions/list-teams.cjs.map +1 -1
- package/dist/actions/list-teams.d.cts +22 -3
- package/dist/actions/list-teams.d.cts.map +1 -1
- package/dist/actions/list-teams.d.mts +22 -3
- package/dist/actions/list-teams.d.mts.map +1 -1
- package/dist/actions/list-teams.mjs.map +1 -1
- package/dist/actions/query-stats.cjs.map +1 -1
- package/dist/actions/query-stats.d.cts +23 -3
- package/dist/actions/query-stats.d.cts.map +1 -1
- package/dist/actions/query-stats.d.mts +23 -3
- package/dist/actions/query-stats.d.mts.map +1 -1
- package/dist/actions/query-stats.mjs.map +1 -1
- package/dist/actions/record-event.cjs +2 -2
- package/dist/actions/record-event.cjs.map +1 -1
- package/dist/actions/record-event.d.cts +32 -3
- package/dist/actions/record-event.d.cts.map +1 -1
- package/dist/actions/record-event.d.mts +32 -3
- package/dist/actions/record-event.d.mts.map +1 -1
- package/dist/actions/record-event.mjs +2 -2
- package/dist/actions/record-event.mjs.map +1 -1
- package/dist/catalog.cjs +14 -1
- package/dist/catalog.cjs.map +1 -1
- package/dist/catalog.d.cts +13 -0
- package/dist/catalog.d.mts +13 -0
- package/dist/catalog.mjs +14 -1
- package/dist/catalog.mjs.map +1 -1
- package/package.json +2 -2
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"query-stats.mjs","names":[],"sources":["../../src/actions/query-stats.ts"],"sourcesContent":["import { z } from \"zod\";\n\nimport { action } from \"../action\";\n\nexport const PlausibleAnalyticsQueryStatsInput
|
|
1
|
+
{"version":3,"file":"query-stats.mjs","names":[],"sources":["../../src/actions/query-stats.ts"],"sourcesContent":["import { z } from \"zod\";\n\nimport { action } from \"../action\";\n\nexport const PlausibleAnalyticsQueryStatsInput = z.object({\n filters: z.array(z.array(z.union([z.string(), z.array(z.string())]))).describe(\"Array of filter conditions to apply to the query. Each filter is an array with format: [dimension, operator, value]. Operators: 'is', 'is_not', 'contains', 'does_not_contain'. Example: [['event:page', 'is', '/blog'], ['visit:country', 'is', 'US']].\").optional(),\n metrics: z.array(z.string()).describe(\"List of metrics to calculate. Available metrics: 'visitors' (unique visitors), 'visits' (total visits), 'pageviews' (total page views), 'views_per_visit' (average pages per visit), 'bounce_rate' (percentage of single-page visits), 'visit_duration' (average visit duration in seconds), 'events' (total events), 'scroll_depth' (average scroll depth percentage), 'percentage' (percentage of total), 'conversion_rate', 'group_conversion_rate', 'average_revenue', 'total_revenue', 'time_on_page' (average time on page in seconds).\"),\n site_id: z.string().describe(\"Domain of your site on Plausible to be queried (e.g., 'example.com', 'composio').\"),\n date_range: z.union([z.string(), z.array(z.string())]),\n dimensions: z.array(z.string()).describe(\"List of dimensions to group results by. Common dimensions: 'event:goal' (goal names), 'event:page' (page paths), 'event:hostname' (hostnames), 'visit:source' (traffic sources), 'visit:referrer' (referrer URLs), 'visit:utm_medium', 'visit:utm_source', 'visit:utm_campaign', 'visit:device' (device types), 'visit:browser', 'visit:os' (operating systems), 'visit:country', 'visit:region', 'visit:city'.\").optional(),\n}).describe(\"Request model for querying analytics stats for a site using the Stats API v2.\");\nconst PlausibleAnalyticsQueryStats_QueryStatsResponseMetaSchema = z.object({\n warnings: z.array(z.string()).describe(\"List of warnings related to the query execution.\").nullable().optional(),\n}).describe(\"Metadata about the query including warnings.\");\nconst PlausibleAnalyticsQueryStats_QueryStatsResponseResultSchema = z.object({\n metrics: z.array(z.union([z.number().int(), z.number()])).describe(\"Values for the metrics specified in the query (order matches the metrics array).\"),\n dimensions: z.array(z.union([z.string(), z.number().int(), z.number()])).describe(\"Values for the dimensions specified in the query (order matches the dimensions array).\").nullable().optional(),\n}).describe(\"Individual result object with metrics and dimension values.\");\nexport const PlausibleAnalyticsQueryStatsOutput = z.object({\n meta: PlausibleAnalyticsQueryStats_QueryStatsResponseMetaSchema.nullable().optional(),\n results: z.array(PlausibleAnalyticsQueryStats_QueryStatsResponseResultSchema).describe(\"Array of result objects with metrics and dimension values.\"),\n}).describe(\"Response containing query results and metadata.\");\n\nexport const plausibleAnalyticsQueryStats = action(\"PLAUSIBLE_ANALYTICS_QUERY_STATS\", {\n slug: \"plausible_analytics-query-stats\",\n name: \"Query Analytics Stats\",\n description: \"Tool to query analytics stats for a site using the Stats API v2. Use when you need to retrieve historical or real-time statistics such as visitors, pageviews, bounce rate, visit duration, and more. Supports filtering, grouping by dimensions, and custom date ranges.\",\n input: PlausibleAnalyticsQueryStatsInput,\n output: PlausibleAnalyticsQueryStatsOutput,\n});\n"],"mappings":";;;AAIA,MAAa,oCAAoC,EAAE,OAAO;CACxD,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,0PAA0P,CAAC,CAAC,SAAS;CACpV,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,+gBAA+gB;CACrjB,SAAS,EAAE,OAAO,CAAC,CAAC,SAAS,mFAAmF;CAChH,YAAY,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CACrD,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,iZAAiZ,CAAC,CAAC,SAAS;AACvc,CAAC,CAAC,CAAC,SAAS,+EAA+E;AAC3F,MAAM,4DAA4D,EAAE,OAAO,EACzE,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC,SAAS,kDAAkD,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS,EACjH,CAAC,CAAC,CAAC,SAAS,8CAA8C;AAC1D,MAAM,8DAA8D,EAAE,OAAO;CAC3E,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,IAAI,GAAG,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,kFAAkF;CACrJ,YAAY,EAAE,MAAM,EAAE,MAAM;EAAC,EAAE,OAAO;EAAG,EAAE,OAAO,CAAC,CAAC,IAAI;EAAG,EAAE,OAAO;CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,wFAAwF,CAAC,CAAC,SAAS,CAAC,CAAC,SAAS;AAClM,CAAC,CAAC,CAAC,SAAS,6DAA6D;AAMzE,MAAa,+BAA+B,OAAO,mCAAmC;CACpF,MAAM;CACN,MAAM;CACN,aAAa;CACb,OAAO;CACP,QAVgD,EAAE,OAAO;EACzD,MAAM,0DAA0D,SAAS,CAAC,CAAC,SAAS;EACpF,SAAS,EAAE,MAAM,2DAA2D,CAAC,CAAC,SAAS,4DAA4D;CACrJ,CAAC,CAAC,CAAC,SAAS,iDAOF;AACV,CAAC"}
|
|
@@ -16,8 +16,8 @@ const PlausibleAnalyticsRecordEventInput = zod.z.object({
|
|
|
16
16
|
x_forwarded_for: zod.z.string().describe("IP address of the client for unique visitor counting and location data (e.g., '203.0.113.195'). If not provided, the server's IP will be used.").optional()
|
|
17
17
|
}).describe("Request model for recording a pageview or custom event.");
|
|
18
18
|
const PlausibleAnalyticsRecordEventOutput = zod.z.object({
|
|
19
|
-
message: zod.z.string().describe("Success or error message from the API."),
|
|
20
|
-
success: zod.z.boolean().describe("Whether the event was successfully recorded.")
|
|
19
|
+
message: zod.z.string().describe("Success or error message from the API.").nullable(),
|
|
20
|
+
success: zod.z.boolean().describe("Whether the event was successfully recorded.").nullable()
|
|
21
21
|
}).describe("Response model for record event action.");
|
|
22
22
|
const plausibleAnalyticsRecordEvent = require_action.action("PLAUSIBLE_ANALYTICS_RECORD_EVENT", {
|
|
23
23
|
slug: "plausible_analytics-record-event",
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"record-event.cjs","names":["z","action"],"sources":["../../src/actions/record-event.ts"],"sourcesContent":["import { z } from \"zod\";\n\nimport { action } from \"../action\";\n\nexport const PlausibleAnalyticsRecordEventInput
|
|
1
|
+
{"version":3,"file":"record-event.cjs","names":["z","action"],"sources":["../../src/actions/record-event.ts"],"sourcesContent":["import { z } from \"zod\";\n\nimport { action } from \"../action\";\n\nexport const PlausibleAnalyticsRecordEventInput = z.object({\n url: z.string().describe(\"URL of the page where the event was triggered. UTM parameters will be automatically extracted (e.g., 'https://example.com/page?utm_source=google').\"),\n name: z.string().describe(\"Name of the event. Use 'pageview' for page views, other names become custom events (e.g., 'signup', 'purchase', 'button_click').\"),\n props: z.object({}).describe(\"Custom properties for the event as key-value pairs (max 30 properties). Values can be strings, numbers, or booleans.\").optional(),\n domain: z.string().describe(\"Domain name of the site in Plausible (e.g., 'example.com').\"),\n revenue: z.object({\n amount: z.string().describe(\"Revenue amount as a string (e.g., '10.50', '99.99').\"),\n currency: z.string().describe(\"ISO 4217 currency code (e.g., USD, EUR, GBP).\"),\n}).describe(\"Revenue data for the event.\").optional(),\n referrer: z.string().describe(\"Referrer URL for this event (e.g., 'https://google.com/search').\").optional(),\n user_agent: z.string().describe(\"Raw User-Agent string for unique visitor identification and device detection. Should be the actual user agent from the client's browser or app.\"),\n interactive: z.boolean().describe(\"Whether the event counts towards bounce rate. Default is true. Set to false for non-interactive events like automatic tracking.\").optional(),\n x_forwarded_for: z.string().describe(\"IP address of the client for unique visitor counting and location data (e.g., '203.0.113.195'). If not provided, the server's IP will be used.\").optional(),\n}).describe(\"Request model for recording a pageview or custom event.\");\nexport const PlausibleAnalyticsRecordEventOutput = z.object({\n message: z.string().describe(\"Success or error message from the API.\").nullable(),\n success: z.boolean().describe(\"Whether the event was successfully recorded.\").nullable(),\n}).describe(\"Response model for record event action.\");\n\nexport const plausibleAnalyticsRecordEvent = action(\"PLAUSIBLE_ANALYTICS_RECORD_EVENT\", {\n slug: \"plausible_analytics-record-event\",\n name: \"Record Event\",\n description: \"Tool to record a pageview or custom event via the Plausible Events API. Use when tracking Android/iOS mobile apps or server-side tracking. Requires proper User-Agent and optionally X-Forwarded-For headers for unique visitor counting.\",\n input: PlausibleAnalyticsRecordEventInput,\n output: PlausibleAnalyticsRecordEventOutput,\n});\n"],"mappings":";;;AAIA,MAAa,qCAAqCA,IAAAA,EAAE,OAAO;CACzD,KAAKA,IAAAA,EAAE,OAAO,CAAC,CAAC,SAAS,qJAAqJ;CAC9K,MAAMA,IAAAA,EAAE,OAAO,CAAC,CAAC,SAAS,kIAAkI;CAC5J,OAAOA,IAAAA,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,sHAAsH,CAAC,CAAC,SAAS;CAC9J,QAAQA,IAAAA,EAAE,OAAO,CAAC,CAAC,SAAS,6DAA6D;CACzF,SAASA,IAAAA,EAAE,OAAO;EAClB,QAAQA,IAAAA,EAAE,OAAO,CAAC,CAAC,SAAS,sDAAsD;EAClF,UAAUA,IAAAA,EAAE,OAAO,CAAC,CAAC,SAAS,+CAA+C;CAC/E,CAAC,CAAC,CAAC,SAAS,6BAA6B,CAAC,CAAC,SAAS;CAClD,UAAUA,IAAAA,EAAE,OAAO,CAAC,CAAC,SAAS,kEAAkE,CAAC,CAAC,SAAS;CAC3G,YAAYA,IAAAA,EAAE,OAAO,CAAC,CAAC,SAAS,iJAAiJ;CACjL,aAAaA,IAAAA,EAAE,QAAQ,CAAC,CAAC,SAAS,iIAAiI,CAAC,CAAC,SAAS;CAC9K,iBAAiBA,IAAAA,EAAE,OAAO,CAAC,CAAC,SAAS,gJAAgJ,CAAC,CAAC,SAAS;AAClM,CAAC,CAAC,CAAC,SAAS,yDAAyD;AACrE,MAAa,sCAAsCA,IAAAA,EAAE,OAAO;CAC1D,SAASA,IAAAA,EAAE,OAAO,CAAC,CAAC,SAAS,wCAAwC,CAAC,CAAC,SAAS;CAChF,SAASA,IAAAA,EAAE,QAAQ,CAAC,CAAC,SAAS,8CAA8C,CAAC,CAAC,SAAS;AACzF,CAAC,CAAC,CAAC,SAAS,yCAAyC;AAErD,MAAa,gCAAgCC,eAAAA,OAAO,oCAAoC;CACtF,MAAM;CACN,MAAM;CACN,aAAa;CACb,OAAO;CACP,QAAQ;AACV,CAAC"}
|
|
@@ -1,9 +1,38 @@
|
|
|
1
1
|
import { z } from "zod";
|
|
2
2
|
|
|
3
3
|
//#region src/actions/record-event.d.ts
|
|
4
|
-
declare const PlausibleAnalyticsRecordEventInput: z.
|
|
5
|
-
|
|
6
|
-
|
|
4
|
+
declare const PlausibleAnalyticsRecordEventInput: z.ZodObject<{
|
|
5
|
+
url: z.ZodString;
|
|
6
|
+
name: z.ZodString;
|
|
7
|
+
props: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
|
|
8
|
+
domain: z.ZodString;
|
|
9
|
+
revenue: z.ZodOptional<z.ZodObject<{
|
|
10
|
+
amount: z.ZodString;
|
|
11
|
+
currency: z.ZodString;
|
|
12
|
+
}, z.core.$strip>>;
|
|
13
|
+
referrer: z.ZodOptional<z.ZodString>;
|
|
14
|
+
user_agent: z.ZodString;
|
|
15
|
+
interactive: z.ZodOptional<z.ZodBoolean>;
|
|
16
|
+
x_forwarded_for: z.ZodOptional<z.ZodString>;
|
|
17
|
+
}, z.core.$strip>;
|
|
18
|
+
declare const PlausibleAnalyticsRecordEventOutput: z.ZodObject<{
|
|
19
|
+
message: z.ZodNullable<z.ZodString>;
|
|
20
|
+
success: z.ZodNullable<z.ZodBoolean>;
|
|
21
|
+
}, z.core.$strip>;
|
|
22
|
+
declare const plausibleAnalyticsRecordEvent: import("@keystrokehq/action").WorkflowActionDefinition<{
|
|
23
|
+
url: string;
|
|
24
|
+
name: string;
|
|
25
|
+
domain: string;
|
|
26
|
+
user_agent: string;
|
|
27
|
+
props?: Record<string, never> | undefined;
|
|
28
|
+
revenue?: {
|
|
29
|
+
amount: string;
|
|
30
|
+
currency: string;
|
|
31
|
+
} | undefined;
|
|
32
|
+
referrer?: string | undefined;
|
|
33
|
+
interactive?: boolean | undefined;
|
|
34
|
+
x_forwarded_for?: string | undefined;
|
|
35
|
+
}, unknown, import("@keystrokehq/shared").ResolvedCredentials<readonly [import("@keystrokehq/shared").Credential]>, readonly [import("@keystrokehq/shared").Credential]>;
|
|
7
36
|
//#endregion
|
|
8
37
|
export { plausibleAnalyticsRecordEvent };
|
|
9
38
|
//# sourceMappingURL=record-event.d.cts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"record-event.d.cts","names":[],"sources":["../../src/actions/record-event.ts"],"mappings":";;;cAIa,kCAAA,
|
|
1
|
+
{"version":3,"file":"record-event.d.cts","names":[],"sources":["../../src/actions/record-event.ts"],"mappings":";;;cAIa,kCAAA,EAAkC,CAAA,CAAA,SAAA;;;;;;;;;;;;;;cAclC,mCAAA,EAAmC,CAAA,CAAA,SAAA;;;;cAKnC,6BAAA,gCAA6B,wBAAA;;;;;UAMxC,MAAA"}
|
|
@@ -1,9 +1,38 @@
|
|
|
1
1
|
import { z } from "zod";
|
|
2
2
|
|
|
3
3
|
//#region src/actions/record-event.d.ts
|
|
4
|
-
declare const PlausibleAnalyticsRecordEventInput: z.
|
|
5
|
-
|
|
6
|
-
|
|
4
|
+
declare const PlausibleAnalyticsRecordEventInput: z.ZodObject<{
|
|
5
|
+
url: z.ZodString;
|
|
6
|
+
name: z.ZodString;
|
|
7
|
+
props: z.ZodOptional<z.ZodObject<{}, z.core.$strip>>;
|
|
8
|
+
domain: z.ZodString;
|
|
9
|
+
revenue: z.ZodOptional<z.ZodObject<{
|
|
10
|
+
amount: z.ZodString;
|
|
11
|
+
currency: z.ZodString;
|
|
12
|
+
}, z.core.$strip>>;
|
|
13
|
+
referrer: z.ZodOptional<z.ZodString>;
|
|
14
|
+
user_agent: z.ZodString;
|
|
15
|
+
interactive: z.ZodOptional<z.ZodBoolean>;
|
|
16
|
+
x_forwarded_for: z.ZodOptional<z.ZodString>;
|
|
17
|
+
}, z.core.$strip>;
|
|
18
|
+
declare const PlausibleAnalyticsRecordEventOutput: z.ZodObject<{
|
|
19
|
+
message: z.ZodNullable<z.ZodString>;
|
|
20
|
+
success: z.ZodNullable<z.ZodBoolean>;
|
|
21
|
+
}, z.core.$strip>;
|
|
22
|
+
declare const plausibleAnalyticsRecordEvent: import("@keystrokehq/action").WorkflowActionDefinition<{
|
|
23
|
+
url: string;
|
|
24
|
+
name: string;
|
|
25
|
+
domain: string;
|
|
26
|
+
user_agent: string;
|
|
27
|
+
props?: Record<string, never> | undefined;
|
|
28
|
+
revenue?: {
|
|
29
|
+
amount: string;
|
|
30
|
+
currency: string;
|
|
31
|
+
} | undefined;
|
|
32
|
+
referrer?: string | undefined;
|
|
33
|
+
interactive?: boolean | undefined;
|
|
34
|
+
x_forwarded_for?: string | undefined;
|
|
35
|
+
}, unknown, import("@keystrokehq/shared").ResolvedCredentials<readonly [import("@keystrokehq/shared").Credential]>, readonly [import("@keystrokehq/shared").Credential]>;
|
|
7
36
|
//#endregion
|
|
8
37
|
export { plausibleAnalyticsRecordEvent };
|
|
9
38
|
//# sourceMappingURL=record-event.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"record-event.d.mts","names":[],"sources":["../../src/actions/record-event.ts"],"mappings":";;;cAIa,kCAAA,
|
|
1
|
+
{"version":3,"file":"record-event.d.mts","names":[],"sources":["../../src/actions/record-event.ts"],"mappings":";;;cAIa,kCAAA,EAAkC,CAAA,CAAA,SAAA;;;;;;;;;;;;;;cAclC,mCAAA,EAAmC,CAAA,CAAA,SAAA;;;;cAKnC,6BAAA,gCAA6B,wBAAA;;;;;UAMxC,MAAA"}
|
|
@@ -19,8 +19,8 @@ const plausibleAnalyticsRecordEvent = action("PLAUSIBLE_ANALYTICS_RECORD_EVENT",
|
|
|
19
19
|
x_forwarded_for: z.string().describe("IP address of the client for unique visitor counting and location data (e.g., '203.0.113.195'). If not provided, the server's IP will be used.").optional()
|
|
20
20
|
}).describe("Request model for recording a pageview or custom event."),
|
|
21
21
|
output: z.object({
|
|
22
|
-
message: z.string().describe("Success or error message from the API."),
|
|
23
|
-
success: z.boolean().describe("Whether the event was successfully recorded.")
|
|
22
|
+
message: z.string().describe("Success or error message from the API.").nullable(),
|
|
23
|
+
success: z.boolean().describe("Whether the event was successfully recorded.").nullable()
|
|
24
24
|
}).describe("Response model for record event action.")
|
|
25
25
|
});
|
|
26
26
|
//#endregion
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"record-event.mjs","names":[],"sources":["../../src/actions/record-event.ts"],"sourcesContent":["import { z } from \"zod\";\n\nimport { action } from \"../action\";\n\nexport const PlausibleAnalyticsRecordEventInput
|
|
1
|
+
{"version":3,"file":"record-event.mjs","names":[],"sources":["../../src/actions/record-event.ts"],"sourcesContent":["import { z } from \"zod\";\n\nimport { action } from \"../action\";\n\nexport const PlausibleAnalyticsRecordEventInput = z.object({\n url: z.string().describe(\"URL of the page where the event was triggered. UTM parameters will be automatically extracted (e.g., 'https://example.com/page?utm_source=google').\"),\n name: z.string().describe(\"Name of the event. Use 'pageview' for page views, other names become custom events (e.g., 'signup', 'purchase', 'button_click').\"),\n props: z.object({}).describe(\"Custom properties for the event as key-value pairs (max 30 properties). Values can be strings, numbers, or booleans.\").optional(),\n domain: z.string().describe(\"Domain name of the site in Plausible (e.g., 'example.com').\"),\n revenue: z.object({\n amount: z.string().describe(\"Revenue amount as a string (e.g., '10.50', '99.99').\"),\n currency: z.string().describe(\"ISO 4217 currency code (e.g., USD, EUR, GBP).\"),\n}).describe(\"Revenue data for the event.\").optional(),\n referrer: z.string().describe(\"Referrer URL for this event (e.g., 'https://google.com/search').\").optional(),\n user_agent: z.string().describe(\"Raw User-Agent string for unique visitor identification and device detection. Should be the actual user agent from the client's browser or app.\"),\n interactive: z.boolean().describe(\"Whether the event counts towards bounce rate. Default is true. Set to false for non-interactive events like automatic tracking.\").optional(),\n x_forwarded_for: z.string().describe(\"IP address of the client for unique visitor counting and location data (e.g., '203.0.113.195'). If not provided, the server's IP will be used.\").optional(),\n}).describe(\"Request model for recording a pageview or custom event.\");\nexport const PlausibleAnalyticsRecordEventOutput = z.object({\n message: z.string().describe(\"Success or error message from the API.\").nullable(),\n success: z.boolean().describe(\"Whether the event was successfully recorded.\").nullable(),\n}).describe(\"Response model for record event action.\");\n\nexport const plausibleAnalyticsRecordEvent = action(\"PLAUSIBLE_ANALYTICS_RECORD_EVENT\", {\n slug: \"plausible_analytics-record-event\",\n name: \"Record Event\",\n description: \"Tool to record a pageview or custom event via the Plausible Events API. Use when tracking Android/iOS mobile apps or server-side tracking. Requires proper User-Agent and optionally X-Forwarded-For headers for unique visitor counting.\",\n input: PlausibleAnalyticsRecordEventInput,\n output: PlausibleAnalyticsRecordEventOutput,\n});\n"],"mappings":";;AAuBA,MAAa,gCAAgC,OAAO,oCAAoC;CACtF,MAAM;CACN,MAAM;CACN,aAAa;CACb,OAvBgD,EAAE,OAAO;EACzD,KAAK,EAAE,OAAO,CAAC,CAAC,SAAS,qJAAqJ;EAC9K,MAAM,EAAE,OAAO,CAAC,CAAC,SAAS,kIAAkI;EAC5J,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,sHAAsH,CAAC,CAAC,SAAS;EAC9J,QAAQ,EAAE,OAAO,CAAC,CAAC,SAAS,6DAA6D;EACzF,SAAS,EAAE,OAAO;GAClB,QAAQ,EAAE,OAAO,CAAC,CAAC,SAAS,sDAAsD;GAClF,UAAU,EAAE,OAAO,CAAC,CAAC,SAAS,+CAA+C;EAC/E,CAAC,CAAC,CAAC,SAAS,6BAA6B,CAAC,CAAC,SAAS;EAClD,UAAU,EAAE,OAAO,CAAC,CAAC,SAAS,kEAAkE,CAAC,CAAC,SAAS;EAC3G,YAAY,EAAE,OAAO,CAAC,CAAC,SAAS,iJAAiJ;EACjL,aAAa,EAAE,QAAQ,CAAC,CAAC,SAAS,iIAAiI,CAAC,CAAC,SAAS;EAC9K,iBAAiB,EAAE,OAAO,CAAC,CAAC,SAAS,gJAAgJ,CAAC,CAAC,SAAS;CAClM,CAAC,CAAC,CAAC,SAAS,yDAUH;CACP,QAViD,EAAE,OAAO;EAC1D,SAAS,EAAE,OAAO,CAAC,CAAC,SAAS,wCAAwC,CAAC,CAAC,SAAS;EAChF,SAAS,EAAE,QAAQ,CAAC,CAAC,SAAS,8CAA8C,CAAC,CAAC,SAAS;CACzF,CAAC,CAAC,CAAC,SAAS,yCAOF;AACV,CAAC"}
|
package/dist/catalog.cjs
CHANGED
|
@@ -7,7 +7,20 @@ const plausibleAnalyticsCatalog = {
|
|
|
7
7
|
"category": "Analytics",
|
|
8
8
|
"logo": "https://logos.composio.dev/api/plausible_analytics",
|
|
9
9
|
"authKind": "keystroke",
|
|
10
|
-
"oauthScopes": []
|
|
10
|
+
"oauthScopes": [],
|
|
11
|
+
"credentialFields": {
|
|
12
|
+
"full": {
|
|
13
|
+
"label": "Instance URL",
|
|
14
|
+
"description": "Your Plausible instance URL (e.g., https://plausible.io for cloud or https://analytics.yourdomain.com for self-hosted)",
|
|
15
|
+
"default": "https://plausible.io"
|
|
16
|
+
},
|
|
17
|
+
"api_key": {
|
|
18
|
+
"label": "API Key",
|
|
19
|
+
"secret": true,
|
|
20
|
+
"description": "Your Plausible Analytics API key. Generate it from your account settings under \"API Keys\" section."
|
|
21
|
+
}
|
|
22
|
+
},
|
|
23
|
+
"credentialScheme": "API_KEY"
|
|
11
24
|
};
|
|
12
25
|
//#endregion
|
|
13
26
|
exports.plausibleAnalyticsCatalog = plausibleAnalyticsCatalog;
|
package/dist/catalog.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"catalog.cjs","names":[],"sources":["../src/catalog.ts"],"sourcesContent":["/** Generated — kept in sync with src/app.ts. */\nexport const plausibleAnalyticsCatalog = {\n \"slug\": \"plausible_analytics\",\n \"name\": \"Plausible Analytics\",\n \"description\": \"Privacy-focused web analytics platform that provides simple, lightweight, and GDPR-compliant website statistics\",\n \"category\": \"Analytics\",\n \"logo\": \"https://logos.composio.dev/api/plausible_analytics\",\n \"authKind\": \"keystroke\",\n \"oauthScopes\": []\n} as const;\n"],"mappings":";;AACA,MAAa,4BAA4B;CACvC,QAAQ;CACR,QAAQ;CACR,eAAe;CACf,YAAY;CACZ,QAAQ;CACR,YAAY;CACZ,eAAe,CAAC;
|
|
1
|
+
{"version":3,"file":"catalog.cjs","names":[],"sources":["../src/catalog.ts"],"sourcesContent":["/** Generated — kept in sync with src/app.ts. */\nexport const plausibleAnalyticsCatalog = {\n \"slug\": \"plausible_analytics\",\n \"name\": \"Plausible Analytics\",\n \"description\": \"Privacy-focused web analytics platform that provides simple, lightweight, and GDPR-compliant website statistics\",\n \"category\": \"Analytics\",\n \"logo\": \"https://logos.composio.dev/api/plausible_analytics\",\n \"authKind\": \"keystroke\",\n \"oauthScopes\": [],\n \"credentialFields\": {\n \"full\": {\n \"label\": \"Instance URL\",\n \"description\": \"Your Plausible instance URL (e.g., https://plausible.io for cloud or https://analytics.yourdomain.com for self-hosted)\",\n \"default\": \"https://plausible.io\"\n },\n \"api_key\": {\n \"label\": \"API Key\",\n \"secret\": true,\n \"description\": \"Your Plausible Analytics API key. Generate it from your account settings under \\\"API Keys\\\" section.\"\n }\n },\n \"credentialScheme\": \"API_KEY\"\n} as const;\n"],"mappings":";;AACA,MAAa,4BAA4B;CACvC,QAAQ;CACR,QAAQ;CACR,eAAe;CACf,YAAY;CACZ,QAAQ;CACR,YAAY;CACZ,eAAe,CAAC;CAChB,oBAAoB;EAClB,QAAQ;GACN,SAAS;GACT,eAAe;GACf,WAAW;EACb;EACA,WAAW;GACT,SAAS;GACT,UAAU;GACV,eAAe;EACjB;CACF;CACA,oBAAoB;AACtB"}
|
package/dist/catalog.d.cts
CHANGED
|
@@ -8,6 +8,19 @@ declare const plausibleAnalyticsCatalog: {
|
|
|
8
8
|
readonly logo: "https://logos.composio.dev/api/plausible_analytics";
|
|
9
9
|
readonly authKind: "keystroke";
|
|
10
10
|
readonly oauthScopes: readonly [];
|
|
11
|
+
readonly credentialFields: {
|
|
12
|
+
readonly full: {
|
|
13
|
+
readonly label: "Instance URL";
|
|
14
|
+
readonly description: "Your Plausible instance URL (e.g., https://plausible.io for cloud or https://analytics.yourdomain.com for self-hosted)";
|
|
15
|
+
readonly default: "https://plausible.io";
|
|
16
|
+
};
|
|
17
|
+
readonly api_key: {
|
|
18
|
+
readonly label: "API Key";
|
|
19
|
+
readonly secret: true;
|
|
20
|
+
readonly description: "Your Plausible Analytics API key. Generate it from your account settings under \"API Keys\" section.";
|
|
21
|
+
};
|
|
22
|
+
};
|
|
23
|
+
readonly credentialScheme: "API_KEY";
|
|
11
24
|
};
|
|
12
25
|
//#endregion
|
|
13
26
|
export { plausibleAnalyticsCatalog };
|
package/dist/catalog.d.mts
CHANGED
|
@@ -8,6 +8,19 @@ declare const plausibleAnalyticsCatalog: {
|
|
|
8
8
|
readonly logo: "https://logos.composio.dev/api/plausible_analytics";
|
|
9
9
|
readonly authKind: "keystroke";
|
|
10
10
|
readonly oauthScopes: readonly [];
|
|
11
|
+
readonly credentialFields: {
|
|
12
|
+
readonly full: {
|
|
13
|
+
readonly label: "Instance URL";
|
|
14
|
+
readonly description: "Your Plausible instance URL (e.g., https://plausible.io for cloud or https://analytics.yourdomain.com for self-hosted)";
|
|
15
|
+
readonly default: "https://plausible.io";
|
|
16
|
+
};
|
|
17
|
+
readonly api_key: {
|
|
18
|
+
readonly label: "API Key";
|
|
19
|
+
readonly secret: true;
|
|
20
|
+
readonly description: "Your Plausible Analytics API key. Generate it from your account settings under \"API Keys\" section.";
|
|
21
|
+
};
|
|
22
|
+
};
|
|
23
|
+
readonly credentialScheme: "API_KEY";
|
|
11
24
|
};
|
|
12
25
|
//#endregion
|
|
13
26
|
export { plausibleAnalyticsCatalog };
|
package/dist/catalog.mjs
CHANGED
|
@@ -7,7 +7,20 @@ const plausibleAnalyticsCatalog = {
|
|
|
7
7
|
"category": "Analytics",
|
|
8
8
|
"logo": "https://logos.composio.dev/api/plausible_analytics",
|
|
9
9
|
"authKind": "keystroke",
|
|
10
|
-
"oauthScopes": []
|
|
10
|
+
"oauthScopes": [],
|
|
11
|
+
"credentialFields": {
|
|
12
|
+
"full": {
|
|
13
|
+
"label": "Instance URL",
|
|
14
|
+
"description": "Your Plausible instance URL (e.g., https://plausible.io for cloud or https://analytics.yourdomain.com for self-hosted)",
|
|
15
|
+
"default": "https://plausible.io"
|
|
16
|
+
},
|
|
17
|
+
"api_key": {
|
|
18
|
+
"label": "API Key",
|
|
19
|
+
"secret": true,
|
|
20
|
+
"description": "Your Plausible Analytics API key. Generate it from your account settings under \"API Keys\" section."
|
|
21
|
+
}
|
|
22
|
+
},
|
|
23
|
+
"credentialScheme": "API_KEY"
|
|
11
24
|
};
|
|
12
25
|
//#endregion
|
|
13
26
|
export { plausibleAnalyticsCatalog };
|
package/dist/catalog.mjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"catalog.mjs","names":[],"sources":["../src/catalog.ts"],"sourcesContent":["/** Generated — kept in sync with src/app.ts. */\nexport const plausibleAnalyticsCatalog = {\n \"slug\": \"plausible_analytics\",\n \"name\": \"Plausible Analytics\",\n \"description\": \"Privacy-focused web analytics platform that provides simple, lightweight, and GDPR-compliant website statistics\",\n \"category\": \"Analytics\",\n \"logo\": \"https://logos.composio.dev/api/plausible_analytics\",\n \"authKind\": \"keystroke\",\n \"oauthScopes\": []\n} as const;\n"],"mappings":";;AACA,MAAa,4BAA4B;CACvC,QAAQ;CACR,QAAQ;CACR,eAAe;CACf,YAAY;CACZ,QAAQ;CACR,YAAY;CACZ,eAAe,CAAC;
|
|
1
|
+
{"version":3,"file":"catalog.mjs","names":[],"sources":["../src/catalog.ts"],"sourcesContent":["/** Generated — kept in sync with src/app.ts. */\nexport const plausibleAnalyticsCatalog = {\n \"slug\": \"plausible_analytics\",\n \"name\": \"Plausible Analytics\",\n \"description\": \"Privacy-focused web analytics platform that provides simple, lightweight, and GDPR-compliant website statistics\",\n \"category\": \"Analytics\",\n \"logo\": \"https://logos.composio.dev/api/plausible_analytics\",\n \"authKind\": \"keystroke\",\n \"oauthScopes\": [],\n \"credentialFields\": {\n \"full\": {\n \"label\": \"Instance URL\",\n \"description\": \"Your Plausible instance URL (e.g., https://plausible.io for cloud or https://analytics.yourdomain.com for self-hosted)\",\n \"default\": \"https://plausible.io\"\n },\n \"api_key\": {\n \"label\": \"API Key\",\n \"secret\": true,\n \"description\": \"Your Plausible Analytics API key. Generate it from your account settings under \\\"API Keys\\\" section.\"\n }\n },\n \"credentialScheme\": \"API_KEY\"\n} as const;\n"],"mappings":";;AACA,MAAa,4BAA4B;CACvC,QAAQ;CACR,QAAQ;CACR,eAAe;CACf,YAAY;CACZ,QAAQ;CACR,YAAY;CACZ,eAAe,CAAC;CAChB,oBAAoB;EAClB,QAAQ;GACN,SAAS;GACT,eAAe;GACf,WAAW;EACb;EACA,WAAW;GACT,SAAS;GACT,UAAU;GACV,eAAe;EACjB;CACF;CACA,oBAAoB;AACtB"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@keystrokehq/plausible_analytics",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public",
|
|
6
6
|
"registry": "https://registry.npmjs.org"
|
|
@@ -31,7 +31,7 @@
|
|
|
31
31
|
}
|
|
32
32
|
},
|
|
33
33
|
"peerDependencies": {
|
|
34
|
-
"@keystrokehq/keystroke": "
|
|
34
|
+
"@keystrokehq/keystroke": ">=0.1.4",
|
|
35
35
|
"zod": "^4.4.3"
|
|
36
36
|
},
|
|
37
37
|
"devDependencies": {
|