2023-07-27 17:47:27 +03:00
<!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" >
2024-01-16 10:41:49 +03:00
< meta name = "generator" content = "ExDoc v0.31.1" >
2023-07-27 17:47:27 +03:00
< meta name = "project" content = "Plausible v0.0.1" >
2024-01-11 10:50:44 +03:00
2023-07-27 17:47:27 +03:00
< title > Plausible.Props — Plausible v0.0.1< / title >
2024-01-16 10:41:49 +03:00
< link rel = "stylesheet" href = "dist/html-elixir-FM2CSD74.css" / >
2023-07-27 17:47:27 +03:00
< script src = "dist/handlebars.runtime-NWIB6V2M.js" > < / script >
2024-01-11 10:50:44 +03:00
< script src = "dist/handlebars.templates-43PMFBC7.js" > < / script >
2024-01-30 12:12:14 +03:00
< script src = "dist/sidebar_items-EF0D6B9C.js" > < / script >
2023-07-27 17:47:27 +03:00
< script src = "docs_config.js" > < / script >
2024-01-16 10:41:49 +03:00
< script async src = "dist/html-L4O5OK2K.js" > < / script >
2023-07-27 17:47:27 +03:00
< / 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" >
2024-01-16 10:41:49 +03:00
< button id = "sidebar-menu" class = "sidebar-button sidebar-toggle" aria-label = "toggle sidebar" aria-controls = "sidebar" >
2023-07-27 17:47:27 +03:00
< i class = "ri-menu-line ri-lg" title = "Collapse/expand sidebar" > < / i >
< / button >
2024-01-16 10:41:49 +03:00
< div class = "background-layer" > < / div >
2024-01-11 10:50:44 +03:00
< nav id = "sidebar" class = "sidebar" >
2023-07-27 17:47:27 +03:00
< div class = "sidebar-header" >
2024-01-11 10:50:44 +03:00
< div class = "sidebar-projectInfo" >
2023-07-27 17:47:27 +03:00
2024-01-11 10:50:44 +03:00
< a href = "readme.html" class = "sidebar-projectImage" >
< img src = "assets/logo.png" alt = "Plausible" / >
< / a >
2023-07-27 17:47:27 +03:00
2024-01-11 10:50:44 +03:00
< div >
< a href = "readme.html" class = "sidebar-projectName" translate = "no" >
2023-07-27 17:47:27 +03:00
Plausible
2024-01-11 10:50:44 +03:00
< / a >
< div class = "sidebar-projectVersion" translate = "no" >
v0.0.1
< / div >
2023-07-27 17:47:27 +03:00
< / div >
< / div >
2024-01-11 10:50:44 +03:00
< ul id = "sidebar-listNav" class = "sidebar-listNav" role = "tablist" >
< li >
< button id = "extras-list-tab-button" role = "tab" data-type = "extras" aria-controls = "extras-tab-panel" aria-selected = "true" tabindex = "0" >
Pages
< / button >
< / li >
< li >
< button id = "modules-list-tab-button" role = "tab" data-type = "modules" aria-controls = "modules-tab-panel" aria-selected = "false" tabindex = "-1" >
Modules
< / button >
< / li >
< li >
< button id = "tasks-list-tab-button" role = "tab" data-type = "tasks" aria-controls = "tasks-tab-panel" aria-selected = "false" tabindex = "-1" >
< span translate = "no" > Mix< / span > Tasks
< / button >
< / li >
2023-07-27 17:47:27 +03:00
2024-01-11 10:50:44 +03:00
< / ul >
< / div >
2023-07-27 17:47:27 +03:00
2024-01-11 10:50:44 +03:00
< div id = "extras-tab-panel" class = "sidebar-tabpanel" role = "tabpanel" aria-labelledby = "extras-list-tab-button" >
< ul id = "extras-full-list" class = "full-list" > < / ul >
< / div >
2023-07-27 17:47:27 +03:00
2024-01-11 10:50:44 +03:00
< div id = "modules-tab-panel" class = "sidebar-tabpanel" role = "tabpanel" aria-labelledby = "modules-list-tab-button" hidden >
< ul id = "modules-full-list" class = "full-list" > < / ul >
< / div >
2023-07-27 17:47:27 +03:00
2024-01-11 10:50:44 +03:00
< div id = "tasks-tab-panel" class = "sidebar-tabpanel" role = "tabpanel" aria-labelledby = "tasks-list-tab-button" hidden >
< ul id = "tasks-full-list" class = "full-list" > < / ul >
< / div >
< / nav >
2023-07-27 17:47:27 +03:00
2024-01-11 10:50:44 +03:00
< main class = "content" >
2023-07-27 17:47:27 +03:00
< output role = "status" id = "toast" > < / output >
< div class = "content-outer" >
< div id = "content" class = "content-inner" >
2024-01-11 10:50:44 +03:00
< div class = "top-search" >
< div class = "search-settings" >
< form class = "search-bar" action = "search.html" >
< label class = "search-label" >
< span class = "sr-only" > Search documentation of Plausible< / span >
< input name = "q" type = "text" class = "search-input" placeholder = "Search Documentation (press /)" autocomplete = "off" autocorrect = "off" autocapitalize = "off" spellcheck = "false" / >
< / label >
< button type = "submit" class = "search-button" aria-label = "Submit Search" >
< i class = "ri-search-2-line ri-lg" aria-hidden = "true" title = "Submit search" > < / i >
< / button >
< button type = "button" tabindex = "-1" class = "search-close-button" aria-hidden = "true" >
< i class = "ri-close-line ri-lg" title = "Cancel search" > < / i >
< / button >
< / form >
2024-01-16 10:41:49 +03:00
< div class = "autocomplete" >
< / div >
2024-01-11 10:50:44 +03:00
< button class = "icon-settings display-settings" >
< i class = "ri-settings-3-line" > < / i >
< span class = "sr-only" > Settings< / span >
< / button >
< / div >
2024-01-16 10:41:49 +03:00
2024-01-11 10:50:44 +03:00
< / div >
2023-07-27 17:47:27 +03:00
< h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/props.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" > Plausible.Props< / span >
< small class = "app-vsn" translate = "no" > (Plausible v0.0.1)< / small >
< / h1 >
< section id = "moduledoc" >
< p > Context module for handling custom event props.< / 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 >
< / a >
2024-01-11 10:50:44 +03:00
< span class = "text" > Summary< / span >
2023-07-27 17:47:27 +03:00
< / h1 >
< div class = "summary-types summary" >
< h2 >
< a href = "#types" > Types< / a >
< / h2 >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#t:prop/0" translate = "no" > prop()< / 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 = "#allow/2" translate = "no" > allow(site, prop_or_props)< / a >
< / div >
2023-08-03 18:18:30 +03:00
< div class = "summary-synopsis" > < p > Allows a prop key or a list of props keys to be included in ClickHouse
queries. Allowing prop keys does not affect ingestion, as we don't want any
data to be dropped or lost.< / p > < / div >
2023-07-27 17:47:27 +03:00
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#allow_changeset/2" translate = "no" > allow_changeset(site, prop_or_props)< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#allow_existing_props/1" translate = "no" > allow_existing_props(site)< / a >
< / div >
< div class = "summary-synopsis" > < p > Allows the 300 most frequent props keys for a specific site over
the past 6 months.< / p > < / div >
< / div >
2024-01-09 17:58:54 +03:00
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#allowed_for/2" translate = "no" > allowed_for(site, opts \\ [])< / a >
< / div >
< div class = "summary-synopsis" > < p > Returns the custom props allowed in queries for the given site. There are
two factors deciding whether a custom property is allowed for a site.< / p > < / div >
< / div >
2023-08-05 16:36:23 +03:00
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#configured?/1" translate = "no" > configured?(site)< / a >
< / div >
< div class = "summary-synopsis" > < p > Returns whether the site has configured custom props or not.< / p > < / div >
< / div >
2023-07-27 17:47:27 +03:00
< div class = "summary-row" >
< div class = "summary-signature" >
2023-12-06 14:34:14 +03:00
< a href = "#disallow/2" translate = "no" > disallow(site, prop_or_props)< / a >
2023-07-27 17:47:27 +03:00
< / div >
2023-12-06 14:34:14 +03:00
< div class = "summary-synopsis" > < p > Removes previously allowed prop key(s) from the allow list. This means this
2023-08-03 18:18:30 +03:00
prop key won't be included in ClickHouse queries. This doesn't drop any
ClickHouse data, nor affects ingestion.< / p > < / div >
2023-07-27 17:47:27 +03:00
< / div >
2023-11-28 12:31:15 +03:00
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#ensure_prop_key_accessible/2" translate = "no" > ensure_prop_key_accessible(prop_key, user)< / a >
< / div >
< / div >
2023-08-05 17:13:59 +03:00
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#internal_keys/0" translate = "no" > internal_keys()< / a >
< / div >
< div class = "summary-synopsis" > < p > Lists prop keys used internally.< / p > < / div >
< / div >
2023-07-27 17:47:27 +03:00
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#max_prop_key_length/0" translate = "no" > max_prop_key_length()< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#max_prop_value_length/0" translate = "no" > max_prop_value_length()< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#max_props/0" translate = "no" > max_props()< / a >
< / div >
< / div >
< div class = "summary-row" >
< div class = "summary-signature" >
< a href = "#suggest_keys_to_allow/2" translate = "no" > suggest_keys_to_allow(site, limit \\ 300)< / a >
< / div >
< div class = "summary-synopsis" > < p > Queries the events table to fetch the 300 most frequent prop keys
for a specific site over the past 6 months, excluding keys that are already
allowed.< / 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 >
< / a >
2024-01-11 10:50:44 +03:00
< span class = "text" > Types< / span >
2023-07-27 17:47:27 +03:00
< / h1 >
< div class = "types-list" >
< section class = "detail" id = "t:prop/0" >
< div class = "detail-header" >
< a href = "#t:prop/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" > prop()< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/props.ex#L8" 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 > prop() :: < a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / 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 >
< / a >
2024-01-11 10:50:44 +03:00
< span class = "text" > Functions< / span >
2023-07-27 17:47:27 +03:00
< / h1 >
< div class = "functions-list" >
< section class = "detail" id = "allow/2" >
< div class = "detail-header" >
< a href = "#allow/2" 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" > allow(site, prop_or_props)< / h1 >
2024-01-09 17:58:54 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/props.ex#L78" class = "icon-action" rel = "help" title = "View Source" >
2023-07-27 17:47:27 +03:00
< 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" > @spec< / span > allow(< a href = "Plausible.Site.html#t:t/0" > Plausible.Site.t< / a > (), [< a href = "#t:prop/0" > prop< / a > ()] | < a href = "#t:prop/0" > prop< / a > ()) ::
2023-10-11 15:41:12 +03:00
{:ok, < a href = "Plausible.Site.html#t:t/0" > Plausible.Site.t< / a > ()}
2024-01-11 10:50:44 +03:00
| {:error, < a href = "https://hexdocs.pm/ecto/3.11.1/Ecto.Changeset.html#t:t/0" > Ecto.Changeset.t< / a > ()}
2023-10-11 15:41:12 +03:00
| {:error, :upgrade_required}< / pre >
2023-07-27 17:47:27 +03:00
< / div >
2023-08-03 18:18:30 +03:00
< p > Allows a prop key or a list of props keys to be included in ClickHouse
queries. Allowing prop keys does not affect ingestion, as we don't want any
data to be dropped or lost.< / p >
2023-07-27 17:47:27 +03:00
< / section >
< / section >
< section class = "detail" id = "allow_changeset/2" >
< div class = "detail-header" >
< a href = "#allow_changeset/2" 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" > allow_changeset(site, prop_or_props)< / h1 >
2024-01-09 17:58:54 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/props.ex#L87" class = "icon-action" rel = "help" title = "View Source" >
2023-07-27 17:47:27 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< / section >
< / section >
< section class = "detail" id = "allow_existing_props/1" >
< div class = "detail-header" >
< a href = "#allow_existing_props/1" 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" > allow_existing_props(site)< / h1 >
2024-01-09 17:58:54 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/props.ex#L131" class = "icon-action" rel = "help" title = "View Source" >
2023-07-27 17:47:27 +03:00
< 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" >
2023-10-11 15:41:12 +03:00
< pre translate = "no" > < span class = "attribute" > @spec< / span > allow_existing_props(< a href = "Plausible.Site.html#t:t/0" > Plausible.Site.t< / a > ()) ::
{:ok, < a href = "Plausible.Site.html#t:t/0" > Plausible.Site.t< / a > ()} | {:error, :upgrade_required}< / pre >
2023-07-27 17:47:27 +03:00
< / div >
< p > Allows the 300 most frequent props keys for a specific site over
the past 6 months.< / p >
< / section >
< / section >
2024-01-09 17:58:54 +03:00
< section class = "detail" id = "allowed_for/2" >
< span id = "allowed_for/1" > < / span >
< div class = "detail-header" >
< a href = "#allowed_for/2" 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" > allowed_for(site, opts \\ [])< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/props.ex#L57" 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 > Returns the custom props allowed in queries for the given site. There are
two factors deciding whether a custom property is allowed for a site.< / p > < h3 id = "allowed_for/2-1-subscription-plan-including-the-props-feature" class = "section-heading" >
2024-01-11 10:50:44 +03:00
< a href = "#allowed_for/2-1-subscription-plan-including-the-props-feature" class = "hover-link" >
2024-01-09 17:58:54 +03:00
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< / a >
2024-01-11 10:50:44 +03:00
< span class = "text" > 1. Subscription plan including the props feature.< / span >
2024-01-09 17:58:54 +03:00
< / h3 >
< p > Internally used keys (i.e. < code class = "inline" > [" url" , " path" ]< / code > ) are always allowed,
even for plans that don't include props. For any other props, access to the
Custom Properties feature is required.< / p > < h3 id = "allowed_for/2-2-the-site-having-an-allowed_event_props-list-configured" class = "section-heading" >
2024-01-11 10:50:44 +03:00
< a href = "#allowed_for/2-2-the-site-having-an-allowed_event_props-list-configured" class = "hover-link" >
2024-01-09 17:58:54 +03:00
< i class = "ri-link-m" aria-hidden = "true" > < / i >
< / a >
2024-01-11 10:50:44 +03:00
< span class = "text" > 2. The site having an < code class = "inline" > allowed_event_props< / code > list configured.< / span >
2024-01-09 17:58:54 +03:00
< / h3 >
< p > For customers with a configured < code class = "inline" > allowed_event_props< / code > list, this function
returns that list (+ internally used keys). That helps to filter out garbage
props which people might not want to see in their dashboards.< / p > < p > With the < code class = "inline" > bypass_setup?< / code > boolean option you can override the requirement of
the site having set up props in the < code class = "inline" > allowed_event_props< / code > list. For example,
this is currently used for fetching allowed properties in Stats API queries
in order to ensure the props feature access.< / p > < p > Since < code class = "inline" > allowed_event_props< / code > was added after the props feature had already
been used for a while, there are sites with < code class = "inline" > allowed_event_props = nil< / code > . For
those sites, all custom properties that exist in the database are allowed to
be queried.< / p >
< / section >
< / section >
2023-08-05 16:36:23 +03:00
< section class = "detail" id = "configured?/1" >
< div class = "detail-header" >
< a href = "#configured?/1" 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" > configured?(site)< / h1 >
2024-01-09 17:58:54 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/props.ex#L181" class = "icon-action" rel = "help" title = "View Source" >
2023-08-05 16:36:23 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< p > Returns whether the site has configured custom props or not.< / p >
< / section >
< / section >
2023-07-27 17:47:27 +03:00
< section class = "detail" id = "disallow/2" >
< div class = "detail-header" >
< a href = "#disallow/2" 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 >
2023-12-06 14:34:14 +03:00
< h1 class = "signature" translate = "no" > disallow(site, prop_or_props)< / h1 >
2023-07-27 17:47:27 +03:00
2024-01-09 17:58:54 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/props.ex#L101" class = "icon-action" rel = "help" title = "View Source" >
2023-07-27 17:47:27 +03:00
< 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" >
2023-12-06 14:34:14 +03:00
< pre translate = "no" > < span class = "attribute" > @spec< / span > disallow(< a href = "Plausible.Site.html#t:t/0" > Plausible.Site.t< / a > (), [< a href = "#t:prop/0" > prop< / a > ()] | < a href = "#t:prop/0" > prop< / a > ()) ::
2024-01-11 10:50:44 +03:00
{:ok, < a href = "Plausible.Site.html#t:t/0" > Plausible.Site.t< / a > ()} | {:error, < a href = "https://hexdocs.pm/ecto/3.11.1/Ecto.Changeset.html#t:t/0" > Ecto.Changeset.t< / a > ()}< / pre >
2023-07-27 17:47:27 +03:00
< / div >
2023-12-06 14:34:14 +03:00
< p > Removes previously allowed prop key(s) from the allow list. This means this
2023-08-03 18:18:30 +03:00
prop key won't be included in ClickHouse queries. This doesn't drop any
ClickHouse data, nor affects ingestion.< / p >
2023-11-28 12:31:15 +03:00
< / section >
< / section >
< section class = "detail" id = "ensure_prop_key_accessible/2" >
< div class = "detail-header" >
< a href = "#ensure_prop_key_accessible/2" 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" > ensure_prop_key_accessible(prop_key, user)< / h1 >
2024-01-09 17:58:54 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/props.ex#L140" class = "icon-action" rel = "help" title = "View Source" >
2023-11-28 12:31:15 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
2023-08-05 17:13:59 +03:00
< / section >
< / section >
< section class = "detail" id = "internal_keys/0" >
< div class = "detail-header" >
< a href = "#internal_keys/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" > internal_keys()< / h1 >
2024-01-09 17:58:54 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/props.ex#L28" class = "icon-action" rel = "help" title = "View Source" >
2023-08-05 17:13:59 +03:00
< i class = "ri-code-s-slash-line" aria-hidden = "true" > < / i >
< span class = "sr-only" > View Source< / span >
< / a >
< / div >
< section class = "docstring" >
< p > Lists prop keys used internally.< / p > < p > These props should be allowed by default, and should not be displayed in the
props settings page. For example, < code class = "inline" > url< / code > is a special prop key used for file
downloads and outbound links. It doesn't make sense to remove this prop key
from the allow list, or to suggest users to add this prop key.< / p >
2023-07-27 17:47:27 +03:00
< / section >
< / section >
< section class = "detail" id = "max_prop_key_length/0" >
< div class = "detail-header" >
< a href = "#max_prop_key_length/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" > max_prop_key_length()< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/props.ex#L14" 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" >
< / section >
< / section >
< section class = "detail" id = "max_prop_value_length/0" >
< div class = "detail-header" >
< a href = "#max_prop_value_length/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" > max_prop_value_length()< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/props.ex#L17" 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" >
< / section >
< / section >
< section class = "detail" id = "max_props/0" >
< div class = "detail-header" >
< a href = "#max_props/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" > max_props()< / h1 >
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/props.ex#L11" 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" >
< / section >
< / section >
< section class = "detail" id = "suggest_keys_to_allow/2" >
< span id = "suggest_keys_to_allow/1" > < / span >
< div class = "detail-header" >
< a href = "#suggest_keys_to_allow/2" 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" > suggest_keys_to_allow(site, limit \\ 300)< / h1 >
2024-01-09 17:58:54 +03:00
< a href = "https://github.com/plausible/analytics/blob/main/lib/plausible/props.ex#L154" class = "icon-action" rel = "help" title = "View Source" >
2023-07-27 17:47:27 +03:00
< 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" > @spec< / span > suggest_keys_to_allow(< a href = "Plausible.Site.html#t:t/0" > Plausible.Site.t< / a > (), < a href = "https://hexdocs.pm/elixir/typespecs.html#basic-types" > non_neg_integer< / a > ()) :: [< a href = "https://hexdocs.pm/elixir/String.html#t:t/0" > String.t< / a > ()]< / pre >
< / div >
< p > Queries the events table to fetch the 300 most frequent prop keys
for a specific site over the past 6 months, excluding keys that are already
allowed.< / 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
2024-01-16 10:41:49 +03:00
< a href = "https://github.com/elixir-lang/ex_doc" title = "ExDoc" target = "_blank" rel = "help noopener" translate = "no" > ExDoc< / a > (v0.31.1) for the
2023-07-27 17:47:27 +03:00
< a href = "https://elixir-lang.org" title = "Elixir" target = "_blank" translate = "no" > Elixir programming language< / a >
< / p >
< / footer >
< / div >
< / div >
2024-01-11 10:50:44 +03:00
< / main >
2023-07-27 17:47:27 +03:00
< / div >
< script src = "https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js" > < / script >
< script > mermaid . initialize ( { startOnLoad : true } ) < / script >
< / body >
< / html >
