Skip to content

Open source, privacy-first web analytics. Lightweight, cookie-free Google Analytics alternative. Self-hosted or cloud.

Add goal type to JSON response

Uku Taht66575f497b67
diff --git a/lib/plausible/goal/schema.ex b/lib/plausible/goal/schema.ex
index 0c84b9941a..31986a1847 100644
--- a/lib/plausible/goal/schema.ex
+++ b/lib/plausible/goal/schema.ex
@@ -1,8 +1,22 @@
+defimpl Jason.Encoder, for: Plausible.Goal do
+ def encode(value, opts) do
+ goal_type =
+ cond do
+ value.event_name -> :event
+ value.page_path -> :page
+ end
+
+ value
+ |> Map.put(:goal_type, goal_type)
+ |> Map.take([:id, :domain, :goal_type, :event_name, :page_path])
+ |> Jason.Encode.map(opts)
+ end
+end
+
defmodule Plausible.Goal do
use Ecto.Schema
import Ecto.Changeset
- @derive {Jason.Encoder, only: [:id, :domain, :event_name, :page_path]}
schema "goals" do
field :domain, :string
field :event_name, :string
diff --git a/test/plausible_web/controllers/api/external_sites_controller_test.exs b/test/plausible_web/controllers/api/external_sites_controller_test.exs
index c45982ea3b..0ae9d36d10 100644
--- a/test/plausible_web/controllers/api/external_sites_controller_test.exs
+++ b/test/plausible_web/controllers/api/external_sites_controller_test.exs
@@ -204,6 +204,7 @@ defmodule PlausibleWeb.Api.ExternalSitesControllerTest do
})
res = json_response(conn, 200)
+ assert res["goal_type"] == "event"
assert res["event_name"] == "Signup"
end
@@ -216,6 +217,7 @@ defmodule PlausibleWeb.Api.ExternalSitesControllerTest do
})
res = json_response(conn, 200)
+ assert res["goal_type"] == "page"
assert res["page_path"] == "/signup"
end