Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.
TypeScript analyticsanalytics-dashboardclickhouseelixirgoogle-analyticsmarketingopen-source-analyticsphoenixplausible-analyticspostgresqlprivacyprivacy-friendlyself-hostedsimple-analyticsstatisticstailwindcssweb-analyticswebsite-analyticswebsite-statswebsite-tracking
APIv2: Fix autocomplete in Stats API playground (#5286)
Karl-Aksel Puulmannf8ddecf08088
diff --git a/assets/js/types/query-api.d.ts b/assets/js/types/query-api.d.tsindex e56b773c42..478a78bbcb 100644--- a/assets/js/types/query-api.d.ts+++ b/assets/js/types/query-api.d.ts@@ -71,7 +71,7 @@ export type CustomPropertyFilterDimensions = string;export type GoalDimension = "event:goal";export type TimeDimensions = ("time" | "time:month" | "time:week" | "time:day" | "time:hour") | "time:minute";export type FilterTree = FilterEntry | FilterAndOr | FilterNot | FilterHasDone;-export type FilterEntry = FilterWithoutGoals | FilterWithGoals | FilterWithPattern | FilterForSegment;+export type FilterEntry = FilterWithoutGoals | FilterWithIs | FilterWithContains | FilterWithPattern;/*** @minItems 3* @maxItems 4@@ -95,20 +95,30 @@ export type Clauses = (string | number)[];* @minItems 3* @maxItems 4*/-export type FilterWithGoals =- | [FilterOperationContains, GoalDimension | SimpleFilterDimensions | CustomPropertyFilterDimensions, Clauses]+export type FilterWithIs =+ | ["is", GoalDimension | SimpleFilterDimensions | CustomPropertyFilterDimensions | "segment", Clauses]| [- FilterOperationContains,- GoalDimension | SimpleFilterDimensions | CustomPropertyFilterDimensions,+ "is",+ GoalDimension | SimpleFilterDimensions | CustomPropertyFilterDimensions | "segment",Clauses,{case_sensitive?: boolean;}];/**- * filter operation+ * @minItems 3+ * @maxItems 4*/-export type FilterOperationContains = "is" | "contains";+export type FilterWithContains =+ | ["contains", GoalDimension | SimpleFilterDimensions | CustomPropertyFilterDimensions, Clauses]+ | [+ "contains",+ GoalDimension | SimpleFilterDimensions | CustomPropertyFilterDimensions,+ Clauses,+ {+ case_sensitive?: boolean;+ }+ ];/*** @minItems 3* @maxItems 3@@ -122,11 +132,6 @@ export type FilterWithPattern = [* filter operation*/export type FilterOperationRegex = "matches" | "matches_not";-/**- * @minItems 3- * @maxItems 3- */-export type FilterForSegment = ["is", "segment", number[]];/*** @minItems 2* @maxItems 2diff --git a/priv/json-schemas/query-api-schema.json b/priv/json-schemas/query-api-schema.jsonindex 18b1727c26..bdc36559d6 100644--- a/priv/json-schemas/query-api-schema.json+++ b/priv/json-schemas/query-api-schema.json@@ -367,11 +367,6 @@"enum": ["is_not", "contains_not"],"description": "filter operation"},- "filter_operation_contains": {- "type": "string",- "enum": ["is", "contains"],- "description": "filter operation"- },"filter_with_pattern": {"type": "array","additionalItems": false,@@ -422,20 +417,22 @@}]},- "filter_with_goals": {+ "filter_with_is": {"type": "array","additionalItems": false,"minItems": 3,"maxItems": 4,"items": [{- "$ref": "#/definitions/filter_operation_contains"+ "const": "is",+ "description": "filter operation"},{"oneOf": [{ "$ref": "#/definitions/goal_dimension" },{ "$ref": "#/definitions/simple_filter_dimensions" },- { "$ref": "#/definitions/custom_property_filter_dimensions" }+ { "$ref": "#/definitions/custom_property_filter_dimensions" },+ { "const": "segment" }]},{@@ -453,22 +450,34 @@}]},- "filter_for_segment": {+ "filter_with_contains": {"type": "array","additionalItems": false,"minItems": 3,- "maxItems": 3,+ "maxItems": 4,"items": [{- "const": "is"+ "const": "contains",+ "description": "filter operation"},{- "const": "segment"+ "oneOf": [+ { "$ref": "#/definitions/goal_dimension" },+ { "$ref": "#/definitions/simple_filter_dimensions" },+ { "$ref": "#/definitions/custom_property_filter_dimensions" }+ ]},{- "type": "array",- "items": {- "type": ["integer"]+ "$ref": "#/definitions/clauses"+ },+ {+ "type": "object",+ "additionalProperties": false,+ "properties": {+ "case_sensitive": {+ "type": "boolean",+ "default": true+ }}}]@@ -476,9 +485,9 @@"filter_entry": {"oneOf": [{ "$ref": "#/definitions/filter_without_goals" },- { "$ref": "#/definitions/filter_with_goals" },- { "$ref": "#/definitions/filter_with_pattern" },- { "$ref": "#/definitions/filter_for_segment" }+ { "$ref": "#/definitions/filter_with_is" },+ { "$ref": "#/definitions/filter_with_contains" },+ { "$ref": "#/definitions/filter_with_pattern" }]},"filter_tree": {diff --git a/test/plausible/stats/query_parser_test.exs b/test/plausible/stats/query_parser_test.exsindex 91be00d7fc..a084a6752b 100644--- a/test/plausible/stats/query_parser_test.exs+++ b/test/plausible/stats/query_parser_test.exs@@ -2589,5 +2589,18 @@ defmodule Plausible.Stats.Filters.QueryParserTest do})end++ test "validation fails with string segment ids", %{site: site} do+ %{+ "site_id" => site.domain,+ "metrics" => ["visitors"],+ "date_range" => "all",+ "filters" => [["is", "segment", ["123"]]]+ }+ |> check_error(+ site,+ "Invalid filter '[\"is\", \"segment\", [\"123\"]]'."+ )+ endendend