<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta http-equiv="x-ua-compatible" content="ie=edge"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="generator" content="ExDoc v0.30.3"> <meta name="project" content="Plausible v0.0.1"> <title>PlausibleWeb.Plugins.API.Schemas.Goal.CustomEvent — Plausible v0.0.1</title> <link rel="stylesheet" href="dist/html-elixir-P5GXSCHE.css" /> <script src="dist/handlebars.runtime-NWIB6V2M.js"></script> <script src="dist/handlebars.templates-NBND3S2D.js"></script> <script src="dist/sidebar_items-F47805A2.js"></script> <script src="docs_config.js"></script> <script async src="dist/html-CGDDOCMI.js"></script> </head> <body data-type="modules" class="page-module"> <script> try { var settings = JSON.parse(localStorage.getItem('ex_doc:settings') || '{}'); if (settings.theme === 'dark' || ((settings.theme === 'system' || settings.theme == null) && window.matchMedia('(prefers-color-scheme: dark)').matches) ) { document.body.classList.add('dark') } } catch (error) { } </script> <div class="main"> <button class="sidebar-button sidebar-toggle" aria-label="toggle sidebar"> <i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i> </button> <section class="sidebar"> <form class="sidebar-search" action="search.html"> <button type="submit" class="search-button" aria-label="Submit Search"> <i class="ri-search-2-line" aria-hidden="true" title="Submit search"></i> </button> <button type="button" tabindex="-1" class="search-close-button" aria-label="Cancel Search"> <i class="ri-close-line ri-lg" aria-hidden="true" title="Cancel search"></i> </button> <label class="search-label"> <p class="sr-only">Search</p> <input name="q" type="text" class="search-input" placeholder="Search..." aria-label="Input your search terms" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" /> </label> </form> <div class="autocomplete"> <div class="autocomplete-results"> </div> </div> <div class="sidebar-header"> <a href="readme.html"> <img src="assets/logo.png" alt="Plausible" class="sidebar-projectImage"> </a> <div class="sidebar-projectDetails"> <a href="readme.html" class="sidebar-projectName" translate="no"> Plausible </a> <div class="sidebar-projectVersion" translate="no"> v0.0.1 </div> </div> <ul class="sidebar-listNav"> <li><a id="extras-list-link" href="#full-list">Pages</a></li> <li><a id="modules-list-link" href="#full-list">Modules</a></li> <li><a id="tasks-list-link" href="#full-list"><span translate="no">Mix</span> Tasks</a></li> </ul> </div> <div class="gradient"></div> <ul id="full-list"></ul> </section> <section class="content"> <output role="status" id="toast"></output> <div class="content-outer"> <div id="content" class="content-inner"> <h1> <button class="icon-action display-settings"> <i class="ri-settings-3-line"></i> <span class="sr-only">Settings</span> </button> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/plugins/api/schemas/goal/custom_event.ex#L1" title="View Source" class="icon-action" rel="help"> <i class="ri-code-s-slash-line" aria-hidden="true"></i> <span class="sr-only">View Source</span> </a> <span translate="no">PlausibleWeb.Plugins.API.Schemas.Goal.CustomEvent</span> <small class="app-vsn" translate="no">(Plausible v0.0.1)</small> </h1> <section id="moduledoc"> <p>OpenAPI schema for Custom Event Goal object</p> </section> <section id="summary" class="details-list"> <h1 class="section-heading"> <a class="hover-link" href="#summary"> <i class="ri-link-m" aria-hidden="true"></i> Summary </a> </h1> <div class="summary-types summary"> <h2> <a href="#types">Types</a> </h2> <div class="summary-row"> <div class="summary-signature"> <a href="#t:t/0" translate="no">t()</a> </div> </div> </div> <div class="summary-functions summary"> <h2> <a href="#functions">Functions</a> </h2> <div class="summary-row"> <div class="summary-signature"> <a href="#schema/0" translate="no">schema()</a> </div> <div class="summary-synopsis"><p>Callback implementation for <a href="https://hexdocs.pm/open_api_spex/3.18.0/OpenApiSpex.Schema.html#c:schema/0"><code class="inline">OpenApiSpex.Schema.schema/0</code></a>.</p></div> </div> </div> </section> <section id="types" class="details-list"> <h1 class="section-heading"> <a class="hover-link" href="#types"> <i class="ri-link-m" aria-hidden="true"></i> Types </a> </h1> <div class="types-list"> <section class="detail" id="t:t/0"> <div class="detail-header"> <a href="#t:t/0" class="detail-link" title="Link to this type"> <i class="ri-link-m" aria-hidden="true"></i> <span class="sr-only">Link to this type</span> </a> <h1 class="signature" translate="no">t()</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/plugins/api/schemas/goal/custom_event.ex#L7" class="icon-action" rel="help" title="View Source"> <i class="ri-code-s-slash-line" aria-hidden="true"></i> <span class="sr-only">View Source</span> </a> </div> <section class="docstring"> <div class="specs"> <pre translate="no"><span class="attribute">@type</span> t() :: %PlausibleWeb.Plugins.API.Schemas.Goal.CustomEvent{ goal: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(), goal_type: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>() }</pre> </div> </section> </section> </div> </section> <section id="functions" class="details-list"> <h1 class="section-heading"> <a class="hover-link" href="#functions"> <i class="ri-link-m" aria-hidden="true"></i> Functions </a> </h1> <div class="functions-list"> <section class="detail" id="schema/0"> <div class="detail-header"> <a href="#schema/0" class="detail-link" title="Link to this function"> <i class="ri-link-m" aria-hidden="true"></i> <span class="sr-only">Link to this function</span> </a> <h1 class="signature" translate="no">schema()</h1> <a href="https://github.com/plausible/analytics/blob/main/lib/plausible_web/plugins/api/schemas/goal/custom_event.ex#L7" class="icon-action" rel="help" title="View Source"> <i class="ri-code-s-slash-line" aria-hidden="true"></i> <span class="sr-only">View Source</span> </a> </div> <section class="docstring"> <p>Callback implementation for <a href="https://hexdocs.pm/open_api_spex/3.18.0/OpenApiSpex.Schema.html#c:schema/0"><code class="inline">OpenApiSpex.Schema.schema/0</code></a>.</p> </section> </section> </div> </section> <footer class="footer"> <p> <span class="line"> <button class="a-main footer-button display-quick-switch" title="Search HexDocs packages"> Search HexDocs </button> <a href="Plausible.epub" title="ePub version"> Download ePub version </a> </span> </p> <p class="built-using"> Built using <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.30.3) for the <a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a> </p> </footer> </div> </div> </section> </div> <script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js"></script> <script>mermaid.initialize({startOnLoad: true})</script> </body> </html>