Skip to content

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

956 B
Raw Blame
defmodule PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.Revenue do
  @moduledoc """
  OpenAPI schema for Custom Event Goal creation request
  """

  use PlausibleWeb, :open_api_schema

  alias Schemas.Goal.CustomProps

  OpenApiSpex.schema(%{
    title: "Goal.CreateRequest.Revenue",
    description: "Revenue Goal creation params",
    type: :object,
    required: [:goal, :goal_type],
    properties: %{
      goal_type: %Schema{
        type: :string,
        enum: ["Goal.Revenue"],
        default: "Goal.Revenue"
      },
      goal: %Schema{
        type: :object,
        required: [:event_name, :currency],
        properties: %{
          event_name: %Schema{type: :string},
          currency: %Schema{type: :string},
          custom_props: CustomProps.request_schema()
        }
      }
    },
    example: %{
      goal_type: "Goal.Revenue",
      goal: %{
        event_name: "Purchase",
        currency: "EUR"
      }
    }
  })
end