mirror of
https://github.com/plausible/analytics.git
synced 2024-11-27 09:16:25 +03:00
1 line
621 KiB
JavaScript
1 line
621 KiB
JavaScript
searchData={"items":[{"type":"task","title":"mix cancel_subscription","doc":"This task is meant to replicate the behavior of cancelling\na subscription. On production, this action is initiated by\na Paddle webhook. Currently, only the subscription status\nis changed with that action.","ref":"Mix.Tasks.CancelSubscription.html"},{"type":"function","title":"Mix.Tasks.CancelSubscription.run/1","doc":"","ref":"Mix.Tasks.CancelSubscription.html#run/1"},{"type":"task","title":"mix clean_clickhouse","doc":"","ref":"Mix.Tasks.CleanClickhouse.html"},{"type":"function","title":"Mix.Tasks.CleanClickhouse.run/1","doc":"","ref":"Mix.Tasks.CleanClickhouse.html#run/1"},{"type":"task","title":"mix create_free_subscription","doc":"","ref":"Mix.Tasks.CreateFreeSubscription.html"},{"type":"function","title":"Mix.Tasks.CreateFreeSubscription.execute/1","doc":"","ref":"Mix.Tasks.CreateFreeSubscription.html#execute/1"},{"type":"function","title":"Mix.Tasks.CreateFreeSubscription.run/1","doc":"","ref":"Mix.Tasks.CreateFreeSubscription.html#run/1"},{"type":"task","title":"mix download_country_database","doc":"This task downloads the Country Lite database from DB-IP for self-hosted or development purposes.\nPlausible Cloud runs a paid version of DB-IP with more detailed geolocation data.","ref":"Mix.Tasks.DownloadCountryDatabase.html"},{"type":"function","title":"Mix.Tasks.DownloadCountryDatabase.run/1","doc":"","ref":"Mix.Tasks.DownloadCountryDatabase.html#run/1"},{"type":"task","title":"mix generate_referrer_favicons","doc":"","ref":"Mix.Tasks.GenerateReferrerFavicons.html"},{"type":"function","title":"Mix.Tasks.GenerateReferrerFavicons.run/1","doc":"","ref":"Mix.Tasks.GenerateReferrerFavicons.html#run/1"},{"type":"task","title":"mix pull_sandbox_subscription","doc":"","ref":"Mix.Tasks.PullSandboxSubscription.html"},{"type":"function","title":"Mix.Tasks.PullSandboxSubscription.run/1","doc":"","ref":"Mix.Tasks.PullSandboxSubscription.html#run/1"},{"type":"task","title":"mix send_pageview","doc":"It's often necessary to generate fake events for development and testing purposes. This Mix Task provides a quick and easy\nway to generate a pageview or custom event, either in your development environment or a remote Plausible instance.\n\nSee Mix.Tasks.SendPageview.usage/1 for more detailed documentation.","ref":"Mix.Tasks.SendPageview.html"},{"type":"function","title":"Mix.Tasks.SendPageview.run/1","doc":"","ref":"Mix.Tasks.SendPageview.html#run/1"},{"type":"module","title":"ObanErrorReporter","doc":"","ref":"ObanErrorReporter.html"},{"type":"function","title":"ObanErrorReporter.handle_event/4","doc":"","ref":"ObanErrorReporter.html#handle_event/4"},{"type":"module","title":"Plausible","doc":"Build-related macros","ref":"Plausible.html"},{"type":"function","title":"Plausible.ce?/0","doc":"","ref":"Plausible.html#ce?/0"},{"type":"function","title":"Plausible.ee?/0","doc":"","ref":"Plausible.html#ee?/0"},{"type":"macro","title":"Plausible.on_ce/1","doc":"","ref":"Plausible.html#on_ce/1"},{"type":"macro","title":"Plausible.on_ee/1","doc":"","ref":"Plausible.html#on_ee/1"},{"type":"function","title":"Plausible.product_name/0","doc":"","ref":"Plausible.html#product_name/0"},{"type":"module","title":"Plausible.AsyncInsertRepo","doc":"Clickhouse access with async inserts enabled","ref":"Plausible.AsyncInsertRepo.html"},{"type":"function","title":"Plausible.AsyncInsertRepo.aggregate/3","doc":"","ref":"Plausible.AsyncInsertRepo.html#aggregate/3"},{"type":"function","title":"Plausible.AsyncInsertRepo.aggregate/4","doc":"","ref":"Plausible.AsyncInsertRepo.html#aggregate/4"},{"type":"function","title":"Plausible.AsyncInsertRepo.all/2","doc":"","ref":"Plausible.AsyncInsertRepo.html#all/2"},{"type":"function","title":"Plausible.AsyncInsertRepo.alter_update_all/3","doc":"Similar to `Ecto.Repo.update_all/3` but uses [`ALTER TABLE ... UPDATE`](https://clickhouse.com/docs/en/sql-reference/statements/alter/update) instead.\n\nFor more information and performance implications please see:\n\n - https://clickhouse.com/blog/handling-updates-and-deletes-in-clickhouse\n - https://clickhouse.com/docs/en/guides/developer/mutations","ref":"Plausible.AsyncInsertRepo.html#alter_update_all/3"},{"type":"function","title":"Plausible.AsyncInsertRepo.checked_out?/0","doc":"","ref":"Plausible.AsyncInsertRepo.html#checked_out?/0"},{"type":"function","title":"Plausible.AsyncInsertRepo.checkout/2","doc":"","ref":"Plausible.AsyncInsertRepo.html#checkout/2"},{"type":"function","title":"Plausible.AsyncInsertRepo.child_spec/1","doc":"","ref":"Plausible.AsyncInsertRepo.html#child_spec/1"},{"type":"function","title":"Plausible.AsyncInsertRepo.config/0","doc":"","ref":"Plausible.AsyncInsertRepo.html#config/0"},{"type":"function","title":"Plausible.AsyncInsertRepo.default_options/1","doc":"","ref":"Plausible.AsyncInsertRepo.html#default_options/1"},{"type":"function","title":"Plausible.AsyncInsertRepo.delete/2","doc":"","ref":"Plausible.AsyncInsertRepo.html#delete/2"},{"type":"function","title":"Plausible.AsyncInsertRepo.delete!/2","doc":"","ref":"Plausible.AsyncInsertRepo.html#delete!/2"},{"type":"function","title":"Plausible.AsyncInsertRepo.delete_all/2","doc":"","ref":"Plausible.AsyncInsertRepo.html#delete_all/2"},{"type":"function","title":"Plausible.AsyncInsertRepo.disconnect_all/2","doc":"A convenience function for SQL-based repositories that forces all connections in the\npool to disconnect within the given interval.\n\nSee `Ecto.Adapters.SQL.disconnect_all/3` for more information.","ref":"Plausible.AsyncInsertRepo.html#disconnect_all/2"},{"type":"function","title":"Plausible.AsyncInsertRepo.exists?/2","doc":"","ref":"Plausible.AsyncInsertRepo.html#exists?/2"},{"type":"function","title":"Plausible.AsyncInsertRepo.get/3","doc":"","ref":"Plausible.AsyncInsertRepo.html#get/3"},{"type":"function","title":"Plausible.AsyncInsertRepo.get!/3","doc":"","ref":"Plausible.AsyncInsertRepo.html#get!/3"},{"type":"function","title":"Plausible.AsyncInsertRepo.get_by/3","doc":"","ref":"Plausible.AsyncInsertRepo.html#get_by/3"},{"type":"function","title":"Plausible.AsyncInsertRepo.get_by!/3","doc":"","ref":"Plausible.AsyncInsertRepo.html#get_by!/3"},{"type":"function","title":"Plausible.AsyncInsertRepo.get_dynamic_repo/0","doc":"","ref":"Plausible.AsyncInsertRepo.html#get_dynamic_repo/0"},{"type":"function","title":"Plausible.AsyncInsertRepo.insert/2","doc":"","ref":"Plausible.AsyncInsertRepo.html#insert/2"},{"type":"function","title":"Plausible.AsyncInsertRepo.insert!/2","doc":"","ref":"Plausible.AsyncInsertRepo.html#insert!/2"},{"type":"function","title":"Plausible.AsyncInsertRepo.insert_all/3","doc":"","ref":"Plausible.AsyncInsertRepo.html#insert_all/3"},{"type":"function","title":"Plausible.AsyncInsertRepo.insert_or_update/2","doc":"","ref":"Plausible.AsyncInsertRepo.html#insert_or_update/2"},{"type":"function","title":"Plausible.AsyncInsertRepo.insert_or_update!/2","doc":"","ref":"Plausible.AsyncInsertRepo.html#insert_or_update!/2"},{"type":"function","title":"Plausible.AsyncInsertRepo.insert_stream/3","doc":"Similar to `insert_all/2` but with the following differences:\n\n - accepts rows as streams or lists\n - sends rows as a chunked request\n - doesn't autogenerate ids or does any other preprocessing\n\nExample:\n\n Repo.query!(\"create table ecto_ch_demo(a UInt64, b String) engine Null\")\n\n defmodule Demo do\n use Ecto.Schema\n\n @primary_key false\n schema \"ecto_ch_demo\" do\n field :a, Ch, type: \"UInt64\"\n field :b, :string\n end\n end\n\n rows = Stream.map(1..100_000, fn i -> %{a: i, b: to_string(i)} end)\n {100_000, nil} = Repo.insert_stream(Demo, rows)\n\n # schemaless\n {100_000, nil} = Repo.insert_stream(\"ecto_ch_demo\", rows, types: [a: Ch.Types.u64(), b: :string])","ref":"Plausible.AsyncInsertRepo.html#insert_stream/3"},{"type":"function","title":"Plausible.AsyncInsertRepo.load/2","doc":"","ref":"Plausible.AsyncInsertRepo.html#load/2"},{"type":"function","title":"Plausible.AsyncInsertRepo.one/2","doc":"","ref":"Plausible.AsyncInsertRepo.html#one/2"},{"type":"function","title":"Plausible.AsyncInsertRepo.one!/2","doc":"","ref":"Plausible.AsyncInsertRepo.html#one!/2"},{"type":"function","title":"Plausible.AsyncInsertRepo.preload/3","doc":"","ref":"Plausible.AsyncInsertRepo.html#preload/3"},{"type":"function","title":"Plausible.AsyncInsertRepo.prepare_query/3","doc":"","ref":"Plausible.AsyncInsertRepo.html#prepare_query/3"},{"type":"function","title":"Plausible.AsyncInsertRepo.put_dynamic_repo/1","doc":"","ref":"Plausible.AsyncInsertRepo.html#put_dynamic_repo/1"},{"type":"function","title":"Plausible.AsyncInsertRepo.query/3","doc":"A convenience function for SQL-based repositories that executes the given query.\n\nSee `Ecto.Adapters.SQL.query/4` for more information.","ref":"Plausible.AsyncInsertRepo.html#query/3"},{"type":"function","title":"Plausible.AsyncInsertRepo.query!/3","doc":"A convenience function for SQL-based repositories that executes the given query.\n\nSee `Ecto.Adapters.SQL.query!/4` for more information.","ref":"Plausible.AsyncInsertRepo.html#query!/3"},{"type":"function","title":"Plausible.AsyncInsertRepo.reload/2","doc":"","ref":"Plausible.AsyncInsertRepo.html#reload/2"},{"type":"function","title":"Plausible.AsyncInsertRepo.reload!/2","doc":"","ref":"Plausible.AsyncInsertRepo.html#reload!/2"},{"type":"function","title":"Plausible.AsyncInsertRepo.start_link/1","doc":"","ref":"Plausible.AsyncInsertRepo.html#start_link/1"},{"type":"function","title":"Plausible.AsyncInsertRepo.stop/1","doc":"","ref":"Plausible.AsyncInsertRepo.html#stop/1"},{"type":"function","title":"Plausible.AsyncInsertRepo.stream/2","doc":"","ref":"Plausible.AsyncInsertRepo.html#stream/2"},{"type":"function","title":"Plausible.AsyncInsertRepo.to_inline_sql/2","doc":"Similar to `to_sql/2` but inlines the parameters into the SQL query.\n\nSee `Ecto.Adapters.ClickHouse.to_inline_sql/2` for more information.","ref":"Plausible.AsyncInsertRepo.html#to_inline_sql/2"},{"type":"function","title":"Plausible.AsyncInsertRepo.to_sql/2","doc":"A convenience function for SQL-based repositories that translates the given query to SQL.\n\nSee `Ecto.Adapters.SQL.to_sql/3` for more information.","ref":"Plausible.AsyncInsertRepo.html#to_sql/2"},{"type":"function","title":"Plausible.AsyncInsertRepo.update/2","doc":"","ref":"Plausible.AsyncInsertRepo.html#update/2"},{"type":"function","title":"Plausible.AsyncInsertRepo.update!/2","doc":"","ref":"Plausible.AsyncInsertRepo.html#update!/2"},{"type":"function","title":"Plausible.AsyncInsertRepo.update_all/3","doc":"","ref":"Plausible.AsyncInsertRepo.html#update_all/3"},{"type":"module","title":"Plausible.Auth","doc":"Functions for user authentication context.","ref":"Plausible.Auth.html"},{"type":"function","title":"Plausible.Auth.check_password/2","doc":"","ref":"Plausible.Auth.html#check_password/2"},{"type":"function","title":"Plausible.Auth.create_api_key/3","doc":"","ref":"Plausible.Auth.html#create_api_key/3"},{"type":"function","title":"Plausible.Auth.create_user/3","doc":"","ref":"Plausible.Auth.html#create_user/3"},{"type":"function","title":"Plausible.Auth.delete_api_key/2","doc":"","ref":"Plausible.Auth.html#delete_api_key/2"},{"type":"function","title":"Plausible.Auth.delete_user/1","doc":"","ref":"Plausible.Auth.html#delete_user/1"},{"type":"function","title":"Plausible.Auth.enterprise_configured?/1","doc":"","ref":"Plausible.Auth.html#enterprise_configured?/1"},{"type":"function","title":"Plausible.Auth.find_api_key/1","doc":"","ref":"Plausible.Auth.html#find_api_key/1"},{"type":"function","title":"Plausible.Auth.find_user_by/1","doc":"","ref":"Plausible.Auth.html#find_user_by/1"},{"type":"function","title":"Plausible.Auth.get_user_by/1","doc":"","ref":"Plausible.Auth.html#get_user_by/1"},{"type":"function","title":"Plausible.Auth.has_active_sites?/2","doc":"","ref":"Plausible.Auth.html#has_active_sites?/2"},{"type":"function","title":"Plausible.Auth.is_super_admin?/1","doc":"","ref":"Plausible.Auth.html#is_super_admin?/1"},{"type":"function","title":"Plausible.Auth.rate_limit/2","doc":"","ref":"Plausible.Auth.html#rate_limit/2"},{"type":"function","title":"Plausible.Auth.rate_limits/0","doc":"","ref":"Plausible.Auth.html#rate_limits/0"},{"type":"function","title":"Plausible.Auth.user_owns_sites?/1","doc":"","ref":"Plausible.Auth.html#user_owns_sites?/1"},{"type":"type","title":"Plausible.Auth.rate_limit_type/0","doc":"","ref":"Plausible.Auth.html#t:rate_limit_type/0"},{"type":"module","title":"Plausible.Auth.ApiKey","doc":"","ref":"Plausible.Auth.ApiKey.html"},{"type":"function","title":"Plausible.Auth.ApiKey.changeset/2","doc":"","ref":"Plausible.Auth.ApiKey.html#changeset/2"},{"type":"function","title":"Plausible.Auth.ApiKey.do_hash/1","doc":"","ref":"Plausible.Auth.ApiKey.html#do_hash/1"},{"type":"function","title":"Plausible.Auth.ApiKey.process_key/1","doc":"","ref":"Plausible.Auth.ApiKey.html#process_key/1"},{"type":"function","title":"Plausible.Auth.ApiKey.update/2","doc":"","ref":"Plausible.Auth.ApiKey.html#update/2"},{"type":"type","title":"Plausible.Auth.ApiKey.t/0","doc":"","ref":"Plausible.Auth.ApiKey.html#t:t/0"},{"type":"module","title":"Plausible.Auth.ApiKeyAdmin","doc":"","ref":"Plausible.Auth.ApiKeyAdmin.html"},{"type":"function","title":"Plausible.Auth.ApiKeyAdmin.create_changeset/2","doc":"","ref":"Plausible.Auth.ApiKeyAdmin.html#create_changeset/2"},{"type":"function","title":"Plausible.Auth.ApiKeyAdmin.custom_index_query/3","doc":"","ref":"Plausible.Auth.ApiKeyAdmin.html#custom_index_query/3"},{"type":"function","title":"Plausible.Auth.ApiKeyAdmin.form_fields/1","doc":"","ref":"Plausible.Auth.ApiKeyAdmin.html#form_fields/1"},{"type":"function","title":"Plausible.Auth.ApiKeyAdmin.index/1","doc":"","ref":"Plausible.Auth.ApiKeyAdmin.html#index/1"},{"type":"function","title":"Plausible.Auth.ApiKeyAdmin.search_fields/1","doc":"","ref":"Plausible.Auth.ApiKeyAdmin.html#search_fields/1"},{"type":"function","title":"Plausible.Auth.ApiKeyAdmin.update_changeset/2","doc":"","ref":"Plausible.Auth.ApiKeyAdmin.html#update_changeset/2"},{"type":"module","title":"Plausible.Auth.EmailActivationCode","doc":"Schema for email activation codes.","ref":"Plausible.Auth.EmailActivationCode.html"},{"type":"function","title":"Plausible.Auth.EmailActivationCode.generate_code/0","doc":"","ref":"Plausible.Auth.EmailActivationCode.html#generate_code/0"},{"type":"function","title":"Plausible.Auth.EmailActivationCode.new/2","doc":"","ref":"Plausible.Auth.EmailActivationCode.html#new/2"},{"type":"type","title":"Plausible.Auth.EmailActivationCode.t/0","doc":"","ref":"Plausible.Auth.EmailActivationCode.html#t:t/0"},{"type":"module","title":"Plausible.Auth.EmailVerification","doc":"API for verifying emails.","ref":"Plausible.Auth.EmailVerification.html"},{"type":"function","title":"Plausible.Auth.EmailVerification.any?/1","doc":"","ref":"Plausible.Auth.EmailVerification.html#any?/1"},{"type":"function","title":"Plausible.Auth.EmailVerification.expired?/1","doc":"","ref":"Plausible.Auth.EmailVerification.html#expired?/1"},{"type":"function","title":"Plausible.Auth.EmailVerification.issue_code/2","doc":"","ref":"Plausible.Auth.EmailVerification.html#issue_code/2"},{"type":"function","title":"Plausible.Auth.EmailVerification.verify_code/2","doc":"","ref":"Plausible.Auth.EmailVerification.html#verify_code/2"},{"type":"module","title":"Plausible.Auth.GracePeriod","doc":"This embedded schema stores information about the account locking grace\nperiod.\n\nUsers are given this 7-day grace period to upgrade their account after\noutgrowing their subscriptions. The actual account locking happens in\nbackground with `Plausible.Workers.LockSites`.\n\nThe grace period can also be manual, without an end date, being controlled\nmanually from the CRM, and not by the background site locker job. This is\nuseful for enterprise subscriptions.","ref":"Plausible.Auth.GracePeriod.html"},{"type":"function","title":"Plausible.Auth.GracePeriod.active?/1","doc":"Returns whether the grace period is still active for a User. Defaults to\nfalse if the user is nil or there is no grace period.","ref":"Plausible.Auth.GracePeriod.html#active?/1"},{"type":"function","title":"Plausible.Auth.GracePeriod.end_changeset/1","doc":"Ends an existing grace period by `setting users.grace_period.is_over` to true.\nThis means the grace period has expired.","ref":"Plausible.Auth.GracePeriod.html#end_changeset/1"},{"type":"function","title":"Plausible.Auth.GracePeriod.expired?/1","doc":"Returns whether the grace period has already expired for a User. Defaults to\nfalse if the user is nil or there is no grace period.","ref":"Plausible.Auth.GracePeriod.html#expired?/1"},{"type":"function","title":"Plausible.Auth.GracePeriod.remove_changeset/1","doc":"Removes the grace period from the User completely.","ref":"Plausible.Auth.GracePeriod.html#remove_changeset/1"},{"type":"function","title":"Plausible.Auth.GracePeriod.start_changeset/1","doc":"Starts a account locking grace period of 7 days by changing the User struct.","ref":"Plausible.Auth.GracePeriod.html#start_changeset/1"},{"type":"function","title":"Plausible.Auth.GracePeriod.start_manual_lock_changeset/1","doc":"Starts a manual account locking grace period by changing the User struct.\nManual locking means the grace period can only be removed manually from the\nCRM.","ref":"Plausible.Auth.GracePeriod.html#start_manual_lock_changeset/1"},{"type":"type","title":"Plausible.Auth.GracePeriod.t/0","doc":"","ref":"Plausible.Auth.GracePeriod.html#t:t/0"},{"type":"module","title":"Plausible.Auth.Invitation","doc":"","ref":"Plausible.Auth.Invitation.html"},{"type":"function","title":"Plausible.Auth.Invitation.new/1","doc":"","ref":"Plausible.Auth.Invitation.html#new/1"},{"type":"type","title":"Plausible.Auth.Invitation.t/0","doc":"","ref":"Plausible.Auth.Invitation.html#t:t/0"},{"type":"module","title":"Plausible.Auth.Password","doc":"","ref":"Plausible.Auth.Password.html"},{"type":"function","title":"Plausible.Auth.Password.dummy_calculation/0","doc":"","ref":"Plausible.Auth.Password.html#dummy_calculation/0"},{"type":"function","title":"Plausible.Auth.Password.hash/1","doc":"","ref":"Plausible.Auth.Password.html#hash/1"},{"type":"function","title":"Plausible.Auth.Password.match?/2","doc":"","ref":"Plausible.Auth.Password.html#match?/2"},{"type":"module","title":"Plausible.Auth.TOTP","doc":"TOTP auth context\n\nHandles all the aspects of TOTP setup, management and validation for users.","ref":"Plausible.Auth.TOTP.html"},{"type":"module","title":"Setup - Plausible.Auth.TOTP","doc":"TOTP setup is started with `initiate/1`. At this stage, a random secret\nbinary is generated for user and stored under `User.totp_secret`. The secret\nis additionally encrypted while stored in the database using `Cloak`. The\nvault for safe storage is configured in `Plausible.Auth.TOTP.Vault` via\na dedicated `Ecto` type defined in `Plausible.Auth.TOTP.EncryptedBinary`.\nThe function returns updated user along with TOTP URI and a readable form\nof secret. Both - the URI and readable secret - are meant for exposure\nin the user's setup screen. The URI should be encoded as a QR code.\n\nAfter initiation, user is expected to confirm valid setup with `enable/2`,\nproviding TOTP code from their authenticator app. After code validation\npasses successfully, the `User.totp_enabled` flag is set to `true`.\nFinally, the user must be immediately presented with a list of recovery codes\nreturned by the same call of `enable/2`. The codes should be presented\nin copy/paste friendly form, ideally also with a print-friendly view option.\n\nThe `initiate/1` and `enable/1` functions can be safely called multiple\ntimes, allowing user to abort and restart setup up to these stages.","ref":"Plausible.Auth.TOTP.html#module-setup"},{"type":"module","title":"Management - Plausible.Auth.TOTP","doc":"The state of TOTP for a particular user can be chcecked by calling\n`enabled?/1` or `initiated?/1`.\n\nTOTP can be disabled with `disable/2`. User is expected to provide their\ncurrent password for safety. Once disabled, all TOTP user settings are\ncleared and any remaining generated recovery codes are removed. The function\ncan be safely run more than once. There's also alternative call for forced\ndisabling of TOTP for a given user without sending any notification,\n`force_disable/1`. It's meant for use in situation where user lost both,\n2FA device and recovery codes and their identity is verified independently.\n\nIf the user needs to regenerate the recovery codes outside of setup procedure,\nthey must do it via `generate_recovery_codes/2`, providing their current\npassword for safety. They must be warned that any existing recovery codes\nwill be invalidated.","ref":"Plausible.Auth.TOTP.html#module-management"},{"type":"module","title":"Validation - Plausible.Auth.TOTP","doc":"After logging in, user's TOTP state must be checked with `enabled?/1`.\n\nIf enabled, user must be presented with TOTP code input form accepting\n6 digit characters. The code must be checked using `validate_code/2`.\n\nUser must have an option to alternatively input one of their recovery\ncodes. Those codes must be checked with `use_recovery_code/2`.","ref":"Plausible.Auth.TOTP.html#module-validation"},{"type":"module","title":"Code validity - Plausible.Auth.TOTP","doc":"In case of TOTP codes, a grace period of 30 seconds is applied, which\nallows user to use their current and previous TOTP code, assuming 30\nsecond validity window of each. This allows user to use code that was\nabout to expire before the submission. Regardless of that, each TOTP\ncode can be used only once. Validation procedure rejects repeat use\nof the same code for safety. It's done by tracking last time a TOTP\ncode was used successfully, stored under `User.totp_last_used_at`.\n\nIn case of recovery codes, each code is deleted immediately after use.\nThey are strictly one-time use only.","ref":"Plausible.Auth.TOTP.html#module-code-validity"},{"type":"module","title":"TOTP Token - Plausible.Auth.TOTP","doc":"TOTP token is an alternate method of authenticating user session.\nIt's main use case is \"trust this device\" functionality, where user\ncan decide to skip 2FA verification for a particular browser session\nfor next N days. The token should then be stored in an encrypted,\nsigned cookie with a proper expiration timestamp.\n\nThe token should be reset each time it either fails to match\nor when other credentials (like password) are reset. This should\neffectively invalidate all trusted devices for a given user.","ref":"Plausible.Auth.TOTP.html#module-totp-token"},{"type":"function","title":"Plausible.Auth.TOTP.disable/2","doc":"","ref":"Plausible.Auth.TOTP.html#disable/2"},{"type":"function","title":"Plausible.Auth.TOTP.enable/3","doc":"","ref":"Plausible.Auth.TOTP.html#enable/3"},{"type":"function","title":"Plausible.Auth.TOTP.enabled?/1","doc":"","ref":"Plausible.Auth.TOTP.html#enabled?/1"},{"type":"function","title":"Plausible.Auth.TOTP.force_disable/1","doc":"","ref":"Plausible.Auth.TOTP.html#force_disable/1"},{"type":"function","title":"Plausible.Auth.TOTP.generate_recovery_codes/1","doc":"","ref":"Plausible.Auth.TOTP.html#generate_recovery_codes/1"},{"type":"function","title":"Plausible.Auth.TOTP.generate_recovery_codes/2","doc":"","ref":"Plausible.Auth.TOTP.html#generate_recovery_codes/2"},{"type":"function","title":"Plausible.Auth.TOTP.initiate/1","doc":"","ref":"Plausible.Auth.TOTP.html#initiate/1"},{"type":"function","title":"Plausible.Auth.TOTP.initiated?/1","doc":"","ref":"Plausible.Auth.TOTP.html#initiated?/1"},{"type":"function","title":"Plausible.Auth.TOTP.reset_token/1","doc":"","ref":"Plausible.Auth.TOTP.html#reset_token/1"},{"type":"function","title":"Plausible.Auth.TOTP.use_recovery_code/2","doc":"","ref":"Plausible.Auth.TOTP.html#use_recovery_code/2"},{"type":"function","title":"Plausible.Auth.TOTP.validate_code/3","doc":"","ref":"Plausible.Auth.TOTP.html#validate_code/3"},{"type":"module","title":"Plausible.Auth.TOTP.EncryptedBinary","doc":"Defines an Ecto type so Cloak.Ecto can encrypt/decrypt a binary field.","ref":"Plausible.Auth.TOTP.EncryptedBinary.html"},{"type":"module","title":"Plausible.Auth.TOTP.RecoveryCode","doc":"Schema for TOTP recovery codes.","ref":"Plausible.Auth.TOTP.RecoveryCode.html"},{"type":"function","title":"Plausible.Auth.TOTP.RecoveryCode.changeset/2","doc":"","ref":"Plausible.Auth.TOTP.RecoveryCode.html#changeset/2"},{"type":"function","title":"Plausible.Auth.TOTP.RecoveryCode.changeset_to_map/2","doc":"","ref":"Plausible.Auth.TOTP.RecoveryCode.html#changeset_to_map/2"},{"type":"function","title":"Plausible.Auth.TOTP.RecoveryCode.generate_codes/1","doc":"Generates `count` unique recovery codes, each alphanumeric\nand 10 characters long.","ref":"Plausible.Auth.TOTP.RecoveryCode.html#generate_codes/1"},{"type":"function","title":"Plausible.Auth.TOTP.RecoveryCode.match?/2","doc":"","ref":"Plausible.Auth.TOTP.RecoveryCode.html#match?/2"},{"type":"type","title":"Plausible.Auth.TOTP.RecoveryCode.t/0","doc":"","ref":"Plausible.Auth.TOTP.RecoveryCode.html#t:t/0"},{"type":"module","title":"Plausible.Auth.TOTP.Vault","doc":"Provides a vault that will be used to encrypt/decrypt the TOTP secrets of users who enable it.","ref":"Plausible.Auth.TOTP.Vault.html"},{"type":"function","title":"Plausible.Auth.TOTP.Vault.child_spec/1","doc":"Returns a specification to start this module under a supervisor.\n\nSee `Supervisor`.","ref":"Plausible.Auth.TOTP.Vault.html#child_spec/1"},{"type":"function","title":"Plausible.Auth.TOTP.Vault.start_link/1","doc":"","ref":"Plausible.Auth.TOTP.Vault.html#start_link/1"},{"type":"module","title":"Plausible.Auth.Token","doc":"","ref":"Plausible.Auth.Token.html"},{"type":"function","title":"Plausible.Auth.Token.sign_password_reset/1","doc":"","ref":"Plausible.Auth.Token.html#sign_password_reset/1"},{"type":"function","title":"Plausible.Auth.Token.sign_shared_link/1","doc":"","ref":"Plausible.Auth.Token.html#sign_shared_link/1"},{"type":"function","title":"Plausible.Auth.Token.verify_password_reset/1","doc":"","ref":"Plausible.Auth.Token.html#verify_password_reset/1"},{"type":"function","title":"Plausible.Auth.Token.verify_shared_link/1","doc":"","ref":"Plausible.Auth.Token.html#verify_shared_link/1"},{"type":"module","title":"Plausible.Auth.User","doc":"","ref":"Plausible.Auth.User.html"},{"type":"function","title":"Plausible.Auth.User.cancel_email_changeset/1","doc":"","ref":"Plausible.Auth.User.html#cancel_email_changeset/1"},{"type":"function","title":"Plausible.Auth.User.changeset/2","doc":"","ref":"Plausible.Auth.User.html#changeset/2"},{"type":"function","title":"Plausible.Auth.User.email_changeset/2","doc":"","ref":"Plausible.Auth.User.html#email_changeset/2"},{"type":"function","title":"Plausible.Auth.User.end_trial/1","doc":"","ref":"Plausible.Auth.User.html#end_trial/1"},{"type":"function","title":"Plausible.Auth.User.hash_password/1","doc":"","ref":"Plausible.Auth.User.html#hash_password/1"},{"type":"function","title":"Plausible.Auth.User.new/1","doc":"","ref":"Plausible.Auth.User.html#new/1"},{"type":"function","title":"Plausible.Auth.User.password_strength/1","doc":"","ref":"Plausible.Auth.User.html#password_strength/1"},{"type":"function","title":"Plausible.Auth.User.profile_img_url/1","doc":"","ref":"Plausible.Auth.User.html#profile_img_url/1"},{"type":"function","title":"Plausible.Auth.User.remove_trial_expiry/1","doc":"","ref":"Plausible.Auth.User.html#remove_trial_expiry/1"},{"type":"function","title":"Plausible.Auth.User.set_password/2","doc":"","ref":"Plausible.Auth.User.html#set_password/2"},{"type":"function","title":"Plausible.Auth.User.settings_changeset/2","doc":"","ref":"Plausible.Auth.User.html#settings_changeset/2"},{"type":"function","title":"Plausible.Auth.User.start_trial/1","doc":"","ref":"Plausible.Auth.User.html#start_trial/1"},{"type":"function","title":"Plausible.Auth.User.subscription_accept_traffic_until_offset_days/0","doc":"","ref":"Plausible.Auth.User.html#subscription_accept_traffic_until_offset_days/0"},{"type":"function","title":"Plausible.Auth.User.trial_accept_traffic_until_offset_days/0","doc":"","ref":"Plausible.Auth.User.html#trial_accept_traffic_until_offset_days/0"},{"type":"type","title":"Plausible.Auth.User.t/0","doc":"","ref":"Plausible.Auth.User.html#t:t/0"},{"type":"module","title":"Plausible.Auth.UserAdmin","doc":"","ref":"Plausible.Auth.UserAdmin.html"},{"type":"function","title":"Plausible.Auth.UserAdmin.custom_index_query/3","doc":"","ref":"Plausible.Auth.UserAdmin.html#custom_index_query/3"},{"type":"function","title":"Plausible.Auth.UserAdmin.delete/2","doc":"","ref":"Plausible.Auth.UserAdmin.html#delete/2"},{"type":"function","title":"Plausible.Auth.UserAdmin.disable_2fa/1","doc":"","ref":"Plausible.Auth.UserAdmin.html#disable_2fa/1"},{"type":"function","title":"Plausible.Auth.UserAdmin.form_fields/1","doc":"","ref":"Plausible.Auth.UserAdmin.html#form_fields/1"},{"type":"function","title":"Plausible.Auth.UserAdmin.index/1","doc":"","ref":"Plausible.Auth.UserAdmin.html#index/1"},{"type":"function","title":"Plausible.Auth.UserAdmin.resource_actions/1","doc":"","ref":"Plausible.Auth.UserAdmin.html#resource_actions/1"},{"type":"module","title":"Plausible.Auth.UserSession","doc":"Schema for storing user session data.","ref":"Plausible.Auth.UserSession.html"},{"type":"type","title":"Plausible.Auth.UserSession.t/0","doc":"","ref":"Plausible.Auth.UserSession.html#t:t/0"},{"type":"module","title":"Plausible.Billing","doc":"","ref":"Plausible.Billing.html"},{"type":"function","title":"Plausible.Billing.active_subscription_for/1","doc":"","ref":"Plausible.Billing.html#active_subscription_for/1"},{"type":"function","title":"Plausible.Billing.cancelled_subscription_notice_dismiss_id/1","doc":"","ref":"Plausible.Billing.html#cancelled_subscription_notice_dismiss_id/1"},{"type":"function","title":"Plausible.Billing.change_plan/2","doc":"","ref":"Plausible.Billing.html#change_plan/2"},{"type":"function","title":"Plausible.Billing.change_plan_preview/2","doc":"","ref":"Plausible.Billing.html#change_plan_preview/2"},{"type":"function","title":"Plausible.Billing.check_needs_to_upgrade/1","doc":"","ref":"Plausible.Billing.html#check_needs_to_upgrade/1"},{"type":"function","title":"Plausible.Billing.format_price/1","doc":"","ref":"Plausible.Billing.html#format_price/1"},{"type":"function","title":"Plausible.Billing.has_active_subscription?/1","doc":"","ref":"Plausible.Billing.html#has_active_subscription?/1"},{"type":"function","title":"Plausible.Billing.paddle_api/0","doc":"","ref":"Plausible.Billing.html#paddle_api/0"},{"type":"function","title":"Plausible.Billing.subscription_cancelled/1","doc":"","ref":"Plausible.Billing.html#subscription_cancelled/1"},{"type":"function","title":"Plausible.Billing.subscription_created/1","doc":"","ref":"Plausible.Billing.html#subscription_created/1"},{"type":"function","title":"Plausible.Billing.subscription_payment_succeeded/1","doc":"","ref":"Plausible.Billing.html#subscription_payment_succeeded/1"},{"type":"function","title":"Plausible.Billing.subscription_updated/1","doc":"","ref":"Plausible.Billing.html#subscription_updated/1"},{"type":"module","title":"Plausible.Billing.Ecto.Feature","doc":"Ecto type representing a feature. Features are cast and stored in the\ndatabase as strings and loaded as modules, for example: `\"props\"` is loaded\nas `Plausible.Billing.Feature.Props`.","ref":"Plausible.Billing.Ecto.Feature.html"},{"type":"function","title":"Plausible.Billing.Ecto.Feature.cast/1","doc":"","ref":"Plausible.Billing.Ecto.Feature.html#cast/1"},{"type":"function","title":"Plausible.Billing.Ecto.Feature.dump/1","doc":"","ref":"Plausible.Billing.Ecto.Feature.html#dump/1"},{"type":"function","title":"Plausible.Billing.Ecto.Feature.embed_as/1","doc":"","ref":"Plausible.Billing.Ecto.Feature.html#embed_as/1"},{"type":"function","title":"Plausible.Billing.Ecto.Feature.equal?/2","doc":"","ref":"Plausible.Billing.Ecto.Feature.html#equal?/2"},{"type":"function","title":"Plausible.Billing.Ecto.Feature.load/1","doc":"","ref":"Plausible.Billing.Ecto.Feature.html#load/1"},{"type":"function","title":"Plausible.Billing.Ecto.Feature.type/0","doc":"","ref":"Plausible.Billing.Ecto.Feature.html#type/0"},{"type":"module","title":"Plausible.Billing.Ecto.FeatureList","doc":"Ecto type representing a list of features. This is a proxy for \n`{:array, Plausible.Billing.Ecto.Feature}` and is required for Kaffy to\nrender the HTML input correctly.","ref":"Plausible.Billing.Ecto.FeatureList.html"},{"type":"function","title":"Plausible.Billing.Ecto.FeatureList.cast/1","doc":"","ref":"Plausible.Billing.Ecto.FeatureList.html#cast/1"},{"type":"function","title":"Plausible.Billing.Ecto.FeatureList.dump/1","doc":"","ref":"Plausible.Billing.Ecto.FeatureList.html#dump/1"},{"type":"function","title":"Plausible.Billing.Ecto.FeatureList.embed_as/1","doc":"","ref":"Plausible.Billing.Ecto.FeatureList.html#embed_as/1"},{"type":"function","title":"Plausible.Billing.Ecto.FeatureList.equal?/2","doc":"","ref":"Plausible.Billing.Ecto.FeatureList.html#equal?/2"},{"type":"function","title":"Plausible.Billing.Ecto.FeatureList.load/1","doc":"","ref":"Plausible.Billing.Ecto.FeatureList.html#load/1"},{"type":"function","title":"Plausible.Billing.Ecto.FeatureList.render_form/5","doc":"","ref":"Plausible.Billing.Ecto.FeatureList.html#render_form/5"},{"type":"function","title":"Plausible.Billing.Ecto.FeatureList.type/0","doc":"","ref":"Plausible.Billing.Ecto.FeatureList.html#type/0"},{"type":"module","title":"Plausible.Billing.Ecto.Limit","doc":"Ecto type representing a limit, that can be either a number or unlimited.\nUnlimited is dumped to the database as `-1` and loaded as `:unlimited` to\nkeep compatibility with the rest of the codebase.","ref":"Plausible.Billing.Ecto.Limit.html"},{"type":"function","title":"Plausible.Billing.Ecto.Limit.cast/1","doc":"","ref":"Plausible.Billing.Ecto.Limit.html#cast/1"},{"type":"function","title":"Plausible.Billing.Ecto.Limit.dump/1","doc":"","ref":"Plausible.Billing.Ecto.Limit.html#dump/1"},{"type":"function","title":"Plausible.Billing.Ecto.Limit.embed_as/1","doc":"","ref":"Plausible.Billing.Ecto.Limit.html#embed_as/1"},{"type":"function","title":"Plausible.Billing.Ecto.Limit.equal?/2","doc":"","ref":"Plausible.Billing.Ecto.Limit.html#equal?/2"},{"type":"function","title":"Plausible.Billing.Ecto.Limit.load/1","doc":"","ref":"Plausible.Billing.Ecto.Limit.html#load/1"},{"type":"function","title":"Plausible.Billing.Ecto.Limit.render_form/5","doc":"","ref":"Plausible.Billing.Ecto.Limit.html#render_form/5"},{"type":"function","title":"Plausible.Billing.Ecto.Limit.type/0","doc":"","ref":"Plausible.Billing.Ecto.Limit.html#type/0"},{"type":"module","title":"Plausible.Billing.EnterprisePlan","doc":"","ref":"Plausible.Billing.EnterprisePlan.html"},{"type":"function","title":"Plausible.Billing.EnterprisePlan.changeset/2","doc":"","ref":"Plausible.Billing.EnterprisePlan.html#changeset/2"},{"type":"module","title":"Plausible.Billing.EnterprisePlanAdmin","doc":"","ref":"Plausible.Billing.EnterprisePlanAdmin.html"},{"type":"function","title":"Plausible.Billing.EnterprisePlanAdmin.create_changeset/2","doc":"","ref":"Plausible.Billing.EnterprisePlanAdmin.html#create_changeset/2"},{"type":"function","title":"Plausible.Billing.EnterprisePlanAdmin.custom_index_query/3","doc":"","ref":"Plausible.Billing.EnterprisePlanAdmin.html#custom_index_query/3"},{"type":"function","title":"Plausible.Billing.EnterprisePlanAdmin.form_fields/1","doc":"","ref":"Plausible.Billing.EnterprisePlanAdmin.html#form_fields/1"},{"type":"function","title":"Plausible.Billing.EnterprisePlanAdmin.index/1","doc":"","ref":"Plausible.Billing.EnterprisePlanAdmin.html#index/1"},{"type":"function","title":"Plausible.Billing.EnterprisePlanAdmin.search_fields/1","doc":"","ref":"Plausible.Billing.EnterprisePlanAdmin.html#search_fields/1"},{"type":"function","title":"Plausible.Billing.EnterprisePlanAdmin.update_changeset/2","doc":"","ref":"Plausible.Billing.EnterprisePlanAdmin.html#update_changeset/2"},{"type":"behaviour","title":"Plausible.Billing.Feature","doc":"This module provides an interface for managing features, e.g. Revenue Goals,\nFunnels and Custom Properties.\n\nFeature modules have functions for toggling the feature on/off and checking\nwhether the feature is available for a site/user.\n\nWhen defining new features, the following options are expected by the\n`__using__` macro:\n\n * `:name` - an atom representing the feature name in the plan JSON\n file (see also Plausible.Billing.Plan).\n\n * `:display_name` - human-readable display name of the feature\n\n * `:toggle_field` - the field in the %Plausible.Site{} schema that toggles\n the feature. If `nil` or not set, toggle/2 silently returns `:ok`\n\n * `:free` - if set to `true`, makes the `check_availability/1` function\n always return `:ok` (no matter the user's subscription status)\n\nFunctions defined by `__using__` can be overridden if needed.","ref":"Plausible.Billing.Feature.html"},{"type":"callback","title":"Plausible.Billing.Feature.check_availability/1","doc":"Checks whether the site owner or the user plan includes the given feature.","ref":"Plausible.Billing.Feature.html#c:check_availability/1"},{"type":"callback","title":"Plausible.Billing.Feature.display_name/0","doc":"Returns the human-readable display name of the feature.","ref":"Plausible.Billing.Feature.html#c:display_name/0"},{"type":"callback","title":"Plausible.Billing.Feature.enabled?/1","doc":"Checks whether a feature is enabled or not. Returns false when the feature is\ndisabled or the user does not have access to it.","ref":"Plausible.Billing.Feature.html#c:enabled?/1"},{"type":"callback","title":"Plausible.Billing.Feature.free?/0","doc":"Returns whether the feature is free to use or not.","ref":"Plausible.Billing.Feature.html#c:free?/0"},{"type":"function","title":"Plausible.Billing.Feature.list/0","doc":"Lists all available feature modules.","ref":"Plausible.Billing.Feature.html#list/0"},{"type":"macro","title":"Plausible.Billing.Feature.list_short_names/0","doc":"Lists all the feature short names, e.g. RevenueGoals","ref":"Plausible.Billing.Feature.html#list_short_names/0"},{"type":"callback","title":"Plausible.Billing.Feature.name/0","doc":"Returns the atom representing the feature name in the plan JSON file.","ref":"Plausible.Billing.Feature.html#c:name/0"},{"type":"callback","title":"Plausible.Billing.Feature.opted_out?/1","doc":"Returns whether the site explicitly opted out of the feature. This function\nis different from enabled/1, because enabled/1 returns false when the site\nowner does not have access to the feature.","ref":"Plausible.Billing.Feature.html#c:opted_out?/1"},{"type":"callback","title":"Plausible.Billing.Feature.toggle/2","doc":"Toggles the feature on and off for a site. Returns\n`{:error, :upgrade_required}` when toggling a feature the site owner does not\nhave access to.","ref":"Plausible.Billing.Feature.html#c:toggle/2"},{"type":"callback","title":"Plausible.Billing.Feature.toggle_field/0","doc":"Returns the %Plausible.Site{} field that toggles the feature on and off.","ref":"Plausible.Billing.Feature.html#c:toggle_field/0"},{"type":"type","title":"Plausible.Billing.Feature.t/0","doc":"","ref":"Plausible.Billing.Feature.html#t:t/0"},{"type":"module","title":"Plausible.Billing.PaddleApi","doc":"","ref":"Plausible.Billing.PaddleApi.html"},{"type":"function","title":"Plausible.Billing.PaddleApi.checkout_domain/0","doc":"","ref":"Plausible.Billing.PaddleApi.html#checkout_domain/0"},{"type":"function","title":"Plausible.Billing.PaddleApi.fetch_prices/2","doc":"","ref":"Plausible.Billing.PaddleApi.html#fetch_prices/2"},{"type":"function","title":"Plausible.Billing.PaddleApi.get_invoices/1","doc":"","ref":"Plausible.Billing.PaddleApi.html#get_invoices/1"},{"type":"function","title":"Plausible.Billing.PaddleApi.get_subscription/1","doc":"","ref":"Plausible.Billing.PaddleApi.html#get_subscription/1"},{"type":"function","title":"Plausible.Billing.PaddleApi.update_subscription/2","doc":"","ref":"Plausible.Billing.PaddleApi.html#update_subscription/2"},{"type":"function","title":"Plausible.Billing.PaddleApi.update_subscription_preview/2","doc":"","ref":"Plausible.Billing.PaddleApi.html#update_subscription_preview/2"},{"type":"function","title":"Plausible.Billing.PaddleApi.vendors_domain/0","doc":"","ref":"Plausible.Billing.PaddleApi.html#vendors_domain/0"},{"type":"module","title":"Plausible.Billing.Plans","doc":"","ref":"Plausible.Billing.Plans.html"},{"type":"function","title":"Plausible.Billing.Plans.all/0","doc":"","ref":"Plausible.Billing.Plans.html#all/0"},{"type":"function","title":"Plausible.Billing.Plans.available_plans_for/2","doc":"","ref":"Plausible.Billing.Plans.html#available_plans_for/2"},{"type":"function","title":"Plausible.Billing.Plans.business_plans_for/1","doc":"","ref":"Plausible.Billing.Plans.html#business_plans_for/1"},{"type":"function","title":"Plausible.Billing.Plans.business_tier?/1","doc":"","ref":"Plausible.Billing.Plans.html#business_tier?/1"},{"type":"function","title":"Plausible.Billing.Plans.business_tier_launch/0","doc":"","ref":"Plausible.Billing.Plans.html#business_tier_launch/0"},{"type":"function","title":"Plausible.Billing.Plans.find/1","doc":"","ref":"Plausible.Billing.Plans.html#find/1"},{"type":"function","title":"Plausible.Billing.Plans.get_price_for/2","doc":"","ref":"Plausible.Billing.Plans.html#get_price_for/2"},{"type":"function","title":"Plausible.Billing.Plans.get_regular_plan/2","doc":"","ref":"Plausible.Billing.Plans.html#get_regular_plan/2"},{"type":"function","title":"Plausible.Billing.Plans.get_subscription_plan/1","doc":"","ref":"Plausible.Billing.Plans.html#get_subscription_plan/1"},{"type":"function","title":"Plausible.Billing.Plans.growth_plans_for/1","doc":"Returns a list of growth plans available for the user to choose.\n\nAs new versions of plans are introduced, users who were on old plans can\nstill choose from old plans.","ref":"Plausible.Billing.Plans.html#growth_plans_for/1"},{"type":"function","title":"Plausible.Billing.Plans.latest_enterprise_plan_with_price/2","doc":"","ref":"Plausible.Billing.Plans.html#latest_enterprise_plan_with_price/2"},{"type":"function","title":"Plausible.Billing.Plans.subscription_interval/1","doc":"","ref":"Plausible.Billing.Plans.html#subscription_interval/1"},{"type":"function","title":"Plausible.Billing.Plans.suggest/2","doc":"Returns the most appropriate plan for a user based on their usage during a\ngiven cycle.\n\nIf the usage during the cycle exceeds the enterprise-level threshold, or if\nthe user already belongs to an enterprise plan, it suggests the :enterprise\nplan.\n\nOtherwise, it recommends the plan where the cycle usage falls just under the\nplan's limit from the available options for the user.","ref":"Plausible.Billing.Plans.html#suggest/2"},{"type":"function","title":"Plausible.Billing.Plans.with_prices/2","doc":"This function takes a list of plans as an argument, gathers all product\nIDs in a single list, and makes an API call to Paddle. After a successful\nresponse, fills in the `monthly_cost` and `yearly_cost` fields for each\ngiven plan and returns the new list of plans with completed information.","ref":"Plausible.Billing.Plans.html#with_prices/2"},{"type":"function","title":"Plausible.Billing.Plans.yearly_product_ids/0","doc":"List yearly plans product IDs.","ref":"Plausible.Billing.Plans.html#yearly_product_ids/0"},{"type":"module","title":"Plausible.Billing.Quota","doc":"This module provides functions to work with plans usage and limits.","ref":"Plausible.Billing.Quota.html"},{"type":"function","title":"Plausible.Billing.Quota.below_limit?/2","doc":"Returns whether the usage is below the limit or not.\nReturns false if usage is equal to the limit.","ref":"Plausible.Billing.Quota.html#below_limit?/2"},{"type":"function","title":"Plausible.Billing.Quota.eligible_for_upgrade?/1","doc":"","ref":"Plausible.Billing.Quota.html#eligible_for_upgrade?/1"},{"type":"function","title":"Plausible.Billing.Quota.ensure_can_add_new_site/1","doc":"Enterprise plans are always allowed to add more sites (even when\nover limit) to avoid service disruption. Their usage is checked\nin a background job instead (see `check_usage.ex`).","ref":"Plausible.Billing.Quota.html#ensure_can_add_new_site/1"},{"type":"function","title":"Plausible.Billing.Quota.ensure_feature_access/2","doc":"","ref":"Plausible.Billing.Quota.html#ensure_feature_access/2"},{"type":"function","title":"Plausible.Billing.Quota.ensure_within_plan_limits/3","doc":"Ensures that the given user (or the usage map) is within the limits\nof the given plan.\n\nAn `opts` argument can be passed with `ignore_pageview_limit: true`\nwhich bypasses the pageview limit check and returns `:ok` as long as\nthe other limits are not exceeded.","ref":"Plausible.Billing.Quota.html#ensure_within_plan_limits/3"},{"type":"function","title":"Plausible.Billing.Quota.exceeded_cycles/2","doc":"","ref":"Plausible.Billing.Quota.html#exceeded_cycles/2"},{"type":"function","title":"Plausible.Billing.Quota.exceeds_last_two_usage_cycles?/2","doc":"","ref":"Plausible.Billing.Quota.html#exceeds_last_two_usage_cycles?/2"},{"type":"function","title":"Plausible.Billing.Quota.suggest_tier/3","doc":"Suggests a suitable tier (Growth or Business) for the given usage map.\n\nIf even the highest Business plan does not accommodate the usage, then\n`:custom` is returned. This means that this kind of usage should get on\na custom plan.\n\n`nil` is returned if the usage is not eligible for upgrade.","ref":"Plausible.Billing.Quota.html#suggest_tier/3"},{"type":"function","title":"Plausible.Billing.Quota.within_limit?/2","doc":"Returns whether the usage is within the limit or not.\nReturns true if usage is equal to the limit.","ref":"Plausible.Billing.Quota.html#within_limit?/2"},{"type":"module","title":"Plausible.Billing.SiteLocker","doc":"","ref":"Plausible.Billing.SiteLocker.html"},{"type":"function","title":"Plausible.Billing.SiteLocker.send_grace_period_end_email/1","doc":"","ref":"Plausible.Billing.SiteLocker.html#send_grace_period_end_email/1"},{"type":"function","title":"Plausible.Billing.SiteLocker.set_lock_status_for/2","doc":"","ref":"Plausible.Billing.SiteLocker.html#set_lock_status_for/2"},{"type":"function","title":"Plausible.Billing.SiteLocker.update_sites_for/2","doc":"","ref":"Plausible.Billing.SiteLocker.html#update_sites_for/2"},{"type":"type","title":"Plausible.Billing.SiteLocker.lock_reason/0","doc":"","ref":"Plausible.Billing.SiteLocker.html#t:lock_reason/0"},{"type":"type","title":"Plausible.Billing.SiteLocker.update_opt/0","doc":"","ref":"Plausible.Billing.SiteLocker.html#t:update_opt/0"},{"type":"module","title":"Plausible.Billing.Subscription.Status","doc":"The subscription statuses are stored in Paddle. They can only be changed\nthrough Paddle webhooks, which always send the current subscription status\nvia the payload.\n\n* `active` - All good with the payments. Can access stats.\n\n* `past_due` - The payment has failed, but we're trying to charge the customer\n again. Access to stats is still granted. There will be three retries - after\n 3, 5, and 7 days have passed from the first failure. After a failure on the\n final retry, the subscription status will change to `paused`. As soon as the\n customer updates their billing details, Paddle will charge them again, and\n after a successful payment, the subscription will become `active` again.\n\n* `paused` - we've tried to charge the customer but all the retries have failed.\n Stats access restricted. As soon as the customer updates their billing details,\n Paddle will charge them again, and after a successful payment, the subscription\n will become `active` again.\n\n* `deleted` - The customer has triggered the cancel subscription action. Access\n to stats should be granted for the time the customer has already paid for. If\n they want to upgrade again, new billing details have to be provided.\n\nPaddle documentation links for reference:\n\n* Subscription statuses -\n https://developer.paddle.com/classic/reference/zg9joji1mzu0mdi2-subscription-status-reference\n\n* Payment failures -\n https://developer.paddle.com/classic/guides/zg9joji1mzu0mduy-payment-failures","ref":"Plausible.Billing.Subscription.Status.html"},{"type":"macro","title":"Plausible.Billing.Subscription.Status.active/0","doc":"","ref":"Plausible.Billing.Subscription.Status.html#active/0"},{"type":"function","title":"Plausible.Billing.Subscription.Status.active?/1","doc":"","ref":"Plausible.Billing.Subscription.Status.html#active?/1"},{"type":"macro","title":"Plausible.Billing.Subscription.Status.deleted/0","doc":"","ref":"Plausible.Billing.Subscription.Status.html#deleted/0"},{"type":"function","title":"Plausible.Billing.Subscription.Status.deleted?/1","doc":"","ref":"Plausible.Billing.Subscription.Status.html#deleted?/1"},{"type":"macro","title":"Plausible.Billing.Subscription.Status.in?/2","doc":"","ref":"Plausible.Billing.Subscription.Status.html#in?/2"},{"type":"macro","title":"Plausible.Billing.Subscription.Status.past_due/0","doc":"","ref":"Plausible.Billing.Subscription.Status.html#past_due/0"},{"type":"function","title":"Plausible.Billing.Subscription.Status.past_due?/1","doc":"","ref":"Plausible.Billing.Subscription.Status.html#past_due?/1"},{"type":"macro","title":"Plausible.Billing.Subscription.Status.paused/0","doc":"","ref":"Plausible.Billing.Subscription.Status.html#paused/0"},{"type":"function","title":"Plausible.Billing.Subscription.Status.paused?/1","doc":"","ref":"Plausible.Billing.Subscription.Status.html#paused?/1"},{"type":"function","title":"Plausible.Billing.Subscription.Status.valid_statuses/0","doc":"","ref":"Plausible.Billing.Subscription.Status.html#valid_statuses/0"},{"type":"type","title":"Plausible.Billing.Subscription.Status.status/0","doc":"","ref":"Plausible.Billing.Subscription.Status.html#t:status/0"},{"type":"behaviour","title":"Plausible.Cache","doc":"Caching interface specific for Plausible. Usage:\n\n use Plausible.Cache\n\n # - Implement the callbacks required\n # - Optionally override `unwrap_cache_keys/1`\n # - Populate the cache with `Plausible.Cache.Warmer`\n\nServes as a wrapper around `Plausible.Cache.Adapter`, where the underlying\nimplementation can be transparently swapped.\n\nEven though normally the relevant Adapter processes are started, cache access is disabled\nduring tests via the `:plausible, Elixir.Plausible.Cache, enabled: bool()` application env key.\nThis can be overridden on case by case basis, using the child specs options.\n\nThe `base_db_query/0` callback is used to generate the base query that is \nexecuted on every cache refresh. \n\nThere are two modes of refresh operation: `:all` and `:updated_recently`;\nthe former will invoke the query as is and clear all the existing entries,\nwhile the latter will attempt to limit the query to only the records that \nhave been updated in the last 15 minutes and try to merge the new results with\nexisting cache entries.\n\nBoth refresh modes are normally executed periodically from within a warmer process;\nsee: `Plausible.Cache.Warmer`. The reason for two modes is that the latter is lighter \non the database and can be executed more frequently.\n\nWhen Cache is disabled via application env, the `get/1` function\nfalls back to pure database lookups (implemented via `get_from_source/1` callback. \nThis should help with introducing cached lookups in existing code, \nso that no existing tests should break.\n\nRefreshing the cache emits telemetry event defined as per `telemetry_event_refresh/2`.","ref":"Plausible.Cache.html"},{"type":"callback","title":"Plausible.Cache.base_db_query/0","doc":"Returns the base Ecto query used to refresh the cache","ref":"Plausible.Cache.html#c:base_db_query/0"},{"type":"callback","title":"Plausible.Cache.child_id/0","doc":"Supervisor child id, must be unique within the supervision tree","ref":"Plausible.Cache.html#c:child_id/0"},{"type":"callback","title":"Plausible.Cache.count_all/0","doc":"Counts all items at the source, an aggregate query most likely","ref":"Plausible.Cache.html#c:count_all/0"},{"type":"function","title":"Plausible.Cache.enabled?/0","doc":"Looks for application env value at `:plausible, Elixir.Plausible.Cache, enabled: bool()`","ref":"Plausible.Cache.html#enabled?/0"},{"type":"callback","title":"Plausible.Cache.get_from_source/1","doc":"Retrieves the item from the source, in case the cache is disabled","ref":"Plausible.Cache.html#c:get_from_source/1"},{"type":"callback","title":"Plausible.Cache.name/0","doc":"Unique cache name, used by underlying implementation","ref":"Plausible.Cache.html#c:name/0"},{"type":"callback","title":"Plausible.Cache.unwrap_cache_keys/1","doc":"Optionally unwraps the keys of the cache items, in case one item is stored under multiple keys","ref":"Plausible.Cache.html#c:unwrap_cache_keys/1"},{"type":"module","title":"Plausible.Cache.Adapter","doc":"Interface for the underlying cache implementation.\nCurrently: ConCache\n\nUsing the Adapter module directly, the user must ensure that the relevant\nprocesses are available to use, which is normally done via the child specification.","ref":"Plausible.Cache.Adapter.html"},{"type":"function","title":"Plausible.Cache.Adapter.child_spec/3","doc":"","ref":"Plausible.Cache.Adapter.html#child_spec/3"},{"type":"function","title":"Plausible.Cache.Adapter.delete/2","doc":"","ref":"Plausible.Cache.Adapter.html#delete/2"},{"type":"function","title":"Plausible.Cache.Adapter.fetch/3","doc":"","ref":"Plausible.Cache.Adapter.html#fetch/3"},{"type":"function","title":"Plausible.Cache.Adapter.get/2","doc":"","ref":"Plausible.Cache.Adapter.html#get/2"},{"type":"function","title":"Plausible.Cache.Adapter.get/3","doc":"","ref":"Plausible.Cache.Adapter.html#get/3"},{"type":"function","title":"Plausible.Cache.Adapter.keys/1","doc":"","ref":"Plausible.Cache.Adapter.html#keys/1"},{"type":"function","title":"Plausible.Cache.Adapter.put/3","doc":"","ref":"Plausible.Cache.Adapter.html#put/3"},{"type":"function","title":"Plausible.Cache.Adapter.put_many/2","doc":"","ref":"Plausible.Cache.Adapter.html#put_many/2"},{"type":"function","title":"Plausible.Cache.Adapter.size/1","doc":"","ref":"Plausible.Cache.Adapter.html#size/1"},{"type":"module","title":"Plausible.Cache.Stats","doc":"Keeps track of hit/miss ratio for various caches.","ref":"Plausible.Cache.Stats.html"},{"type":"function","title":"Plausible.Cache.Stats.bump/2","doc":"","ref":"Plausible.Cache.Stats.html#bump/2"},{"type":"function","title":"Plausible.Cache.Stats.child_spec/1","doc":"Returns a specification to start this module under a supervisor.\n\nSee `Supervisor`.","ref":"Plausible.Cache.Stats.html#child_spec/1"},{"type":"function","title":"Plausible.Cache.Stats.gather/1","doc":"","ref":"Plausible.Cache.Stats.html#gather/1"},{"type":"function","title":"Plausible.Cache.Stats.handle_telemetry_event/4","doc":"","ref":"Plausible.Cache.Stats.html#handle_telemetry_event/4"},{"type":"function","title":"Plausible.Cache.Stats.hit_rate/1","doc":"","ref":"Plausible.Cache.Stats.html#hit_rate/1"},{"type":"function","title":"Plausible.Cache.Stats.init/1","doc":"","ref":"Plausible.Cache.Stats.html#init/1"},{"type":"function","title":"Plausible.Cache.Stats.size/1","doc":"","ref":"Plausible.Cache.Stats.html#size/1"},{"type":"function","title":"Plausible.Cache.Stats.start_link/1","doc":"","ref":"Plausible.Cache.Stats.html#start_link/1"},{"type":"module","title":"Plausible.Cache.Warmer","doc":"A periodic cache warmer.\n\nChild specification options available:\n\n * `cache_impl` - module expected to implement `Plausible.Cache` behaviour\n * `interval` - the number of milliseconds for each warm-up cycle\n * `cache_name` - defaults to cache_impl.name() but can be overridden for testing\n * `force_start?` - enforcess process startup for testing, even if it's barred\n by `Plausible.Cache.enabled?`. This is useful for avoiding issues with DB ownership\n and async tests.\n * `warmer_fn` - by convention, either `:refresh_all` or `:refresh_updated_recently`,\n both are automatically provided by `cache_impl` module. Technically any exported\n or captured function will work, if need be.\n\nSee tests for more comprehensive examples.","ref":"Plausible.Cache.Warmer.html"},{"type":"function","title":"Plausible.Cache.Warmer.child_spec/1","doc":"","ref":"Plausible.Cache.Warmer.html#child_spec/1"},{"type":"module","title":"Plausible.ChangesetHelpers","doc":"Helper function for working with Ecto changesets","ref":"Plausible.ChangesetHelpers.html"},{"type":"function","title":"Plausible.ChangesetHelpers.traverse_errors/1","doc":"","ref":"Plausible.ChangesetHelpers.html#traverse_errors/1"},{"type":"module","title":"Plausible.Cldr","doc":"Provides the core functions to retrieve and manage\nthe CLDR data that supports formatting and localisation.\n\nIt provides the core functions to access formatted\nCLDR data, set and retrieve a current locale and validate\ncertain core data types such as locales, currencies and\nterritories.","ref":"Plausible.Cldr.html"},{"type":"function","title":"Plausible.Cldr.available_locale_name?/1","doc":"","ref":"Plausible.Cldr.html#available_locale_name?/1"},{"type":"function","title":"Plausible.Cldr.default_locale/0","doc":"Returns the default `locale`.","ref":"Plausible.Cldr.html#default_locale/0"},{"type":"function","title":"Example - Plausible.Cldr.default_locale/0","doc":"iex> Plausible.Cldr.default_locale()\n %Cldr.LanguageTag{\n backend: Plausible.Cldr,\n canonical_locale_name: \"en-001\",\n cldr_locale_name: :\"en-001\",\n language_subtags: [],\n extensions: %{},\n gettext_locale_name: \"en\",\n language: \"en\",\n locale: %{},\n private_use: [],\n rbnf_locale_name: :en,\n requested_locale_name: \"en-001\",\n script: :Latn,\n territory: :\"001\",\n transform: %{},\n language_variants: []\n }","ref":"Plausible.Cldr.html#default_locale/0-example"},{"type":"function","title":"Plausible.Cldr.default_territory/0","doc":"Returns the default territory when a locale\ndoes not specify one and none can be inferred.","ref":"Plausible.Cldr.html#default_territory/0"},{"type":"function","title":"Example - Plausible.Cldr.default_territory/0","doc":"iex> Plausible.Cldr.default_territory()\n :\"001\"","ref":"Plausible.Cldr.html#default_territory/0-example"},{"type":"function","title":"Plausible.Cldr.ellipsis/2","doc":"Add locale-specific ellipsis to a string.","ref":"Plausible.Cldr.html#ellipsis/2"},{"type":"function","title":"Arguments - Plausible.Cldr.ellipsis/2","doc":"* `string` is any `String.t` or a 2-element list\n of `String.t` between which the ellipsis is inserted.\n\n* `backend` is any module that includes `use Cldr` and therefore\n is a `Cldr` backend module. The default is `Cldr.default_backend!/0`.\n Note that `Cldr.default_backend!/0` will raise an exception if\n no `:default_backend` is configured under the `:ex_cldr` key in\n `config.exs`.\n\n* `options` is a keyword list of options","ref":"Plausible.Cldr.html#ellipsis/2-arguments"},{"type":"function","title":"Options - Plausible.Cldr.ellipsis/2","doc":"* `:locale` is any valid locale name returned by `Cldr.known_locale_names/1`.\n The default is `Cldr.get_locale/0`.\n\n* `:location` determines where to place the ellipsis. The options are\n `:after` (the default for a single string argument), `:between`\n (the default and only valid location for an argument that is a list\n of two strings) and `:before`.\n\n* `:format` formats based upon whether the ellipsis\n is inserted between words or sentences. The valid options are\n `:word` or `:sentence`. The default is `:sentence`.","ref":"Plausible.Cldr.html#ellipsis/2-options"},{"type":"function","title":"Examples - Plausible.Cldr.ellipsis/2","doc":"iex> Plausible.Cldr.ellipsis(\"And furthermore\")\n \"And furthermore…\"\n\n iex> Plausible.Cldr.ellipsis([\"And furthermore\", \"there is much to be done\"], locale: :ja)\n \"And furthermore…there is much to be done\"\n\n iex> Plausible.Cldr.ellipsis(\"And furthermore\", format: :word)\n \"And furthermore …\"\n\n iex> Plausible.Cldr.ellipsis([\"And furthermore\", \"there is much to be done\"], locale: :ja, format: :word)\n \"And furthermore … there is much to be done\"","ref":"Plausible.Cldr.html#ellipsis/2-examples"},{"type":"function","title":"Plausible.Cldr.get_locale/0","doc":"Return the current locale to be used for `Cldr` functions that\ntake an optional locale parameter for which a locale is not supplied.","ref":"Plausible.Cldr.html#get_locale/0"},{"type":"function","title":"Example - Plausible.Cldr.get_locale/0","doc":"iex> Plausible.Cldr.put_locale(\"pl\")\n iex> Plausible.Cldr.get_locale()\n %Cldr.LanguageTag{\n backend: Elixir.Plausible.Cldr,\n canonical_locale_name: \"pl\",\n cldr_locale_name: :pl,\n extensions: %{},\n language: \"pl\",\n locale: %{},\n private_use: [],\n rbnf_locale_name: :pl,\n territory: :PL,\n requested_locale_name: \"pl\",\n script: :Latn,\n transform: %{},\n language_variants: []\n }","ref":"Plausible.Cldr.html#get_locale/0-example"},{"type":"function","title":"Plausible.Cldr.known_calendars/0","doc":"","ref":"Plausible.Cldr.html#known_calendars/0"},{"type":"function","title":"Plausible.Cldr.known_currencies/0","doc":"","ref":"Plausible.Cldr.html#known_currencies/0"},{"type":"function","title":"Plausible.Cldr.known_gettext_locale_name/1","doc":"Returns either the Gettext `locale_name` in Cldr format or\n`false` based upon whether the locale name is configured in\n`Gettext`.","ref":"Plausible.Cldr.html#known_gettext_locale_name/1"},{"type":"function","title":"Arguments - Plausible.Cldr.known_gettext_locale_name/1","doc":"* `locale` is any valid locale name returned by\n `Plausible.Cldr.known_gettext_locale_names/0`","ref":"Plausible.Cldr.html#known_gettext_locale_name/1-arguments"},{"type":"function","title":"Examples - Plausible.Cldr.known_gettext_locale_name/1","doc":"iex> Plausible.Cldr.known_gettext_locale_name(\"en\")\n \"en\"\n\n iex> Plausible.Cldr.known_gettext_locale_name(\"en-SA\")\n false","ref":"Plausible.Cldr.html#known_gettext_locale_name/1-examples"},{"type":"function","title":"Plausible.Cldr.known_gettext_locale_name?/1","doc":"Returns a boolean indicating if the specified locale\nname is configured and available in Gettext.","ref":"Plausible.Cldr.html#known_gettext_locale_name?/1"},{"type":"function","title":"Arguments - Plausible.Cldr.known_gettext_locale_name?/1","doc":"* `locale` is any valid locale name returned by\n `Plausible.Cldr.known_locale_names/0`","ref":"Plausible.Cldr.html#known_gettext_locale_name?/1-arguments"},{"type":"function","title":"Examples - Plausible.Cldr.known_gettext_locale_name?/1","doc":"iex> Plausible.Cldr.known_gettext_locale_name?(\"en\")\n true\n\n iex> Plausible.Cldr.known_gettext_locale_name?(\"!!\")\n false","ref":"Plausible.Cldr.html#known_gettext_locale_name?/1-examples"},{"type":"function","title":"Plausible.Cldr.known_gettext_locale_names/0","doc":"Returns a list of Gettext locale names but in CLDR format with\nunderscore replaced by hyphen in order to facilitate comparisons\nwith `Cldr` locale names.","ref":"Plausible.Cldr.html#known_gettext_locale_names/0"},{"type":"function","title":"Plausible.Cldr.known_locale_name/1","doc":"Returns either the `locale_name` or `false` based upon\nwhether the locale name is configured in `Cldr`.\n\nThis is helpful when building a list of `or` expressions\nto return the first known locale name from a list.","ref":"Plausible.Cldr.html#known_locale_name/1"},{"type":"function","title":"Arguments - Plausible.Cldr.known_locale_name/1","doc":"* `locale` is any valid locale name returned by\n `Plausible.Cldr.known_locale_names/0`","ref":"Plausible.Cldr.html#known_locale_name/1-arguments"},{"type":"function","title":"Examples - Plausible.Cldr.known_locale_name/1","doc":"iex> Plausible.Cldr.known_locale_name(:\"en-AU\")\n :\"en-AU\"\n\n iex> Plausible.Cldr.known_locale_name(:\"en-SA\")\n false","ref":"Plausible.Cldr.html#known_locale_name/1-examples"},{"type":"function","title":"Plausible.Cldr.known_locale_name?/1","doc":"Returns a boolean indicating if the specified locale\nname is configured and available in Cldr.","ref":"Plausible.Cldr.html#known_locale_name?/1"},{"type":"function","title":"Arguments - Plausible.Cldr.known_locale_name?/1","doc":"* `locale` is any valid locale name returned by `Plausible.Cldr.known_locale_names/0`","ref":"Plausible.Cldr.html#known_locale_name?/1-arguments"},{"type":"function","title":"Examples - Plausible.Cldr.known_locale_name?/1","doc":"iex> Plausible.Cldr.known_locale_name?(:en)\n true\n\n iex> Plausible.Cldr.known_locale_name?(:\"!!\")\n false","ref":"Plausible.Cldr.html#known_locale_name?/1-examples"},{"type":"function","title":"Plausible.Cldr.known_locale_names/0","doc":"Returns a list of the known locale names.\n\nKnown locales are those locales which\nare the subset of all CLDR locales that\nhave been configured for use either\nin this module or in `Gettext`.","ref":"Plausible.Cldr.html#known_locale_names/0"},{"type":"function","title":"Plausible.Cldr.known_number_system_types/0","doc":"Returns a list of atoms representing the number systems types known to `Cldr`.","ref":"Plausible.Cldr.html#known_number_system_types/0"},{"type":"function","title":"Example - Plausible.Cldr.known_number_system_types/0","doc":"iex> Plausible.Cldr.known_number_system_types()\n [:default, :finance, :native, :traditional]","ref":"Plausible.Cldr.html#known_number_system_types/0-example"},{"type":"function","title":"Plausible.Cldr.known_number_systems/0","doc":"","ref":"Plausible.Cldr.html#known_number_systems/0"},{"type":"function","title":"Plausible.Cldr.known_rbnf_locale_name/1","doc":"Returns either the RBNF `locale_name` or `false` based upon\nwhether the locale name is configured in `Cldr`\nand has RBNF rules defined.","ref":"Plausible.Cldr.html#known_rbnf_locale_name/1"},{"type":"function","title":"Arguments - Plausible.Cldr.known_rbnf_locale_name/1","doc":"* `locale` is any valid locale name returned by\n `Plausible.Cldr.known_locale_names/0`","ref":"Plausible.Cldr.html#known_rbnf_locale_name/1-arguments"},{"type":"function","title":"Examples - Plausible.Cldr.known_rbnf_locale_name/1","doc":"iex> Plausible.Cldr.known_rbnf_locale_name(:en)\n :en\n\n iex> Plausible.Cldr.known_rbnf_locale_name(:\"en-SA\")\n false","ref":"Plausible.Cldr.html#known_rbnf_locale_name/1-examples"},{"type":"function","title":"Plausible.Cldr.known_rbnf_locale_name?/1","doc":"Returns a boolean indicating if the specified locale\nname is configured and available in Cldr and supports\nrules based number formats (RBNF).","ref":"Plausible.Cldr.html#known_rbnf_locale_name?/1"},{"type":"function","title":"Arguments - Plausible.Cldr.known_rbnf_locale_name?/1","doc":"* `locale` is any valid locale name returned by `Plausible.Cldr.known_locale_names/0`","ref":"Plausible.Cldr.html#known_rbnf_locale_name?/1-arguments"},{"type":"function","title":"Examples - Plausible.Cldr.known_rbnf_locale_name?/1","doc":"iex> Plausible.Cldr.known_rbnf_locale_name?(:en)\n true\n\n iex> Plausible.Cldr.known_rbnf_locale_name?(:\"!!\")\n false","ref":"Plausible.Cldr.html#known_rbnf_locale_name?/1-examples"},{"type":"function","title":"Plausible.Cldr.known_rbnf_locale_names/0","doc":"Returns a list of locale names which have rules-based number\nformats (RBNF).","ref":"Plausible.Cldr.html#known_rbnf_locale_names/0"},{"type":"function","title":"Plausible.Cldr.known_territories/0","doc":"","ref":"Plausible.Cldr.html#known_territories/0"},{"type":"function","title":"Plausible.Cldr.normalize_lenient_parse/3","doc":"Normalizes a string by applying transliteration\nof common symbols in numbers, currencies and dates","ref":"Plausible.Cldr.html#normalize_lenient_parse/3"},{"type":"function","title":"Plausible.Cldr.put_gettext_locale/1","doc":"Set the current process's Gettext locale from a\n`t:Cldr.LanguageTag`.","ref":"Plausible.Cldr.html#put_gettext_locale/1"},{"type":"function","title":"Arguments - Plausible.Cldr.put_gettext_locale/1","doc":"* `locale` is a `Cldr.LanguageTag` struct returned by `Cldr.Locale.new!/2`.","ref":"Plausible.Cldr.html#put_gettext_locale/1-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.put_gettext_locale/1","doc":"* `{:ok, gettext_locale_name}` or\n\n* `{:error, {exception, reason}}`","ref":"Plausible.Cldr.html#put_gettext_locale/1-returns"},{"type":"function","title":"Behaviour - Plausible.Cldr.put_gettext_locale/1","doc":"1. If the `locale.gettext_locale_name` is `nil` then an error\n is returned.\n\n2. The `gettext` locale for the `gettext_backend` configured for the\n CLDR backend defined by the `t:Cldr.LanguageTag` is set.","ref":"Plausible.Cldr.html#put_gettext_locale/1-behaviour"},{"type":"function","title":"Examples - Plausible.Cldr.put_gettext_locale/1","doc":"iex> import Cldr.LanguageTag.Sigil\n iex> Plausible.Cldr.put_gettext_locale(~l\"en\")\n {:ok, \"en\"}\n\n iex> import Cldr.LanguageTag.Sigil\n iex> Plausible.Cldr.put_gettext_locale(~l\"de\")\n {\n :error,\n {\n Cldr.UnknownLocaleError,\n \"Locale TestBackend.Cldr.Locale.new!(\\\"de-DE\\\") does not map to a known gettext locale name\"\n }\n }","ref":"Plausible.Cldr.html#put_gettext_locale/1-examples"},{"type":"function","title":"Plausible.Cldr.put_locale/1","doc":"Set the current locale to be used for `Cldr` functions that\ntake an optional locale parameter for which a locale is not supplied.","ref":"Plausible.Cldr.html#put_locale/1"},{"type":"function","title":"Arguments - Plausible.Cldr.put_locale/1","doc":"* `locale` is any valid locale name returned by `Plausible.Cldr.known_locale_names/0`\n or a `t:Cldr.LanguageTag` struct returned by `Plausible.Cldr.Locale.new!/1`\n\nSee [rfc5646](https://tools.ietf.org/html/rfc5646) for the specification\nof a language tag.","ref":"Plausible.Cldr.html#put_locale/1-arguments"},{"type":"function","title":"Examples - Plausible.Cldr.put_locale/1","doc":"iex> Plausible.Cldr.put_locale(\"en\")\n {:ok,\n %Cldr.LanguageTag{\n backend: Plausible.Cldr,\n canonical_locale_name: \"en\",\n cldr_locale_name: :en,\n language_subtags: [],\n extensions: %{},\n gettext_locale_name: \"en\",\n language: \"en\",\n locale: %{},\n private_use: [],\n rbnf_locale_name: :en,\n requested_locale_name: \"en\",\n script: :Latn,\n territory: :US,\n transform: %{},\n language_variants: []\n }}\n\n iex> Plausible.Cldr.put_locale(\"invalid-locale!\")\n {:error, {Cldr.LanguageTag.ParseError,\n \"Expected a BCP47 language tag. Could not parse the remaining \\\"!\\\" starting at position 15\"}}","ref":"Plausible.Cldr.html#put_locale/1-examples"},{"type":"function","title":"Plausible.Cldr.quote/2","doc":"Add locale-specific quotation marks around a string.","ref":"Plausible.Cldr.html#quote/2"},{"type":"function","title":"Arguments - Plausible.Cldr.quote/2","doc":"* `string` is any valid Elixir string\n\n* `options` is a keyword list of options","ref":"Plausible.Cldr.html#quote/2-arguments"},{"type":"function","title":"Options - Plausible.Cldr.quote/2","doc":"* `locale` is any valid locale name returned by `Cldr.known_locale_names/1`.\n The default is `Cldr.get_locale/0`","ref":"Plausible.Cldr.html#quote/2-options"},{"type":"function","title":"Examples - Plausible.Cldr.quote/2","doc":"iex> Plausible.Cldr.quote(\"Quoted String\")\n \"“Quoted String”\"\n\n iex> Plausible.Cldr.quote(\"Quoted String\", locale: :ja)\n \"「Quoted String」\"","ref":"Plausible.Cldr.html#quote/2-examples"},{"type":"function","title":"Plausible.Cldr.unknown_locale_names/0","doc":"Returns a list of the locales names that are configured,\nbut not known in CLDR.\n\nSince there is a compile-time exception raised if there are\nany unknown locales this function should always\nreturn an empty list.","ref":"Plausible.Cldr.html#unknown_locale_names/0"},{"type":"function","title":"Plausible.Cldr.validate_calendar/1","doc":"","ref":"Plausible.Cldr.html#validate_calendar/1"},{"type":"function","title":"Plausible.Cldr.validate_currency/1","doc":"","ref":"Plausible.Cldr.html#validate_currency/1"},{"type":"function","title":"Plausible.Cldr.validate_locale/1","doc":"Normalise and validate a locale name.","ref":"Plausible.Cldr.html#validate_locale/1"},{"type":"function","title":"Arguments - Plausible.Cldr.validate_locale/1","doc":"* `locale` is any valid locale name returned by `Plausible.Cldr.known_locale_names/0`\n or a `Cldr.LanguageTag` struct returned by `Plausible.Cldr.Locale.new!/1`","ref":"Plausible.Cldr.html#validate_locale/1-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.validate_locale/1","doc":"* `{:ok, language_tag}`\n\n* `{:error, reason}`","ref":"Plausible.Cldr.html#validate_locale/1-returns"},{"type":"function","title":"Notes - Plausible.Cldr.validate_locale/1","doc":"See [rfc5646](https://tools.ietf.org/html/rfc5646) for the specification\nof a language tag.","ref":"Plausible.Cldr.html#validate_locale/1-notes"},{"type":"function","title":"Examples - Plausible.Cldr.validate_locale/1","doc":"iex> Plausible.Cldr.validate_locale(:en)\n {:ok,\n %Cldr.LanguageTag{\n backend: Plausible.Cldr,\n canonical_locale_name: \"en\",\n cldr_locale_name: :en,\n extensions: %{},\n gettext_locale_name: \"en\",\n language: \"en\",\n locale: %{},\n private_use: [],\n rbnf_locale_name: :en,\n requested_locale_name: \"en\",\n script: :Latn,\n territory: :US,\n transform: %{},\n language_variants: []\n }}\n\n\n iex> Plausible.Cldr.validate_locale Plausible.Cldr.default_locale()\n {:ok,\n %Cldr.LanguageTag{\n backend: Plausible.Cldr,\n canonical_locale_name: \"en-001\",\n cldr_locale_name: :\"en-001\",\n extensions: %{},\n gettext_locale_name: \"en\",\n language: \"en\",\n locale: %{},\n private_use: [],\n rbnf_locale_name: :en,\n requested_locale_name: \"en-001\",\n script: :Latn,\n territory: :\"001\",\n transform: %{},\n language_variants: []\n }}\n\n iex> Plausible.Cldr.validate_locale(\"zzz\")\n {:error, {Cldr.InvalidLanguageError, \"The language \\\"zzz\\\" is invalid\"}}","ref":"Plausible.Cldr.html#validate_locale/1-examples"},{"type":"function","title":"Plausible.Cldr.validate_number_system/1","doc":"","ref":"Plausible.Cldr.html#validate_number_system/1"},{"type":"function","title":"Plausible.Cldr.validate_number_system_type/1","doc":"Normalise and validate a number system type.","ref":"Plausible.Cldr.html#validate_number_system_type/1"},{"type":"function","title":"Arguments - Plausible.Cldr.validate_number_system_type/1","doc":"* `number_system_type` is any number system type returned by\n `Cldr.known_number_system_types/1`","ref":"Plausible.Cldr.html#validate_number_system_type/1-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.validate_number_system_type/1","doc":"* `{:ok, normalized_number_system_type}` or\n\n* `{:error, {exception, message}}`","ref":"Plausible.Cldr.html#validate_number_system_type/1-returns"},{"type":"function","title":"Examples - Plausible.Cldr.validate_number_system_type/1","doc":"iex> Plausible.Cldr.validate_number_system_type(:default)\n {:ok, :default}\n\n iex> Plausible.Cldr.validate_number_system_type(:traditional)\n {:ok, :traditional}\n\n iex> Plausible.Cldr.validate_number_system_type(:latn)\n {\n :error,\n {Cldr.UnknownNumberSystemTypeError, \"The number system type :latn is unknown\"}\n }\n\n iex> Plausible.Cldr.validate_number_system_type(\"bork\")\n {\n :error,\n {Cldr.UnknownNumberSystemTypeError, \"The number system type \\\"bork\\\" is invalid\"}\n }","ref":"Plausible.Cldr.html#validate_number_system_type/1-examples"},{"type":"function","title":"Plausible.Cldr.validate_territory/1","doc":"","ref":"Plausible.Cldr.html#validate_territory/1"},{"type":"function","title":"Plausible.Cldr.with_locale/2","doc":"Execute a function with a locale ensuring that the\ncurrent locale is restored after the function.","ref":"Plausible.Cldr.html#with_locale/2"},{"type":"function","title":"Arguments - Plausible.Cldr.with_locale/2","doc":"* `locale` is any valid locale name returned by `Cldr.known_locale_names/1`.\n\n* `fun` is any 0-arity function or function capture.","ref":"Plausible.Cldr.html#with_locale/2-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.with_locale/2","doc":"* The value returned by the function `fun/0` or\n\n* `{:error, {exception, reason}}` if the locale is invalid or\n\n* raises an exception if the current locale cannot be\n identified.","ref":"Plausible.Cldr.html#with_locale/2-returns"},{"type":"module","title":"Plausible.Cldr.AcceptLanguage","doc":"Parses HTTP `Accept-Language` header values as defined in\n[rfc2616](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4).\n\nThe Accept-Language request-header field is similar to Accept, but restricts\nthe set of natural languages that are preferred as a response to the request.\nLanguage tags function are provided in `Cldr.LanguageTag`.\n\nThe format of an `Accept-Language` header is as follows in `ABNF` format:\n\n Accept-Language = \"Accept-Language\" \":\"\n 1#( language-range [ \";\" \"q\" \"=\" qvalue ] )\n language-range = ( ( 1*8ALPHA *( \"-\" 1*8ALPHA ) ) | \"*\" )\n\nEach language-range MAY be given an associated quality value which represents an\nestimate of the user's preference for the languages specified by that range. The\nquality value defaults to \"q=1\". For example,\n\n Accept-Language: da, en-gb;q=0.8, en;q=0.7\n\nwould mean: \"I prefer Danish, but will accept British English and other types of English.\"","ref":"Plausible.Cldr.AcceptLanguage.html"},{"type":"function","title":"Plausible.Cldr.AcceptLanguage.best_match/1","doc":"Parse an `Accept-Language` string and return the best match for\na configured `Cldr` locale.","ref":"Plausible.Cldr.AcceptLanguage.html#best_match/1"},{"type":"function","title":"Arguments - Plausible.Cldr.AcceptLanguage.best_match/1","doc":"* `accept_language` is a string representing an accept language header","ref":"Plausible.Cldr.AcceptLanguage.html#best_match/1-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.AcceptLanguage.best_match/1","doc":"* `{:ok, language_tag}` or\n\n* `{:error, reason}`","ref":"Plausible.Cldr.AcceptLanguage.html#best_match/1-returns"},{"type":"function","title":"Examples - Plausible.Cldr.AcceptLanguage.best_match/1","doc":"iex> Plausible.Cldr.AcceptLanguage.best_match(\"da;q=0.1,zh-TW;q=0.3\", TestBackend.Cldr)\n {:ok,\n %Cldr.LanguageTag{\n backend: TestBackend.Cldr,\n canonical_locale_name: \"zh-TW\",\n cldr_locale_name: :\"zh-Hant\",\n language_subtags: [],\n extensions: %{},\n gettext_locale_name: nil,\n language: \"zh\",\n locale: %{},\n private_use: [],\n rbnf_locale_name: :\"zh-Hant\",\n requested_locale_name: \"zh-TW\",\n script: :Hant,\n territory: :TW,\n transform: %{},\n language_variants: []\n }}\n\n iex> Plausible.Cldr.AcceptLanguage.best_match(\"da;q=0.1,zh-TW;q=0.3\", TestBackend.Cldr)\n {:ok,\n %Cldr.LanguageTag{\n backend: TestBackend.Cldr,\n canonical_locale_name: \"zh-TW\",\n cldr_locale_name: :\"zh-Hant\",\n language_subtags: [],\n extensions: %{},\n gettext_locale_name: nil,\n language: \"zh\",\n locale: %{},\n private_use: [],\n rbnf_locale_name: :\"zh-Hant\",\n requested_locale_name: \"zh-TW\",\n script: :Hant,\n territory: :TW,\n transform: %{},\n language_variants: []\n }}\n\n iex> Plausible.Cldr.AcceptLanguage.best_match(\"xx,yy;q=0.3\")\n {:error,\n {Cldr.NoMatchingLocale,\n \"No configured locale could be matched to \\\"xx,yy;q=0.3\\\"\"}}\n\n iex> Plausible.Cldr.AcceptLanguage.best_match(\"invalid_tag\")\n {:error, {Cldr.LanguageTag.ParseError,\n \"Expected a BCP47 language tag. Could not parse the remaining \\\"g\\\" starting at position 11\"}}","ref":"Plausible.Cldr.AcceptLanguage.html#best_match/1-examples"},{"type":"function","title":"Plausible.Cldr.AcceptLanguage.parse/1","doc":"Parses an `Accept-Language` header value in its string\nor tokenized form to return a tuple of the form\n`{:ok, [{quality, %Cldr.LanguageTag{}}, ...]}` sorted by quality.","ref":"Plausible.Cldr.AcceptLanguage.html#parse/1"},{"type":"function","title":"Arguments - Plausible.Cldr.AcceptLanguage.parse/1","doc":"* `accept-language` is any string in the format defined by\n [rfc2616](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4)\n\n* `backend` is any module that includes `use Cldr` and therefore\n is a `Cldr` backend module","ref":"Plausible.Cldr.AcceptLanguage.html#parse/1-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.AcceptLanguage.parse/1","doc":"* `{:ok, [{quality, language_tag}, ...]}` or\n\n* `{:error, {Cldr.AcceptLanguageError, String.t}}`\n\nIf at least one valid language tag is found but errors are also\ndetected on one more more tags, an `{ok, list}` tuple is returned\nwith an error tuple for each invalid tag added at the end of the list.","ref":"Plausible.Cldr.AcceptLanguage.html#parse/1-returns"},{"type":"function","title":"Example - Plausible.Cldr.AcceptLanguage.parse/1","doc":"iex> Cldr.AcceptLanguage.parse(\"da,zh-TW;q=0.3\", TestBackend.Cldr)\n {:ok,\n [\n {1.0,\n %Cldr.LanguageTag{\n backend: TestBackend.Cldr,\n canonical_locale_name: \"da\",\n cldr_locale_name: :da,\n language_subtags: [],\n extensions: %{},\n gettext_locale_name: nil,\n language: \"da\",\n locale: %{},\n private_use: [],\n rbnf_locale_name: :da,\n requested_locale_name: \"da\",\n script: :Latn,\n territory: :DK,\n transform: %{},\n language_variants: []\n }},\n {0.3,\n %Cldr.LanguageTag{\n backend: TestBackend.Cldr,\n canonical_locale_name: \"zh-TW\",\n cldr_locale_name: :\"zh-Hant\",\n language_subtags: [],\n extensions: %{},\n gettext_locale_name: nil,\n language: \"zh\",\n locale: %{},\n private_use: [],\n rbnf_locale_name: :\"zh-Hant\",\n requested_locale_name: \"zh-TW\",\n script: :Hant,\n territory: :TW,\n transform: %{},\n language_variants: []\n }}\n ]}\n\n iex> Plausible.Cldr.AcceptLanguage.parse(\"invalid_tag\")\n {:error,\n {Cldr.LanguageTag.ParseError,\n \"Expected a BCP47 language tag. Could not parse the remaining \\\"g\\\" starting at position 11\"}}\n\n iex> Plausible.Cldr.AcceptLanguage.parse(\"da,zh-TW;q=0.3,invalid_tag\")\n {:ok,\n [\n {1.0,\n %Cldr.LanguageTag{\n backend: TestBackend.Cldr,\n canonical_locale_name: \"da\",\n cldr_locale_name: :da,\n language_subtags: [],\n extensions: %{},\n gettext_locale_name: nil,\n language: \"da\",\n locale: %{},\n private_use: [],\n rbnf_locale_name: :da,\n requested_locale_name: \"da\",\n script: :Latn,\n territory: :DK,\n transform: %{},\n language_variants: []\n }},\n {0.3,\n %Cldr.LanguageTag{\n backend: TestBackend.Cldr,\n canonical_locale_name: \"zh-TW\",\n cldr_locale_name: :\"zh-Hant\",\n language_subtags: [],\n extensions: %{},\n gettext_locale_name: nil,\n language: \"zh\",\n locale: %{},\n private_use: [],\n rbnf_locale_name: :\"zh-Hant\",\n requested_locale_name: \"zh-TW\",\n script: :Hant,\n territory: :TW,\n transform: %{},\n language_variants: []\n }},\n {:error,\n {Cldr.LanguageTag.ParseError,\n \"Expected a BCP47 language tag. Could not parse the remaining \\\"g\\\" starting at position 11\"}}\n ]}","ref":"Plausible.Cldr.AcceptLanguage.html#parse/1-example"},{"type":"function","title":"Plausible.Cldr.AcceptLanguage.parse!/1","doc":"Parses an `Accept-Language` header value in its string\nor tokenized form to produce a list of tuples of the form\n`[{quality, %Cldr.LanguageTag{}}, ...]` sorted by quality\nin descending order.","ref":"Plausible.Cldr.AcceptLanguage.html#parse!/1"},{"type":"function","title":"Arguments - Plausible.Cldr.AcceptLanguage.parse!/1","doc":"* `accept-language` is any string in the format defined by [rfc2616](https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.4)","ref":"Plausible.Cldr.AcceptLanguage.html#parse!/1-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.AcceptLanguage.parse!/1","doc":"* `{:ok, [{quality, language_tag}, ...]}` or\n\n* raises a `Cldr.AcceptLanguageError` exception\n\nIf at least one valid language tag is found but errors are also\ndetected on one more more tags, an `{ok, list}` tuple is returned\nwith an error tuple for each invalid tag added at the end of the list.","ref":"Plausible.Cldr.AcceptLanguage.html#parse!/1-returns"},{"type":"function","title":"Example - Plausible.Cldr.AcceptLanguage.parse!/1","doc":"iex> Plausible.Cldr.AcceptLanguage.parse!(\"da,zh-TW;q=0.3\")\n [\n {1.0,\n %Cldr.LanguageTag{\n backend: TestBackend.Cldr,\n canonical_locale_name: \"da\",\n cldr_locale_name: :da,\n language_subtags: [],\n extensions: %{},\n gettext_locale_name: nil,\n language: \"da\",\n locale: %{},\n private_use: [],\n rbnf_locale_name: :da,\n requested_locale_name: \"da\",\n script: :Latn,\n territory: :DK,\n transform: %{},\n language_variants: []\n }},\n {0.3,\n %Cldr.LanguageTag{\n backend: TestBackend.Cldr,\n canonical_locale_name: \"zh-TW\",\n cldr_locale_name: :\"zh-Hant\",\n language_subtags: [],\n extensions: %{},\n gettext_locale_name: nil,\n language: \"zh\",\n locale: %{},\n private_use: [],\n rbnf_locale_name: :\"zh-Hant\",\n requested_locale_name: \"zh-TW\",\n script: :Hant,\n territory: :TW,\n transform: %{},\n language_variants: []\n }}\n ]\n\n Plausible.Cldr.AcceptLanguage.parse! \"invalid_tag\"\n ** (Cldr.AcceptLanguageError) \"Expected a BCP47 language tag. Could not parse the remaining \"g\" starting at position 11\n (ex_cldr) lib/cldr/accept_language.ex:304: Cldr.AcceptLanguage.parse!/1\n\n iex> Plausible.Cldr.AcceptLanguage.parse!(\"da,zh-TW;q=0.3,invalid_tag\")\n [\n {1.0,\n %Cldr.LanguageTag{\n backend: TestBackend.Cldr,\n canonical_locale_name: \"da\",\n cldr_locale_name: :da,\n language_subtags: [],\n extensions: %{},\n gettext_locale_name: nil,\n language: \"da\",\n locale: %{},\n private_use: [],\n rbnf_locale_name: :da,\n requested_locale_name: \"da\",\n script: :Latn,\n territory: :DK,\n transform: %{},\n language_variants: []\n }},\n {0.3,\n %Cldr.LanguageTag{\n backend: TestBackend.Cldr,\n canonical_locale_name: \"zh-TW\",\n cldr_locale_name: :\"zh-Hant\",\n language_subtags: [],\n extensions: %{},\n gettext_locale_name: nil,\n language: \"zh\",\n locale: %{},\n private_use: [],\n rbnf_locale_name: :\"zh-Hant\",\n requested_locale_name: \"zh-TW\",\n script: :Hant,\n territory: :TW,\n transform: %{},\n language_variants: []\n }},\n {:error,\n {Cldr.LanguageTag.ParseError,\n \"Expected a BCP47 language tag. Could not parse the remaining \\\"g\\\" starting at position 11\"}}\n ]","ref":"Plausible.Cldr.AcceptLanguage.html#parse!/1-example"},{"type":"module","title":"Plausible.Cldr.Currency","doc":"","ref":"Plausible.Cldr.Currency.html"},{"type":"function","title":"Plausible.Cldr.Currency.currencies_for_locale/3","doc":"Returns a map of the metadata for all currencies for\na given locale.","ref":"Plausible.Cldr.Currency.html#currencies_for_locale/3"},{"type":"function","title":"Arguments - Plausible.Cldr.Currency.currencies_for_locale/3","doc":"* `locale` is any valid locale name returned by `MyApp.Cldr.known_locale_names/0`\n or a `Cldr.LanguageTag` struct returned by `MyApp.Cldr.Locale.new!/1`\n\n* `currency_status` is `:all`, `:current`, `:historic`,\n `unannotated` or `:tender`; or a list of one or more status.\n The default is `:all`. See `Cldr.Currency.currency_filter/2`.","ref":"Plausible.Cldr.Currency.html#currencies_for_locale/3-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.Currency.currencies_for_locale/3","doc":"* `{:ok, currency_map}` or\n\n* `{:error, {exception, reason}}`","ref":"Plausible.Cldr.Currency.html#currencies_for_locale/3-returns"},{"type":"function","title":"Example - Plausible.Cldr.Currency.currencies_for_locale/3","doc":"MyApp.Cldr.Currency.currencies_for_locale(\"en\")\n => {:ok,\n %{\n FJD: %Cldr.Currency{\n cash_digits: 2,\n cash_rounding: 0,\n code: \"FJD\",\n count: %{one: \"Fijian dollar\", other: \"Fijian dollars\"},\n digits: 2,\n from: nil,\n iso_digits: 2,\n name: \"Fijian Dollar\",\n narrow_symbol: \"$\",\n rounding: 0,\n symbol: \"FJD\",\n tender: true,\n to: nil\n },\n SUR: %Cldr.Currency{\n cash_digits: 2,\n cash_rounding: 0,\n code: \"SUR\",\n count: %{one: \"Soviet rouble\", other: \"Soviet roubles\"},\n digits: 2,\n from: nil,\n iso_digits: nil,\n name: \"Soviet Rouble\",\n narrow_symbol: nil,\n rounding: 0,\n symbol: \"SUR\",\n tender: true,\n to: nil\n },\n ...\n }}","ref":"Plausible.Cldr.Currency.html#currencies_for_locale/3-example"},{"type":"function","title":"Plausible.Cldr.Currency.currencies_for_locale!/3","doc":"Returns a map of the metadata for all currencies for\na given locale and raises on error.","ref":"Plausible.Cldr.Currency.html#currencies_for_locale!/3"},{"type":"function","title":"Arguments - Plausible.Cldr.Currency.currencies_for_locale!/3","doc":"* `locale` is any valid locale name returned by `MyApp.Cldr.known_locale_names/0`\n or a `Cldr.LanguageTag` struct returned by `MyApp.Cldr.Locale.new!/1`\n\n* `currency_status` is `:all`, `:current`, `:historic`,\n `unannotated` or `:tender`; or a list of one or more status.\n The default is `:all`. See `Cldr.Currency.currency_filter/2`.","ref":"Plausible.Cldr.Currency.html#currencies_for_locale!/3-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.Currency.currencies_for_locale!/3","doc":"* `{:ok, currency_map}` or\n\n* raises an exception","ref":"Plausible.Cldr.Currency.html#currencies_for_locale!/3-returns"},{"type":"function","title":"Example - Plausible.Cldr.Currency.currencies_for_locale!/3","doc":"MyApp.Cldr.Currency.currencies_for_locale!(\"en\")\n => %{\n FJD: %Cldr.Currency{\n cash_digits: 2,\n cash_rounding: 0,\n code: \"FJD\",\n count: %{one: \"Fijian dollar\", other: \"Fijian dollars\"},\n digits: 2,\n from: nil,\n iso_digits: 2,\n name: \"Fijian Dollar\",\n narrow_symbol: \"$\",\n rounding: 0,\n symbol: \"FJD\",\n tender: true,\n to: nil\n },\n SUR: %Cldr.Currency{\n cash_digits: 2,\n cash_rounding: 0,\n code: \"SUR\",\n count: %{one: \"Soviet rouble\", other: \"Soviet roubles\"},\n digits: 2,\n from: nil,\n iso_digits: nil,\n name: \"Soviet Rouble\",\n narrow_symbol: nil,\n rounding: 0,\n symbol: \"SUR\",\n tender: true,\n to: nil\n },\n ...\n }","ref":"Plausible.Cldr.Currency.html#currencies_for_locale!/3-example"},{"type":"function","title":"Plausible.Cldr.Currency.currency_for_code/2","doc":"Returns the currency metadata for the requested currency code.","ref":"Plausible.Cldr.Currency.html#currency_for_code/2"},{"type":"function","title":"Arguments - Plausible.Cldr.Currency.currency_for_code/2","doc":"* `currency_or_currency_code` is a `binary` or `atom` representation\n of an ISO 4217 currency code, or a `%Cldr.Currency{}` struct.","ref":"Plausible.Cldr.Currency.html#currency_for_code/2-arguments"},{"type":"function","title":"Options - Plausible.Cldr.Currency.currency_for_code/2","doc":"* `:locale` is any valid locale name returned by `Cldr.known_locale_names/1`\n or a `Cldr.LanguageTag` struct returned by `Cldr.Locale.new!/2`","ref":"Plausible.Cldr.Currency.html#currency_for_code/2-options"},{"type":"function","title":"Returns - Plausible.Cldr.Currency.currency_for_code/2","doc":"* A `{:ok, currency}` or\n\n* `{:error, {exception, reason}}`","ref":"Plausible.Cldr.Currency.html#currency_for_code/2-returns"},{"type":"function","title":"Examples - Plausible.Cldr.Currency.currency_for_code/2","doc":"iex> Plausible.Cldr.Currency.currency_for_code(\"AUD\")\n {:ok,\n %Cldr.Currency{\n cash_digits: 2,\n cash_rounding: 0,\n code: \"AUD\",\n count: %{one: \"Australian dollar\", other: \"Australian dollars\"},\n digits: 2,\n iso_digits: 2,\n name: \"Australian Dollar\",\n narrow_symbol: \"$\",\n rounding: 0,\n symbol: \"A$\",\n tender: true\n }}\n\n iex> Plausible.Cldr.Currency.currency_for_code(\"THB\")\n {:ok,\n %Cldr.Currency{\n cash_digits: 2,\n cash_rounding: 0,\n code: \"THB\",\n count: %{one: \"Thai baht\", other: \"Thai baht\"},\n digits: 2,\n iso_digits: 2,\n name: \"Thai Baht\",\n narrow_symbol: \"฿\",\n rounding: 0,\n symbol: \"THB\",\n tender: true\n }}","ref":"Plausible.Cldr.Currency.html#currency_for_code/2-examples"},{"type":"function","title":"Plausible.Cldr.Currency.currency_for_code!/2","doc":"Returns the currency metadata for the requested currency code.","ref":"Plausible.Cldr.Currency.html#currency_for_code!/2"},{"type":"function","title":"Arguments - Plausible.Cldr.Currency.currency_for_code!/2","doc":"* `currency_or_currency_code` is a `binary` or `atom` representation\n of an ISO 4217 currency code, or a `%Cldr.Currency{}` struct.","ref":"Plausible.Cldr.Currency.html#currency_for_code!/2-arguments"},{"type":"function","title":"Options - Plausible.Cldr.Currency.currency_for_code!/2","doc":"* `:locale` is any valid locale name returned by `Cldr.known_locale_names/1`\n or a `Cldr.LanguageTag` struct returned by `Cldr.Locale.new!/2`","ref":"Plausible.Cldr.Currency.html#currency_for_code!/2-options"},{"type":"function","title":"Returns - Plausible.Cldr.Currency.currency_for_code!/2","doc":"* A `t:Cldr.Current.t/0` or\n\n* raises an exception","ref":"Plausible.Cldr.Currency.html#currency_for_code!/2-returns"},{"type":"function","title":"Examples - Plausible.Cldr.Currency.currency_for_code!/2","doc":"iex> Plausible.Cldr.Currency.currency_for_code!(\"AUD\")\n %Cldr.Currency{\n cash_digits: 2,\n cash_rounding: 0,\n code: \"AUD\",\n count: %{one: \"Australian dollar\", other: \"Australian dollars\"},\n digits: 2,\n iso_digits: 2,\n name: \"Australian Dollar\",\n narrow_symbol: \"$\",\n rounding: 0,\n symbol: \"A$\",\n tender: true\n }\n\n iex> Plausible.Cldr.Currency.currency_for_code!(\"THB\")\n %Cldr.Currency{\n cash_digits: 2,\n cash_rounding: 0,\n code: \"THB\",\n count: %{one: \"Thai baht\", other: \"Thai baht\"},\n digits: 2,\n iso_digits: 2,\n name: \"Thai Baht\",\n narrow_symbol: \"฿\",\n rounding: 0,\n symbol: \"THB\",\n tender: true\n }","ref":"Plausible.Cldr.Currency.html#currency_for_code!/2-examples"},{"type":"function","title":"Plausible.Cldr.Currency.currency_from_locale/1","doc":"Returns the effective currency for a given locale","ref":"Plausible.Cldr.Currency.html#currency_from_locale/1"},{"type":"function","title":"Arguments - Plausible.Cldr.Currency.currency_from_locale/1","doc":"* `locale` is a `Cldr.LanguageTag` struct returned by\n `Cldr.Locale.new!/2`","ref":"Plausible.Cldr.Currency.html#currency_from_locale/1-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.Currency.currency_from_locale/1","doc":"* A ISO 4217 currency code as an upcased atom","ref":"Plausible.Cldr.Currency.html#currency_from_locale/1-returns"},{"type":"function","title":"Examples - Plausible.Cldr.Currency.currency_from_locale/1","doc":"iex> {:ok, locale} = Plausible.Cldr.validate_locale(\"en\")\n iex> Plausible.Cldr.Currency.currency_from_locale locale\n :USD\n\n iex> {:ok, locale} = Plausible.Cldr.validate_locale(\"en-AU\")\n iex> Plausible.Cldr.Currency.currency_from_locale locale\n :AUD\n\n iex> Plausible.Cldr.Currency.currency_from_locale(\"en-GB\")\n :GBP","ref":"Plausible.Cldr.Currency.html#currency_from_locale/1-examples"},{"type":"function","title":"Plausible.Cldr.Currency.currency_history_for_locale/1","doc":"Returns a list of historic and the current\ncurrency for a given locale.","ref":"Plausible.Cldr.Currency.html#currency_history_for_locale/1"},{"type":"function","title":"Arguments - Plausible.Cldr.Currency.currency_history_for_locale/1","doc":"* `locale` is any valid locale name returned by `MyApp.Cldr.known_locale_names/0`\n or a `Cldr.LanguageTag` struct returned by `MyApp.Cldr.Locale.new!/1`","ref":"Plausible.Cldr.Currency.html#currency_history_for_locale/1-arguments"},{"type":"function","title":"Example - Plausible.Cldr.Currency.currency_history_for_locale/1","doc":"iex> MyApp.Cldr.Currency.currency_history_for_locale(\"en\")\n {:ok,\n %{\n USD: %{from: ~D[1792-01-01], to: nil},\n USN: %{tender: false},\n USS: %{from: nil, tender: false, to: ~D[2014-03-01]}\n }\n }","ref":"Plausible.Cldr.Currency.html#currency_history_for_locale/1-example"},{"type":"function","title":"Plausible.Cldr.Currency.currency_strings/3","doc":"Returns a map that matches a currency string to a\ncurrency code.\n\nA currency string is a localised name or symbol\nrepresenting a currency in a locale-specific manner.","ref":"Plausible.Cldr.Currency.html#currency_strings/3"},{"type":"function","title":"Arguments - Plausible.Cldr.Currency.currency_strings/3","doc":"* `locale` is any valid locale name returned by `MyApp.Cldr.known_locale_names/0`\n or a `Cldr.LanguageTag` struct returned by `MyApp.Cldr.Locale.new!/1`\n\n* `currency_status` is `:all`, `:current`, `:historic`,\n `unannotated` or `:tender`; or a list of one or more status.\n The default is `:all`. See `Cldr.Currency.currency_filter/2`.","ref":"Plausible.Cldr.Currency.html#currency_strings/3-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.Currency.currency_strings/3","doc":"* `{:ok, currency_string_map}` or\n\n* `{:error, {exception, reason}}`","ref":"Plausible.Cldr.Currency.html#currency_strings/3-returns"},{"type":"function","title":"Example - Plausible.Cldr.Currency.currency_strings/3","doc":"MyApp.Cldr.Currency.currency_strings(\"en\")\n => {:ok,\n %{\n \"mexican silver pesos\" => :MXP,\n \"sudanese dinar\" => :SDD,\n \"bad\" => :BAD,\n \"rsd\" => :RSD,\n \"swazi lilangeni\" => :SZL,\n \"zairean new zaire\" => :ZRN,\n \"guyanaese dollars\" => :GYD,\n \"equatorial guinean ekwele\" => :GQE,\n ...\n }}","ref":"Plausible.Cldr.Currency.html#currency_strings/3-example"},{"type":"function","title":"Plausible.Cldr.Currency.currency_strings!/3","doc":"Returns a map that matches a currency string to a\ncurrency code or raises an exception.\n\nA currency string is a localised name or symbol\nrepresenting a currency in a locale-specific manner.","ref":"Plausible.Cldr.Currency.html#currency_strings!/3"},{"type":"function","title":"Arguments - Plausible.Cldr.Currency.currency_strings!/3","doc":"* `locale` is any valid locale name returned by `MyApp.Cldr.known_locale_names/0`\n or a `Cldr.LanguageTag` struct returned by `MyApp.Cldr.Locale.new!/1`\n\n* `currency_status` is `:all`, `:current`, `:historic`,\n `unannotated` or `:tender`; or a list of one or more status.\n The default is `:all`. See `Cldr.Currency.currency_filter/2`.","ref":"Plausible.Cldr.Currency.html#currency_strings!/3-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.Currency.currency_strings!/3","doc":"* `{:ok, currency_string_map}` or\n\n* raises an exception","ref":"Plausible.Cldr.Currency.html#currency_strings!/3-returns"},{"type":"function","title":"Example - Plausible.Cldr.Currency.currency_strings!/3","doc":"MyApp.Cldr.Currency.currency_strings!(\"en\")\n => %{\n \"mexican silver pesos\" => :MXP,\n \"sudanese dinar\" => :SDD,\n \"bad\" => :BAD,\n \"rsd\" => :RSD,\n \"swazi lilangeni\" => :SZL,\n \"zairean new zaire\" => :ZRN,\n \"guyanaese dollars\" => :GYD,\n \"equatorial guinean ekwele\" => :GQE,\n ...\n }","ref":"Plausible.Cldr.Currency.html#currency_strings!/3-example"},{"type":"function","title":"Plausible.Cldr.Currency.current_currency_from_locale/1","doc":"Returns the current currency for a given locale.\n\nThis function does not consider the `U` extenion\nparameters `cu` or `rg`. It is recommended to us\n`Cldr.Currency.currency_from_locale/1` in most\ncircumstances.","ref":"Plausible.Cldr.Currency.html#current_currency_from_locale/1"},{"type":"function","title":"Arguments - Plausible.Cldr.Currency.current_currency_from_locale/1","doc":"* `locale` is any valid locale name returned by `MyApp.Cldr.known_locale_names/0`\n or a `Cldr.LanguageTag` struct returned by `MyApp.Cldr.Locale.new!/1`","ref":"Plausible.Cldr.Currency.html#current_currency_from_locale/1-arguments"},{"type":"function","title":"Example - Plausible.Cldr.Currency.current_currency_from_locale/1","doc":"iex> MyApp.Cldr.Currency.current_currency_from_locale(\"en\")\n :USD\n\n iex> MyApp.Cldr.Currency.current_currency_from_locale(\"en-AU\")\n :AUD","ref":"Plausible.Cldr.Currency.html#current_currency_from_locale/1-example"},{"type":"function","title":"Plausible.Cldr.Currency.current_territory_currencies/0","doc":"Returns a mapping from a territory code to its\ncurrent currency code.\n\nIf a territory has no current currency (like\nAntartica, territory code `:AQ`) then no\nmapping is returned for that territory.","ref":"Plausible.Cldr.Currency.html#current_territory_currencies/0"},{"type":"function","title":"Returns - Plausible.Cldr.Currency.current_territory_currencies/0","doc":"* A map of `{territory_code => Cldr.Currency.t}`","ref":"Plausible.Cldr.Currency.html#current_territory_currencies/0-returns"},{"type":"function","title":"Example - Plausible.Cldr.Currency.current_territory_currencies/0","doc":"iex> Plausible.Cldr.Currency.current_territory_currencies()","ref":"Plausible.Cldr.Currency.html#current_territory_currencies/0-example"},{"type":"function","title":"Plausible.Cldr.Currency.known_currencies/0","doc":"","ref":"Plausible.Cldr.Currency.html#known_currencies/0"},{"type":"function","title":"Plausible.Cldr.Currency.known_currency?/1","doc":"","ref":"Plausible.Cldr.Currency.html#known_currency?/1"},{"type":"function","title":"Plausible.Cldr.Currency.known_currency_code/1","doc":"Returns a 2-tuple indicating if the supplied currency code is known.","ref":"Plausible.Cldr.Currency.html#known_currency_code/1"},{"type":"function","title":"Arguments - Plausible.Cldr.Currency.known_currency_code/1","doc":"* `currency_code` is a `binary` or `atom` representing an ISO4217\n currency code","ref":"Plausible.Cldr.Currency.html#known_currency_code/1-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.Currency.known_currency_code/1","doc":"* `{:ok, currency_code}` or\n\n* `{:error, {exception, reason}}`","ref":"Plausible.Cldr.Currency.html#known_currency_code/1-returns"},{"type":"function","title":"Examples - Plausible.Cldr.Currency.known_currency_code/1","doc":"iex> Plausible.Cldr.Currency.known_currency_code(\"AUD\")\n {:ok, :AUD}\n\n iex> Plausible.Cldr.Currency.known_currency_code(\"GGG\")\n {:error, {Cldr.UnknownCurrencyError, \"The currency \\\"GGG\\\" is invalid\"}}","ref":"Plausible.Cldr.Currency.html#known_currency_code/1-examples"},{"type":"function","title":"Plausible.Cldr.Currency.known_currency_code?/1","doc":"Returns a boolean indicating if the supplied currency code is known.","ref":"Plausible.Cldr.Currency.html#known_currency_code?/1"},{"type":"function","title":"Arguments - Plausible.Cldr.Currency.known_currency_code?/1","doc":"* `currency_code` is a `binary` or `atom` representing an ISO4217\n currency code","ref":"Plausible.Cldr.Currency.html#known_currency_code?/1-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.Currency.known_currency_code?/1","doc":"* `true` or `false`","ref":"Plausible.Cldr.Currency.html#known_currency_code?/1-returns"},{"type":"function","title":"Examples - Plausible.Cldr.Currency.known_currency_code?/1","doc":"iex> Plausible.Cldr.Currency.known_currency_code?(\"AUD\")\n true\n\n iex> Plausible.Cldr.Currency.known_currency_code?(\"GGG\")\n false\n\n iex> Plausible.Cldr.Currency.known_currency_code?(:XCV)\n false","ref":"Plausible.Cldr.Currency.html#known_currency_code?/1-examples"},{"type":"function","title":"Plausible.Cldr.Currency.known_currency_codes/0","doc":"Returns a list of all known currency codes.","ref":"Plausible.Cldr.Currency.html#known_currency_codes/0"},{"type":"function","title":"Example - Plausible.Cldr.Currency.known_currency_codes/0","doc":"iex> Plausible.Cldr.Currency.known_currency_codes()","ref":"Plausible.Cldr.Currency.html#known_currency_codes/0-example"},{"type":"function","title":"Plausible.Cldr.Currency.new/2","doc":"Returns a `Currency` struct created from the arguments.","ref":"Plausible.Cldr.Currency.html#new/2"},{"type":"function","title":"Arguments - Plausible.Cldr.Currency.new/2","doc":"* `currency` is a private use currency code in a format defined by\n [ISO4217](https://en.wikipedia.org/wiki/ISO_4217)\n which is `X` followed by two alphanumeric characters.\n\n* `options` is a map of options representing the optional elements of\n the `Cldr.Currency.t` struct.","ref":"Plausible.Cldr.Currency.html#new/2-arguments"},{"type":"function","title":"Options - Plausible.Cldr.Currency.new/2","doc":"* `:name` is the name of the currency. Required.\n* `:digits` is the precision of the currency. Required.\n* `:symbol` is the currency symbol. Optional.\n* `:narrow_symbol` is an alternative narrow symbol. Optional.\n* `:round_nearest` is the rounding precision such as `0.05`. Optional.\n* `:alt_code` is an alternative currency code for application use.\n* `:cash_digits` is the precision of the currency when used as cash. Optional.\n* `:cash_rounding_nearest` is the rounding precision when used as cash\n such as `0.05`. Optional.","ref":"Plausible.Cldr.Currency.html#new/2-options"},{"type":"function","title":"Returns - Plausible.Cldr.Currency.new/2","doc":"* `{:ok, Cldr.Currency.t}` or\n\n* `{:error, {exception, message}}`","ref":"Plausible.Cldr.Currency.html#new/2-returns"},{"type":"function","title":"Example - Plausible.Cldr.Currency.new/2","doc":"iex> Plausible.Cldr.Currency.new(:XAE, name: \"Custom Name\", digits: 0)\n {:ok,\n %Cldr.Currency{\n alt_code: :XAE,\n cash_digits: 0,\n cash_rounding: nil,\n code: :XAE,\n count: %{other: \"Custom Name\"},\n digits: 0,\n from: nil,\n iso_digits: 0,\n name: \"Custom Name\",\n narrow_symbol: nil,\n rounding: 0,\n symbol: \"XAE\",\n tender: false,\n to: nil\n }}\n iex> MyApp.Cldr.Currency.new(:XAH, name: \"Custom Name\")\n {:error, \"Required options are missing. Required options are [:name, :digits]\"}\n iex> Plausible.Cldr.Currency.new(:XAE, name: \"XAE\", digits: 0)\n {:error, {Cldr.CurrencyAlreadyDefined, \"Currency :XAE is already defined.\"}}","ref":"Plausible.Cldr.Currency.html#new/2-example"},{"type":"function","title":"Plausible.Cldr.Currency.pluralize/3","doc":"Returns the appropriate currency display name for the `currency`, based\non the plural rules in effect for the `locale`.","ref":"Plausible.Cldr.Currency.html#pluralize/3"},{"type":"function","title":"Arguments - Plausible.Cldr.Currency.pluralize/3","doc":"* `number` is an integer, float or `Decimal`\n\n* `currency` is any currency returned by `Cldr.Currency.known_currencies/0`\n\n* `options` is a keyword list of options","ref":"Plausible.Cldr.Currency.html#pluralize/3-arguments"},{"type":"function","title":"Options - Plausible.Cldr.Currency.pluralize/3","doc":"* `locale` is any valid locale name returned by `MyApp.Cldr.known_locale_names/0`\n or a `Cldr.LanguageTag` struct returned by `MyApp.Cldr.Locale.new!/1`. The\n default is `Plausible.Cldr.get_locale/0`","ref":"Plausible.Cldr.Currency.html#pluralize/3-options"},{"type":"function","title":"Returns - Plausible.Cldr.Currency.pluralize/3","doc":"* `{:ok, plural_string}` or\n\n* `{:error, {exception, message}}`","ref":"Plausible.Cldr.Currency.html#pluralize/3-returns"},{"type":"function","title":"Examples - Plausible.Cldr.Currency.pluralize/3","doc":"iex> Plausible.Cldr.Currency.pluralize(1, :USD)\n {:ok, \"US dollar\"}\n\n iex> Plausible.Cldr.Currency.pluralize(3, :USD)\n {:ok, \"US dollars\"}\n\n iex> Plausible.Cldr.Currency.pluralize(12, :USD, locale: \"zh\")\n {:ok, \"美元\"}\n\n iex> Plausible.Cldr.Currency.pluralize(12, :USD, locale: \"fr\")\n {:ok, \"dollars des États-Unis\"}\n\n iex> Plausible.Cldr.Currency.pluralize(1, :USD, locale: \"fr\")\n {:ok, \"dollar des États-Unis\"}","ref":"Plausible.Cldr.Currency.html#pluralize/3-examples"},{"type":"function","title":"Plausible.Cldr.Currency.strings_for_currency/2","doc":"Returns the strings associated with a currency\nin a given locale.","ref":"Plausible.Cldr.Currency.html#strings_for_currency/2"},{"type":"function","title":"Arguments - Plausible.Cldr.Currency.strings_for_currency/2","doc":"* `currency` is an ISO4217 currency code\n\n* `locale` is any valid locale name returned by `MyApp.Cldr.known_locale_names/0`\n or a `Cldr.LanguageTag` struct returned by `MyApp.Cldr.Locale.new!/1`","ref":"Plausible.Cldr.Currency.html#strings_for_currency/2-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.Currency.strings_for_currency/2","doc":"* A list of strings or\n\n* `{:error, {exception, reason}}`","ref":"Plausible.Cldr.Currency.html#strings_for_currency/2-returns"},{"type":"function","title":"Example - Plausible.Cldr.Currency.strings_for_currency/2","doc":"iex> MyApp.Cldr.Currency.strings_for_currency :AUD,(\"en\")\n [\"a$\", \"australian dollars\", \"aud\", \"australian dollar\"]","ref":"Plausible.Cldr.Currency.html#strings_for_currency/2-example"},{"type":"module","title":"Plausible.Cldr.Locale","doc":"Backend module that provides functions\nto define new locales and display human-readable\nlocale names for presentation purposes.","ref":"Plausible.Cldr.Locale.html"},{"type":"function","title":"Plausible.Cldr.Locale.fallback_locale_names/1","doc":"Returns the list of fallback locale names, starting\nwith the provided locale name.\n\nFallbacks are a list of locate names which can\nbe used to resolve translation or other localization\ndata if such localised data does not exist for\nthis specific locale..","ref":"Plausible.Cldr.Locale.html#fallback_locale_names/1"},{"type":"function","title":"Arguments - Plausible.Cldr.Locale.fallback_locale_names/1","doc":"* `locale_name` is any locale name returned by\n `Plausible.Cldr.known_locale_names/0`","ref":"Plausible.Cldr.Locale.html#fallback_locale_names/1-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.Locale.fallback_locale_names/1","doc":"* `{:ok, list_of_locale_names}` or\n\n* `{:error, {exception, reason}}`","ref":"Plausible.Cldr.Locale.html#fallback_locale_names/1-returns"},{"type":"function","title":"Examples - Plausible.Cldr.Locale.fallback_locale_names/1","doc":"iex> Plausible.Cldr.Locale.fallback_locale_names(:\"fr-CA\")\n {:ok, [:\"fr-CA\", :fr, :und]}\n\n # Fallbacks are typically formed by progressively\n # stripping variant, territory and script from the\n # given locale name. But not always - there are\n # certain fallbacks that take a different path.\n\n iex> Plausible.Cldr.Locale.fallback_locale_names(:nb)\n {:ok, [:nb, :no, :und]}","ref":"Plausible.Cldr.Locale.html#fallback_locale_names/1-examples"},{"type":"function","title":"Plausible.Cldr.Locale.fallback_locales/1","doc":"Returns the list of fallback locales, starting\nwith the provided locale name.\n\nFallbacks are a list of locate names which can\nbe used to resolve translation or other localization\ndata if such localised data does not exist for\nthis specific locale.","ref":"Plausible.Cldr.Locale.html#fallback_locales/1"},{"type":"function","title":"Arguments - Plausible.Cldr.Locale.fallback_locales/1","doc":"* `locale_name` is any locale name returned by\n `Plausible.Cldr.known_locale_names/0`","ref":"Plausible.Cldr.Locale.html#fallback_locales/1-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.Locale.fallback_locales/1","doc":"* `{:ok, list_of_locales}` or\n\n* `{:error, {exception, reason}}`","ref":"Plausible.Cldr.Locale.html#fallback_locales/1-returns"},{"type":"function","title":"Examples - Plausible.Cldr.Locale.fallback_locales/1","doc":"Plausible.Cldr.Locale.fallback_locales(:\"fr-CA\")\n => {:ok,\n [#Cldr.LanguageTag , #Cldr.LanguageTag ,\n #Cldr.LanguageTag ]}\n\n # Fallbacks are typically formed by progressively\n # stripping variant, territory and script from the\n # given locale name. But not always - there are\n # certain fallbacks that take a different path.\n\n Plausible.Cldr.Locale.fallback_locales(:nb))\n => {:ok,\n [#Cldr.LanguageTag , #Cldr.LanguageTag ,\n #Cldr.LanguageTag ]}","ref":"Plausible.Cldr.Locale.html#fallback_locales/1-examples"},{"type":"function","title":"Plausible.Cldr.Locale.locale_for_territory/1","doc":"Returns the \"best fit\" locale for a given territory.\n\nUsing the population percentage data from CLDR, the\nlanguage most commonly spoken in the given territory\nis used to form a locale name which is then validated\nagainst the given backend.\n\nFirst a territory-specific locale is validated and if\nthat fails, the base language only is validate.\n\nFor example, if the territory is `AU` then then the\nlanguage most spoken is \"en\". First, the locale \"en-AU\"\nis validated and if that fails, \"en\" is validated.","ref":"Plausible.Cldr.Locale.html#locale_for_territory/1"},{"type":"function","title":"Arguments - Plausible.Cldr.Locale.locale_for_territory/1","doc":"* `territory` is any ISO 3166 Alpha-2 territory\n code that can be validated by `Cldr.validate_territory/1`","ref":"Plausible.Cldr.Locale.html#locale_for_territory/1-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.Locale.locale_for_territory/1","doc":"* `{:ok, language_tag}` or\n\n* `{:error, {exception, reason}}`","ref":"Plausible.Cldr.Locale.html#locale_for_territory/1-returns"},{"type":"function","title":"Examples - Plausible.Cldr.Locale.locale_for_territory/1","doc":"iex> Plausible.Cldr.Locale.locale_for_territory(:AU)\n Elixir.Plausible.Cldr.validate_locale(:\"en-AU\")\n\n iex> Plausible.Cldr.Locale.locale_for_territory(:US)\n Elixir.Plausible.Cldr.validate_locale(:\"en-US\")\n\n iex> Plausible.Cldr.Locale.locale_for_territory(:ZZ)\n {:error, {Cldr.UnknownTerritoryError, \"The territory :ZZ is unknown\"}}","ref":"Plausible.Cldr.Locale.html#locale_for_territory/1-examples"},{"type":"function","title":"Plausible.Cldr.Locale.locale_from_host/2","doc":"Returns a \"best fit\" locale for a host name.","ref":"Plausible.Cldr.Locale.html#locale_from_host/2"},{"type":"function","title":"Arguments - Plausible.Cldr.Locale.locale_from_host/2","doc":"* `host` is any valid host name\n\n* `options` is a keyword list of options. The default\n is `[]`.","ref":"Plausible.Cldr.Locale.html#locale_from_host/2-arguments"},{"type":"function","title":"Options - Plausible.Cldr.Locale.locale_from_host/2","doc":"* `:tlds` is a list of territory codes as upper-cased\n atoms that are to be considered as top-level domains.\n See `Cldr.Locale.locale_from_host/2` for the default\n list.","ref":"Plausible.Cldr.Locale.html#locale_from_host/2-options"},{"type":"function","title":"Returns - Plausible.Cldr.Locale.locale_from_host/2","doc":"* `{:ok, langauge_tag}` or\n\n* `{:error, {exception, reason}}`","ref":"Plausible.Cldr.Locale.html#locale_from_host/2-returns"},{"type":"function","title":"Notes - Plausible.Cldr.Locale.locale_from_host/2","doc":"Certain top-level domains have become associated with content\nunderlated to the territory for who the domain is registered.\nTherefore Google (and perhaps others) do not associate these\nTLDs as belonging to the territory but rather are considered\ngeneric top-level domain names.","ref":"Plausible.Cldr.Locale.html#locale_from_host/2-notes"},{"type":"function","title":"Examples - Plausible.Cldr.Locale.locale_from_host/2","doc":"iex> Plausible.Cldr.Locale.locale_from_host \"a.b.com.au\"\n Elixir.Plausible.Cldr.validate_locale(:\"en-AU\")\n\n iex> Plausible.Cldr.Locale.locale_from_host(\"a.b.com.tv\")\n {:error,\n {Cldr.UnknownLocaleError, \"No locale was identified for territory \\\"tv\\\"\"}}\n\n iex> Plausible.Cldr.Locale.locale_from_host(\"a.b.com\")\n {:error,\n {Cldr.UnknownLocaleError, \"No locale was identified for territory \\\"com\\\"\"}}","ref":"Plausible.Cldr.Locale.html#locale_from_host/2-examples"},{"type":"function","title":"Plausible.Cldr.Locale.new/1","doc":"","ref":"Plausible.Cldr.Locale.html#new/1"},{"type":"function","title":"Plausible.Cldr.Locale.new!/1","doc":"","ref":"Plausible.Cldr.Locale.html#new!/1"},{"type":"function","title":"Plausible.Cldr.Locale.script_direction_from_locale/1","doc":"Returns the script direction for a locale.","ref":"Plausible.Cldr.Locale.html#script_direction_from_locale/1"},{"type":"function","title":"Arguments - Plausible.Cldr.Locale.script_direction_from_locale/1","doc":"* `language_tag` is any language tag returned by `Cldr.Locale.new/2`\n or any `locale_name` returned by `Cldr.known_locale_names/1`.","ref":"Plausible.Cldr.Locale.html#script_direction_from_locale/1-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.Locale.script_direction_from_locale/1","doc":"* The script direction which is either `:ltr` (for left-to-right\n scripts) or `:rtl` (for right-to-left scripts).","ref":"Plausible.Cldr.Locale.html#script_direction_from_locale/1-returns"},{"type":"function","title":"Examples - Plausible.Cldr.Locale.script_direction_from_locale/1","doc":"iex> Plausible.Cldr.Locale.script_direction_from_locale \"en-US\"\n :ltr\n\n iex> Plausible.Cldr.Locale.script_direction_from_locale :ar\n :rtl","ref":"Plausible.Cldr.Locale.html#script_direction_from_locale/1-examples"},{"type":"function","title":"Plausible.Cldr.Locale.territory_from_host/1","doc":"Returns the last segment of a host that might\nbe a territory.","ref":"Plausible.Cldr.Locale.html#territory_from_host/1"},{"type":"function","title":"Arguments - Plausible.Cldr.Locale.territory_from_host/1","doc":"* `host` is any valid host name","ref":"Plausible.Cldr.Locale.html#territory_from_host/1-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.Locale.territory_from_host/1","doc":"* `{:ok, territory}` or\n\n* `{:error, {exception, reason}}`","ref":"Plausible.Cldr.Locale.html#territory_from_host/1-returns"},{"type":"function","title":"Examples - Plausible.Cldr.Locale.territory_from_host/1","doc":"iex> Cldr.Locale.territory_from_host(\"a.b.com.au\")\n {:ok, :AU}\n\n iex> Cldr.Locale.territory_from_host(\"a.b.com\")\n {:error,\n {Cldr.UnknownLocaleError, \"No locale was identified for territory \\\"com\\\"\"}}","ref":"Plausible.Cldr.Locale.html#territory_from_host/1-examples"},{"type":"function","title":"Plausible.Cldr.Locale.territory_from_locale/1","doc":"Returns the territory from a language tag or\nlocale name.","ref":"Plausible.Cldr.Locale.html#territory_from_locale/1"},{"type":"function","title":"Arguments - Plausible.Cldr.Locale.territory_from_locale/1","doc":"* `locale` is any language tag returned by\n `Plausible.Cldr.Locale.new/1`\n or a locale name in the list returned by\n `Plausible.Cldr.known_locale_names/0`","ref":"Plausible.Cldr.Locale.html#territory_from_locale/1-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.Locale.territory_from_locale/1","doc":"* A territory code as an atom","ref":"Plausible.Cldr.Locale.html#territory_from_locale/1-returns"},{"type":"function","title":"Examples - Plausible.Cldr.Locale.territory_from_locale/1","doc":"iex> Plausible.Cldr.Locale.territory_from_locale \"en-US\"\n :US\n\n iex> Plausible.Cldr.Locale.territory_from_locale \"en-US-u-rg-GBzzzz\"\n :GB","ref":"Plausible.Cldr.Locale.html#territory_from_locale/1-examples"},{"type":"function","title":"Plausible.Cldr.Locale.timezone_from_locale/1","doc":"Returns the time zone from a language tag or\nlocale name.","ref":"Plausible.Cldr.Locale.html#timezone_from_locale/1"},{"type":"function","title":"Arguments - Plausible.Cldr.Locale.timezone_from_locale/1","doc":"* `locale` is any language tag returned by\n `Plausible.Cldr.Locale.new/1`\n or a locale name in the list returned by\n `Plausible.Cldr.known_locale_names/0`","ref":"Plausible.Cldr.Locale.html#timezone_from_locale/1-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.Locale.timezone_from_locale/1","doc":"* A time zone ID as a string or\n\n* `:error` if no time zone can be determined","ref":"Plausible.Cldr.Locale.html#timezone_from_locale/1-returns"},{"type":"function","title":"Examples - Plausible.Cldr.Locale.timezone_from_locale/1","doc":"iex> Plausible.Cldr.Locale.timezone_from_locale \"en-US-u-tz-ausyd\"\n \"Australia/Sydney\"","ref":"Plausible.Cldr.Locale.html#timezone_from_locale/1-examples"},{"type":"module","title":"Plausible.Cldr.Number","doc":"Formats numbers and currencies based upon CLDR's decimal formats specification.\n\nThe format specification is documentated in [Unicode TR35](http://unicode.org/reports/tr35/tr35-numbers.html#Number_Formats).\nThere are several classes of formatting including non-scientific, scientific,\nrules based (for spelling and ordinal formats), compact formats that display `1k`\nrather than `1,000` and so on. See `Cldr.Number.to_string/2` for specific formatting\noptions.\n\n#","ref":"Plausible.Cldr.Number.html"},{"type":"module","title":"Non-Scientific Notation Formatting - Plausible.Cldr.Number","doc":"The following description applies to formats that do not use scientific\nnotation or significant digits:\n\n* If the number of actual integer digits exceeds the maximum integer digits,\n then only the least significant digits are shown. For example, 1997 is\n formatted as \"97\" if the maximum integer digits is set to 2.\n\n* If the number of actual integer digits is less than the minimum integer\n digits, then leading zeros are added. For example, 1997 is formatted as\n \"01997\" if the minimum integer digits is set to 5.\n\n* If the number of actual fraction digits exceeds the maximum fraction\n digits, then half-even rounding it performed to the maximum fraction\n digits. For example, 0.125 is formatted as \"0.12\" if the maximum fraction\n digits is 2. This behavior can be changed by specifying a rounding\n increment and a rounding mode.\n\n* If the number of actual fraction digits is less than the minimum fraction\n digits, then trailing zeros are added. For example, 0.125 is formatted as\n \"0.1250\" if the minimum fraction digits is set to 4.\n\n* Trailing fractional zeros are not displayed if they occur j positions after\n the decimal, where j is less than the maximum fraction digits. For example,\n 0.10004 is formatted as \"0.1\" if the maximum fraction digits is four or\n less.\n\n#","ref":"Plausible.Cldr.Number.html#module-non-scientific-notation-formatting"},{"type":"module","title":"Scientific Notation Formatting - Plausible.Cldr.Number","doc":"Numbers in scientific notation are expressed as the product of a mantissa and\na power of ten, for example, 1234 can be expressed as 1.234 x 10^3. The\nmantissa is typically in the half-open interval [1.0, 10.0) or sometimes\n[0.0, 1.0), but it need not be. In a pattern, the exponent character\nimmediately followed by one or more digit characters indicates scientific\nnotation. Example: \"0.###E0\" formats the number 1234 as \"1.234E3\".\n\n* The number of digit characters after the exponent character gives the\n minimum exponent digit count. There is no maximum. Negative exponents are\n formatted using the localized minus sign, not the prefix and suffix from\n the pattern. This allows patterns such as \"0.###E0 m/s\". To prefix positive\n exponents with a localized plus sign, specify '+' between the exponent and\n the digits: \"0.###E+0\" will produce formats \"1E+1\", \"1E+0\", \"1E-1\", and so\n on. (In localized patterns, use the localized plus sign rather than '+'.)\n\n* The minimum number of integer digits is achieved by adjusting the exponent.\n Example: 0.00123 formatted with \"00.###E0\" yields \"12.3E-4\". This only\n happens if there is no maximum number of integer digits. If there is a\n maximum, then the minimum number of integer digits is fixed at one.\n\n* The maximum number of integer digits, if present, specifies the exponent\n grouping. The most common use of this is to generate engineering notation,\n in which the exponent is a multiple of three, for example, \"##0.###E0\". The\n number 12345 is formatted using \"##0.####E0\" as \"12.345E3\".\n\n* When using scientific notation, the formatter controls the digit counts\n using significant digits logic. The maximum number of significant digits\n limits the total number of integer and fraction digits that will be shown\n in the mantissa; it does not affect parsing. For example, 12345 formatted\n with \"##0.##E0\" is \"12.3E3\". Exponential patterns may not contain grouping\n separators.\n\n#","ref":"Plausible.Cldr.Number.html#module-scientific-notation-formatting"},{"type":"module","title":"Significant Digits - Plausible.Cldr.Number","doc":"There are two ways of controlling how many digits are shows: (a)\nsignificant digits counts, or (b) integer and fraction digit counts. Integer\nand fraction digit counts are described above. When a formatter is using\nsignificant digits counts, it uses however many integer and fraction digits\nare required to display the specified number of significant digits. It may\nignore min/max integer/fraction digits, or it may use them to the extent\npossible.","ref":"Plausible.Cldr.Number.html#module-significant-digits"},{"type":"function","title":"Plausible.Cldr.Number.parse/2","doc":"Parse a string locale-aware manner and return\na number.","ref":"Plausible.Cldr.Number.html#parse/2"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.parse/2","doc":"* `string` is any `String.t`\n\n* `options` is a keyword list of options","ref":"Plausible.Cldr.Number.html#parse/2-arguments"},{"type":"function","title":"Options - Plausible.Cldr.Number.parse/2","doc":"* `:number` is one of `:integer`, `:float`,\n `:decimal` or `nil`. The default is `nil`\n meaning that the type auto-detected as either\n an `integer` or a `float`.\n\n* `:locale` is any locale returned by\n `Plausible.Cldr.known_locale_names/0`\n or a `Cldr.LanguageTag.t`. The default is\n `Plausible.Cldr.get_locale/0`.","ref":"Plausible.Cldr.Number.html#parse/2-options"},{"type":"function","title":"Returns - Plausible.Cldr.Number.parse/2","doc":"* A number of the requested or default type or\n\n* `{:error, {exception, error}}` if no number could be determined","ref":"Plausible.Cldr.Number.html#parse/2-returns"},{"type":"function","title":"Notes - Plausible.Cldr.Number.parse/2","doc":"This function parses a string to return a number but\nin a locale-aware manner. It will normalise grouping\ncharacters and decimal separators, different forms of\nthe `+` and `-` symbols that appear in Unicode and\nstrips any `_` characters that might be used for\nformatting in a string. It then parses the number\nusing the Elixir standard library functions.","ref":"Plausible.Cldr.Number.html#parse/2-notes"},{"type":"function","title":"Examples - Plausible.Cldr.Number.parse/2","doc":"iex> Plausible.Cldr.Number.parse(\"＋1.000,34\", locale: \"de\")\n {:ok, 1000.34}\n\n iex> Plausible.Cldr.Number.parse(\"-1_000_000.34\")\n {:ok, -1000000.34}\n\n iex> Plausible.Cldr.Number.parse(\"1.000\", locale: \"de\", number: :integer)\n {:ok, 1000}\n\n iex> Plausible.Cldr.Number.parse(\"＋1.000,34\", locale: \"de\", number: :integer)\n {:error,\n {Cldr.Number.ParseError,\n \"The string \\\"＋1.000,34\\\" could not be parsed as a number\"}}","ref":"Plausible.Cldr.Number.html#parse/2-examples"},{"type":"function","title":"Plausible.Cldr.Number.resolve_currencies/2","doc":"Resolve curencies from strings within\na list.","ref":"Plausible.Cldr.Number.html#resolve_currencies/2"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.resolve_currencies/2","doc":"* `list` is any list in which currency\n names and symbols are expected\n\n* `options` is a keyword list of options","ref":"Plausible.Cldr.Number.html#resolve_currencies/2-arguments"},{"type":"function","title":"Options - Plausible.Cldr.Number.resolve_currencies/2","doc":"* `:locale` is any valid locale returned by `Cldr.known_locale_names/1`\n or a `Cldr.LanguageTag` struct returned by `Cldr.Locale.new!/2`\n The default is `Plausible.Cldr.get_locale()`\n\n* `:only` is an `atom` or list of `atoms` representing the\n currencies or currency types to be considered for a match.\n The equates to a list of acceptable currencies for parsing.\n See the notes below for currency types.\n\n* `:except` is an `atom` or list of `atoms` representing the\n currencies or currency types to be not considered for a match.\n This equates to a list of unacceptable currencies for parsing.\n See the notes below for currency types.\n\n* `:fuzzy` is a float greater than `0.0` and less than or\n equal to `1.0` which is used as input to\n `String.jaro_distance/2` to determine is the provided\n currency string is *close enough* to a known currency\n string for it to identify definitively a currency code.\n It is recommended to use numbers greater than `0.8` in\n order to reduce false positives.","ref":"Plausible.Cldr.Number.html#resolve_currencies/2-options"},{"type":"function","title":"Notes - Plausible.Cldr.Number.resolve_currencies/2","doc":"The `:only` and `:except` options accept a list of\ncurrency codes and/or currency types. The following\ntypes are recognised.\n\nIf both `:only` and `:except` are specified,\nthe `:except` entries take priority - that means\nany entries in `:except` are removed from the `:only`\nentries.\n\n * `:all`, the default, considers all currencies\n\n * `:current` considers those currencies that have a `:to`\n date of nil and which also is a known ISO4217 currency\n\n * `:historic` is the opposite of `:current`\n\n * `:tender` considers currencies that are legal tender\n\n * `:unannotated` considers currencies that don't have\n \"(some string)\" in their names. These are usually\n financial instruments.","ref":"Plausible.Cldr.Number.html#resolve_currencies/2-notes"},{"type":"function","title":"Examples - Plausible.Cldr.Number.resolve_currencies/2","doc":"iex> Plausible.Cldr.Number.scan(\"100 US dollars\")\n ...> |> Plausible.Cldr.Number.resolve_currencies\n [100, :USD]\n\n iex> Plausible.Cldr.Number.scan(\"100 eurosports\")\n ...> |> Plausible.Cldr.Number.resolve_currencies(fuzzy: 0.75)\n [100, :EUR]\n\n iex> Plausible.Cldr.Number.scan(\"100 dollars des États-Unis\")\n ...> |> Plausible.Cldr.Number.resolve_currencies(locale: \"fr\")\n [100, :USD]","ref":"Plausible.Cldr.Number.html#resolve_currencies/2-examples"},{"type":"function","title":"Plausible.Cldr.Number.resolve_currency/2","doc":"Resolve a currency from a string","ref":"Plausible.Cldr.Number.html#resolve_currency/2"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.resolve_currency/2","doc":"* `list` is any list in which currency\n names and symbols are expected\n\n* `options` is a keyword list of options","ref":"Plausible.Cldr.Number.html#resolve_currency/2-arguments"},{"type":"function","title":"Options - Plausible.Cldr.Number.resolve_currency/2","doc":"* `:locale` is any valid locale returned by `Cldr.known_locale_names/1`\n or a `Cldr.LanguageTag` struct returned by `Cldr.Locale.new!/2`\n The default is `Plausible.Cldr.get_locale()`\n\n* `:only` is an `atom` or list of `atoms` representing the\n currencies or currency types to be considered for a match.\n The equates to a list of acceptable currencies for parsing.\n See the notes below for currency types.\n\n* `:except` is an `atom` or list of `atoms` representing the\n currencies or currency types to be not considered for a match.\n This equates to a list of unacceptable currencies for parsing.\n See the notes below for currency types.\n\n* `:fuzzy` is a float greater than `0.0` and less than or\n equal to `1.0` which is used as input to\n `String.jaro_distance/2` to determine is the provided\n currency string is *close enough* to a known currency\n string for it to identify definitively a currency code.\n It is recommended to use numbers greater than `0.8` in\n order to reduce false positives.","ref":"Plausible.Cldr.Number.html#resolve_currency/2-options"},{"type":"function","title":"Returns - Plausible.Cldr.Number.resolve_currency/2","doc":"* An ISO4217 currency code as an atom or\n\n* `{:error, {exception, message}}`","ref":"Plausible.Cldr.Number.html#resolve_currency/2-returns"},{"type":"function","title":"Notes - Plausible.Cldr.Number.resolve_currency/2","doc":"The `:only` and `:except` options accept a list of\ncurrency codes and/or currency types. The following\ntypes are recognised.\n\nIf both `:only` and `:except` are specified,\nthe `:except` entries take priority - that means\nany entries in `:except` are removed from the `:only`\nentries.\n\n * `:all`, the default, considers all currencies\n\n * `:current` considers those currencies that have a `:to`\n date of nil and which also is a known ISO4217 currency\n\n * `:historic` is the opposite of `:current`\n\n * `:tender` considers currencies that are legal tender\n\n * `:unannotated` considers currencies that don't have\n \"(some string)\" in their names. These are usually\n financial instruments.","ref":"Plausible.Cldr.Number.html#resolve_currency/2-notes"},{"type":"function","title":"Examples - Plausible.Cldr.Number.resolve_currency/2","doc":"iex> Plausible.Cldr.Number.resolve_currency(\"US dollars\")\n [:USD]\n\n iex> Plausible.Cldr.Number.resolve_currency(\"100 eurosports\", fuzzy: 0.75)\n [:EUR]\n\n iex> Plausible.Cldr.Number.resolve_currency(\"dollars des États-Unis\", locale: \"fr\")\n [:USD]\n\n iex> Plausible.Cldr.Number.resolve_currency(\"not a known currency\", locale: \"fr\")\n {:error,\n {Cldr.UnknownCurrencyError,\n \"The currency \\\"not a known currency\\\" is unknown or not supported\"}}","ref":"Plausible.Cldr.Number.html#resolve_currency/2-examples"},{"type":"function","title":"Plausible.Cldr.Number.resolve_per/2","doc":"Resolve and tokenize percent or permille\nfrom the beginning and/or the end of a string","ref":"Plausible.Cldr.Number.html#resolve_per/2"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.resolve_per/2","doc":"* `list` is any list in which percent\n and permille symbols are expected\n\n* `options` is a keyword list of options","ref":"Plausible.Cldr.Number.html#resolve_per/2-arguments"},{"type":"function","title":"Options - Plausible.Cldr.Number.resolve_per/2","doc":"* `:locale` is any valid locale returned by `Cldr.known_locale_names/1`\n or a `Cldr.LanguageTag` struct returned by `Cldr.Locale.new!/2`\n The default is `options[:backend].get_locale()`","ref":"Plausible.Cldr.Number.html#resolve_per/2-options"},{"type":"function","title":"Returns - Plausible.Cldr.Number.resolve_per/2","doc":"* An `:percent` or `permille` or\n\n* `{:error, {exception, message}}`","ref":"Plausible.Cldr.Number.html#resolve_per/2-returns"},{"type":"function","title":"Examples - Plausible.Cldr.Number.resolve_per/2","doc":"iex> Plausible.Cldr.Number.resolve_per \"11%\"\n [\"11\", :percent]\n\n iex> Plausible.Cldr.Number.resolve_per \"% of linguists\"\n [:percent, \" of linguists\"]\n\n iex> Plausible.Cldr.Number.resolve_per \"% of linguists %\"\n [:percent, \" of linguists \", :percent]","ref":"Plausible.Cldr.Number.html#resolve_per/2-examples"},{"type":"function","title":"Plausible.Cldr.Number.resolve_pers/2","doc":"Resolve and tokenize percent and permille\nsybols from strings within a list.\n\nPercent and permille symbols can be identified\nat the beginning and/or the end of a string.","ref":"Plausible.Cldr.Number.html#resolve_pers/2"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.resolve_pers/2","doc":"* `list` is any list in which percent and\n permille symbols are expected\n\n* `options` is a keyword list of options","ref":"Plausible.Cldr.Number.html#resolve_pers/2-arguments"},{"type":"function","title":"Options - Plausible.Cldr.Number.resolve_pers/2","doc":"* `:locale` is any valid locale returned by `Cldr.known_locale_names/1`\n or a `t:Cldr.LanguageTag` struct returned by `Cldr.Locale.new!/2`\n The default is `options[:backend].get_locale()`","ref":"Plausible.Cldr.Number.html#resolve_pers/2-options"},{"type":"function","title":"Examples - Plausible.Cldr.Number.resolve_pers/2","doc":"iex> Plausible.Cldr.Number.scan(\"100%\")\n ...> |> Plausible.Cldr.Number.resolve_pers()\n [100, :percent]","ref":"Plausible.Cldr.Number.html#resolve_pers/2-examples"},{"type":"function","title":"Plausible.Cldr.Number.scan/2","doc":"Scans a string locale-aware manner and returns\na list of strings and numbers.","ref":"Plausible.Cldr.Number.html#scan/2"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.scan/2","doc":"* `string` is any `String.t`\n\n* `options` is a keyword list of options","ref":"Plausible.Cldr.Number.html#scan/2-arguments"},{"type":"function","title":"Options - Plausible.Cldr.Number.scan/2","doc":"* `:number` is one of `:integer`, `:float`,\n `:decimal` or `nil`. The default is `nil`\n meaning that the type auto-detected as either\n an `integer` or a `float`.\n\n* `:locale` is any locale returned by `Cldr.known_locale_names/1`\n or a `Cldr.LanguageTag.t`. The default is `Plausible.Cldr.get_locale/0`.","ref":"Plausible.Cldr.Number.html#scan/2-options"},{"type":"function","title":"Returns - Plausible.Cldr.Number.scan/2","doc":"* A list of strings and numbers","ref":"Plausible.Cldr.Number.html#scan/2-returns"},{"type":"function","title":"Notes - Plausible.Cldr.Number.scan/2","doc":"Number parsing is performed by `Cldr.Number.Parser.parse/2`\nand any options provided are passed to that function.","ref":"Plausible.Cldr.Number.html#scan/2-notes"},{"type":"function","title":"Examples - Plausible.Cldr.Number.scan/2","doc":"iex> Plausible.Cldr.Number.scan(\"£1_000_000.34\")\n [\"£\", 1000000.34]\n\n iex> Plausible.Cldr.Number.scan(\"I want £1_000_000 dollars\")\n [\"I want £\", 1000000, \" dollars\"]\n\n iex> Plausible.Cldr.Number.scan(\"The prize is 23\")\n [\"The prize is \", 23]\n\n iex> Plausible.Cldr.Number.scan(\"The lottery number is 23 for the next draw\")\n [\"The lottery number is \", 23, \" for the next draw\"]\n\n iex> Plausible.Cldr.Number.scan(\"The loss is -1.000 euros\", locale: \"de\", number: :integer)\n [\"The loss is \", -1000, \" euros\"]","ref":"Plausible.Cldr.Number.html#scan/2-examples"},{"type":"function","title":"Plausible.Cldr.Number.to_approx_string/2","doc":"Formats a number and applies the `:approximately` format for\na locale and number system.","ref":"Plausible.Cldr.Number.html#to_approx_string/2"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.to_approx_string/2","doc":"* `number` is an integer, float or Decimal to be formatted\n\n* `options` is a keyword list defining how the number is to be formatted.\n See `Cldr.Number.to_string/3` for a description of the available\n options.","ref":"Plausible.Cldr.Number.html#to_approx_string/2-arguments"},{"type":"function","title":"Example - Plausible.Cldr.Number.to_approx_string/2","doc":"iex> Plausible.Cldr.Number.to_approx_string 1234\n {:ok, \"~1,234\"}","ref":"Plausible.Cldr.Number.html#to_approx_string/2-example"},{"type":"function","title":"Plausible.Cldr.Number.to_at_least_string/2","doc":"Formats a number and applies the `:at_least` format for\na locale and number system.","ref":"Plausible.Cldr.Number.html#to_at_least_string/2"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.to_at_least_string/2","doc":"* `number` is an integer, float or Decimal to be formatted\n\n* `options` is a keyword list defining how the number is to be formatted.\n See `Plausible.Cldr.Number.to_string/2` for a description of the available\n options.","ref":"Plausible.Cldr.Number.html#to_at_least_string/2-arguments"},{"type":"function","title":"Example - Plausible.Cldr.Number.to_at_least_string/2","doc":"iex> Plausible.Cldr.Number.to_at_least_string 1234\n {:ok, \"1,234+\"}","ref":"Plausible.Cldr.Number.html#to_at_least_string/2-example"},{"type":"function","title":"Plausible.Cldr.Number.to_at_most_string/2","doc":"Formats a number and applies the `:at_most` format for\na locale and number system.","ref":"Plausible.Cldr.Number.html#to_at_most_string/2"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.to_at_most_string/2","doc":"* `number` is an integer, float or Decimal to be formatted\n\n* `options` is a keyword list defining how the number is to be formatted.\n See `Cldr.Number.to_string/3` for a description of the available\n options.","ref":"Plausible.Cldr.Number.html#to_at_most_string/2-arguments"},{"type":"function","title":"Example - Plausible.Cldr.Number.to_at_most_string/2","doc":"iex> Plausible.Cldr.Number.to_at_most_string 1234\n {:ok, \"≤1,234\"}","ref":"Plausible.Cldr.Number.html#to_at_most_string/2-example"},{"type":"function","title":"Plausible.Cldr.Number.to_range_string/2","doc":"Formats the first and last numbers of a range and applies\nthe `:range` format for a locale and number system.","ref":"Plausible.Cldr.Number.html#to_range_string/2"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.to_range_string/2","doc":"* `number` is an integer, float or Decimal to be formatted\n\n* `options` is a keyword list defining how the number is to be formatted.\n See `Cldr.Number.to_string/3` for a description of the available\n options.","ref":"Plausible.Cldr.Number.html#to_range_string/2-arguments"},{"type":"function","title":"Example - Plausible.Cldr.Number.to_range_string/2","doc":"iex> Plausible.Cldr.Number.to_range_string 1234..5678\n {:ok, \"1,234–5,678\"}","ref":"Plausible.Cldr.Number.html#to_range_string/2-example"},{"type":"function","title":"Plausible.Cldr.Number.to_string/2","doc":"Returns a number formatted into a string according to a format pattern and options.","ref":"Plausible.Cldr.Number.html#to_string/2"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.to_string/2","doc":"* `number` is an integer, float or Decimal to be formatted\n\n* `options` is a keyword list defining how the number is to be formatted.","ref":"Plausible.Cldr.Number.html#to_string/2-arguments"},{"type":"function","title":"Options - Plausible.Cldr.Number.to_string/2","doc":"* `format`: the format style or a format string defining how the number is\n formatted. See `Cldr.Number.Format` for how format strings can be constructed.\n See `Cldr.Number.Format.format_styles_for/3` to return available format styles\n for a locale. The default `format` is `:standard`.\n\n* If `:format` is set to `:long` or `:short` then the formatting depends on\n whether `:currency` is specified. If not specified then the number is\n formatted as `:decimal_long` or `:decimal_short`. If `:currency` is\n specified the number is formatted as `:currency_long` or\n `:currency_short` and `:fractional_digits` is set to 0 as a default.\n\n* `:format` may also be a format defined by CLDR's Rules Based Number\n Formats (RBNF). Further information is found in the module `Cldr.Rbnf`.\n The most commonly used formats in this category are to spell out the\n number in a the locales language. The applicable formats are `:spellout`,\n `:spellout_year`, `:ordinal`. A number can also be formatted as roman\n numbers by using the format `:roman` or `:roman_lower`.\n\n* `currency`: is the currency for which the number is formatted. For\n available currencies see `Cldr.Currency.known_currencies/0`. This option\n is required if `:format` is set to `:currency`. If `currency` is set\n and no `:format` is set, `:format` will be set to `:currency` as well.\n\n* `currency_symbol`: Allows overriding a currency symbol. The alternatives\n are:\n * `:iso` the ISO currency code will be used instead of the default\n currency symbol.\n * `:narrow` uses the narrow symbol defined for the locale. The same\n narrow symbol can be defined for more than one currency and therefore this\n should be used with care. If no narrow symbol is defined, the standard\n symbol is used.\n * `:symbol` uses the standard symbol defined in CLDR. A symbol is unique\n for each currency and can be safely used.\n * \"string\" uses `string` as the currency symbol\n * `:standard` (the default and recommended) uses the CLDR-defined symbol\n based upon the currency format for the locale.\n\n* `:cash`: a boolean which indicates whether a number being formatted as a\n `:currency` is to be considered a cash value or not. Currencies can be\n rounded differently depending on whether `:cash` is `true` or `false`.\n *This option is deprecated in favour of `currency_digits: :cash`.\n\n* `:currency_digits` indicates which of the rounding and digits should be\n used. The options are `:accounting` which is the default, `:cash` or\n `:iso`\n\n* `:rounding_mode`: determines how a number is rounded to meet the precision\n of the format requested. The available rounding modes are `:down`,\n :half_up, :half_even, :ceiling, :floor, :half_down, :up. The default is\n `:half_even`.\n\n* `:number_system`: determines which of the number systems for a locale\n should be used to define the separators and digits for the formatted\n number. If `number_system` is an `atom` then `number_system` is\n interpreted as a number system. If the `:number_system` is\n `binary` then it is interpreted as a number system name. See\n `Cldr.Number.System.number_system_names_for/2`. The default is `:default`.\n\n* `:locale`: determines the locale in which the number is formatted. See\n `Cldr.known_locale_names/0`. The default is`Cldr.get_locale/0` which is the\n locale currently in affect for this `Process` and which is set by\n `Cldr.put_locale/1`.\n\n* If `:fractional_digits` is set to a positive integer value then the number\n will be rounded to that number of digits and displayed accordingly - overriding\n settings that would be applied by default. For example, currencies have\n fractional digits defined reflecting each currencies minor unit. Setting\n `:fractional_digits` will override that setting.\n\n* If `:maximum_integer_digits` is set to a positive integer value then the\n number is left truncated before formatting. For example if the number `1234`\n is formatted with the option `maximum_integer_digits: 2`, the number is\n truncated to `34` and formatted.\n\n* If `:round_nearest` is set to a positive integer value then the number\n will be rounded to nearest increment of that value - overriding\n settings that would be applied by default.\n\n* `:minimum_grouping_digits` overrides the CLDR definition of minimum grouping\n digits. For example in the locale `es` the number `1234` is formatted by default\n as `1345` because the locale defines the `minimium_grouping_digits` as `2`. If\n `minimum_grouping_digits: 1` is set as an option the number is formatting as\n `1.345`. The `:minimum_grouping_digits` is added to the grouping defined by\n the number format. If the sum of these two digits is greater than the number\n of digits in the integer (or fractional) part of the number then no grouping\n is performed.\n\n* `:wrapper` is a 2-arity function that will be called for each number component\n with parameters `string` and `tag` where `tag` is one of `:number`,\n `:currency_symbol`, `:currency_space`, `:literal`, `:quote`, `:percent`,\n `:permille`, `:minus` or `:plus`. The function must return a string. The\n function can be used to wrap format elements in HTML or other tags.","ref":"Plausible.Cldr.Number.html#to_string/2-options"},{"type":"function","title":"Locale extensions affecting formatting - Plausible.Cldr.Number.to_string/2","doc":"A locale identifier can specify options that affect number formatting.\nThese options are:\n\n* `nu`: defines the number system to be used if none is specified by the `:number_system`\n option to `to_string/2`\n\nThis key is part of the [u extension](https://unicode.org/reports/tr35/#u_Extension) and\nthat document should be consulted for details on how to construct a locale identifier with these\nextensions.","ref":"Plausible.Cldr.Number.html#to_string/2-locale-extensions-affecting-formatting"},{"type":"function","title":"Wrapping format elements - Plausible.Cldr.Number.to_string/2","doc":"Wrapping elements is particularly useful when formatting a number with a\ncurrency symbol and the requirement is to have different HTML formatting\napplied to the symbol than the number. For example:\n\n iex> Cldr.Number.to_string(100, format: :currency, currency: :USD, wrapper: fn\n ...> string, :currency_symbol -> \" \" <> string <> \" \"\n ...> string, :number -> \" \" <> string <> \" \"\n ...> string, :currency_space -> \" \" <> string <> \" \"\n ...> string, _other -> string\n ...> end)\n {:ok, \" $ 100.00 \"}\n\nIt is also possible and recommended to use the `Phoenix.HTML.Tag.content_tag/3`\nfunction if wrapping HTML tags since these will ensure HTML entities are\ncorrectly encoded. For example:\n\n iex> Cldr.Number.to_string(100, format: :currency, currency: :USD, wrapper: fn\n ...> string, :currency_symbol -> Phoenix.HTML.Tag.content_tag(:span, string, class: \"symbol\")\n ...> string, :number -> Phoenix.HTML.Tag.content_tag(:span, string, class: \"number\")\n ...> string, :currency_space -> Phoenix.HTML.Tag.content_tag(:span, string)\n ...> string, _other -> string\n ...> end)\n {:ok, \" $ 100.00 \"}\n\nWhen formatting a number the format is parsed into format elements that might include\na currency symbol, a literal string, inserted text between a currency symbol and the\ncurrency amount, a percent sign, the number itself and several other elements. In\nsome cases it is helpful to be apply specific formatting to each element.\nThis can be achieved by specifying a `:wrapper` option. This option takes a 2-arity\nfunction as an argument. For each element of the format the wrapper function is called\nwith two parameters: the format element as a string and an atom representing the\nelement type. The wrapper function is required to return a string that is then\ninserted in the final formatted number.","ref":"Plausible.Cldr.Number.html#to_string/2-wrapping-format-elements"},{"type":"function","title":"Returns - Plausible.Cldr.Number.to_string/2","doc":"* `{:ok, string}` or\n\n* `{:error, {exception, message}}`","ref":"Plausible.Cldr.Number.html#to_string/2-returns"},{"type":"function","title":"Examples - Plausible.Cldr.Number.to_string/2","doc":"iex> Plausible.Cldr.Number.to_string 12345\n {:ok, \"12,345\"}\n\n iex> Plausible.Cldr.Number.to_string 12345, locale: \"fr\"\n {:ok, \"12 345\"}\n\n iex> Plausible.Cldr.Number.to_string 1345.32, currency: :EUR, locale: \"es\", minimum_grouping_digits: 1\n {:ok, \"1.345,32 €\"}\n\n iex> Plausible.Cldr.Number.to_string 1345.32, currency: :EUR, locale: \"es\"\n {:ok, \"1345,32 €\"}\n\n iex> Plausible.Cldr.Number.to_string 12345, locale: \"fr\", currency: \"USD\"\n {:ok, \"12 345,00 $US\"}\n\n iex> Plausible.Cldr.Number.to_string 12345, format: \"#E0\"\n {:ok, \"1.2345E4\"}\n\n iex> Plausible.Cldr.Number.to_string 12345, format: :accounting, currency: \"THB\"\n {:ok, \"THB 12,345.00\"}\n\n iex> Plausible.Cldr.Number.to_string -12345, format: :accounting, currency: \"THB\"\n {:ok, \"(THB 12,345.00)\"}\n\n iex> Plausible.Cldr.Number.to_string 12345, format: :accounting, currency: \"THB\",\n ...> locale: \"th\"\n {:ok, \"฿12,345.00\"}\n\n iex> Plausible.Cldr.Number.to_string 12345, format: :accounting, currency: \"THB\",\n ...> locale: \"th\", number_system: :native\n {:ok, \"฿๑๒,๓๔๕.๐๐\"}\n\n iex> Plausible.Cldr.Number.to_string 1244.30, format: :long\n {:ok, \"1 thousand\"}\n\n iex> Plausible.Cldr.Number.to_string 1244.30, format: :long, currency: \"USD\"\n {:ok, \"1,244 US dollars\"}\n\n iex> Plausible.Cldr.Number.to_string 1244.30, format: :short\n {:ok, \"1K\"}\n\n iex> Plausible.Cldr.Number.to_string 1244.30, format: :short, currency: \"EUR\"\n {:ok, \"€1K\"}\n\n iex> Plausible.Cldr.Number.to_string 1234, format: :spellout\n {:ok, \"one thousand two hundred thirty-four\"}\n\n iex> Plausible.Cldr.Number.to_string 1234, format: :spellout_verbose\n {:ok, \"one thousand two hundred and thirty-four\"}\n\n iex> Plausible.Cldr.Number.to_string 1989, format: :spellout_year\n {:ok, \"nineteen eighty-nine\"}\n\n iex> Plausible.Cldr.Number.to_string 123, format: :ordinal\n {:ok, \"123rd\"}\n\n iex> Plausible.Cldr.Number.to_string 123, format: :roman\n {:ok, \"CXXIII\"}\n\n iex> Plausible.Cldr.Number.to_string 123, locale: \"th-u-nu-thai\"\n {:ok, \"๑๒๓\"}","ref":"Plausible.Cldr.Number.html#to_string/2-examples"},{"type":"function","title":"Errors - Plausible.Cldr.Number.to_string/2","doc":"An error tuple `{:error, reason}` will be returned if an error is detected.\nThe two most likely causes of an error return are:\n\n * A format cannot be compiled. In this case the error tuple will look like:\n\n```\n iex> Plausible.Cldr.Number.to_string(12345, format: \"0#\")\n {:error, {Cldr.FormatCompileError,\n \"Decimal format compiler: syntax error before: \\\"#\\\"\"}}\n```\n\n * The format style requested is not defined for the `locale` and\n `number_system`. This happens typically when the number system is\n `:algorithmic` rather than the more common `:numeric`. In this case the error\n return looks like:\n\n```\n iex> Plausible.Cldr.Number.to_string(1234, locale: \"he\", number_system: \"hebr\", format: :percent)\n {:error, {Cldr.UnknownFormatError,\n \"The locale :he with number system :hebr does not define a format :percent\"}}\n```","ref":"Plausible.Cldr.Number.html#to_string/2-errors"},{"type":"function","title":"Plausible.Cldr.Number.to_string!/2","doc":"Same as the execution of `to_string/2` but raises an exception if an error would be\nreturned.","ref":"Plausible.Cldr.Number.html#to_string!/2"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.to_string!/2","doc":"* `number` is an integer, float or Decimal to be formatted\n\n* `options` is a keyword list defining how the number is to be formatted. See\n `Plausible.Cldr.Number.to_string/2`","ref":"Plausible.Cldr.Number.html#to_string!/2-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.Number.to_string!/2","doc":"* a formatted number as a string or\n\n* raises an exception","ref":"Plausible.Cldr.Number.html#to_string!/2-returns"},{"type":"function","title":"Examples - Plausible.Cldr.Number.to_string!/2","doc":"iex> Plausible.Cldr.Number.to_string! 12345\n \"12,345\"\n\n iex> Plausible.Cldr.Number.to_string! 12345, locale: \"fr\"\n \"12 345\"","ref":"Plausible.Cldr.Number.html#to_string!/2-examples"},{"type":"function","title":"Plausible.Cldr.Number.validate_number_system/2","doc":"Return a valid number system from a provided locale and number\nsystem name or type.\n\nThe number system or number system type must be valid for the\ngiven locale. If a number system type is provided, the\nunderlying number system is returned.","ref":"Plausible.Cldr.Number.html#validate_number_system/2"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.validate_number_system/2","doc":"* `locale` is any valid locale name returned by `Cldr.known_locale_names/1`\n or a `Cldr.LanguageTag` struct returned by `Cldr.Locale.new!/2`\n\n* `system_name` is any number system name returned by\n `Cldr.known_number_systems/0` or a number system type\n returned by `Cldr.known_number_system_types/0`","ref":"Plausible.Cldr.Number.html#validate_number_system/2-arguments"},{"type":"function","title":"Examples - Plausible.Cldr.Number.validate_number_system/2","doc":"iex> Plausible.Cldr.Number.validate_number_system \"en\", :latn\n {:ok, :latn}\n\n iex> Plausible.Cldr.Number.validate_number_system \"en\", :default\n {:ok, :latn}\n\n iex> Plausible.Cldr.Number.validate_number_system \"en\", :unknown\n {:error,\n {Cldr.UnknownNumberSystemError, \"The number system :unknown is unknown\"}}\n\n iex> Plausible.Cldr.Number.validate_number_system \"zz\", :default\n {:error, {Cldr.InvalidLanguageError, \"The language \\\"zz\\\" is invalid\"}}","ref":"Plausible.Cldr.Number.html#validate_number_system/2-examples"},{"type":"module","title":"Plausible.Cldr.Number.Cardinal","doc":"Implements cardinal plural rules for numbers.","ref":"Plausible.Cldr.Number.Cardinal.html"},{"type":"function","title":"Plausible.Cldr.Number.Cardinal.available_locale_names/0","doc":"The locale names for which plural rules are defined.","ref":"Plausible.Cldr.Number.Cardinal.html#available_locale_names/0"},{"type":"function","title":"Plausible.Cldr.Number.Cardinal.known_locale_names/0","doc":"The configured locales for which plural rules are defined.\n\nReturns the intersection of `Plausible.Cldr.known_locale_names/0` and\nthe locales for which Cardinal plural rules are defined.\n\nThere are many `Cldr` locales which don't have their own plural\nrules so this list is the intersection of `Cldr`'s configured\nlocales and those that have rules.","ref":"Plausible.Cldr.Number.Cardinal.html#known_locale_names/0"},{"type":"function","title":"Plausible.Cldr.Number.Cardinal.plural_rule/3","doc":"Return the plural key for a given number in a given locale\n\nReturns which plural key (`:zero`, `:one`, `:two`, `:few`,\n`:many` or `:other`) a given number fits into within the\ncontext of a given locale.\n\nNote that these key names should not be interpreted\nliterally. For example, the key returned from\n`Cldr.Number.Ordinal.plural_rule(0, \"en\")` is actually\n`:other`, not `:zero`.\n\nThis key can then be used to format a number, date, time, unit,\nlist or other content in a plural-sensitive way.","ref":"Plausible.Cldr.Number.Cardinal.html#plural_rule/3"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.Cardinal.plural_rule/3","doc":"* `number` is any `integer`, `float` or `Decimal`\n\n* `locale` is any locale returned by `Cldr.Locale.new!/2` or any\n `locale_name` returned by `Plausible.Cldr.known_locale_names/0`\n\n* `rounding` is one of `[:down, :up, :ceiling, :floor, :half_even, :half_up, :half_down]`. The\n default is `:half_even`.","ref":"Plausible.Cldr.Number.Cardinal.html#plural_rule/3-arguments"},{"type":"function","title":"Examples - Plausible.Cldr.Number.Cardinal.plural_rule/3","doc":"iex> Plausible.Cldr.Number.Cardinal.plural_rule 0, \"fr\"\n :one\n\n iex> Plausible.Cldr.Number.Cardinal.plural_rule 0, \"en\"\n :other","ref":"Plausible.Cldr.Number.Cardinal.html#plural_rule/3-examples"},{"type":"function","title":"Plausible.Cldr.Number.Cardinal.plural_rules/0","doc":"Returns all the plural rules defined in CLDR.","ref":"Plausible.Cldr.Number.Cardinal.html#plural_rules/0"},{"type":"function","title":"Plausible.Cldr.Number.Cardinal.plural_rules_for/1","doc":"Return the plural rules for a locale.","ref":"Plausible.Cldr.Number.Cardinal.html#plural_rules_for/1"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.Cardinal.plural_rules_for/1","doc":"* `locale` is any locale returned by `Plausible.Cldr.Locale.new!/1` or any\n `locale_name` returned by `Plausible.Cldr.known_locale_names/0`\n\nThe rules are returned in AST form after parsing.","ref":"Plausible.Cldr.Number.Cardinal.html#plural_rules_for/1-arguments"},{"type":"function","title":"Plausible.Cldr.Number.Cardinal.pluralize/3","doc":"Pluralize a number using cardinal plural rules\nand a substitution map.","ref":"Plausible.Cldr.Number.Cardinal.html#pluralize/3"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.Cardinal.pluralize/3","doc":"* `number` is an integer, float or Decimal\n\n* `locale` is any locale returned by `Plausible.Cldr.Locale.new!/1` or any\n `locale_name` returned by `Plausible.Cldr.known_locale_names/0`\n\n* `substitutions` is a map that maps plural keys to a string.\n The valid substitution keys are `:zero`, `:one`, `:two`,\n `:few`, `:many` and `:other`.\n\nSee also `Plausible.Cldr.Number.Cardinal.Cardinal.plural_rule/3`.","ref":"Plausible.Cldr.Number.Cardinal.html#pluralize/3-arguments"},{"type":"function","title":"Examples - Plausible.Cldr.Number.Cardinal.pluralize/3","doc":"iex> Plausible.Cldr.Number.Cardinal.pluralize 1, \"en\", %{one: \"one\"}\n \"one\"\n\n iex> Plausible.Cldr.Number.Cardinal.pluralize 2, \"en\", %{one: \"one\"}\n nil\n\n iex> Plausible.Cldr.Number.Cardinal.pluralize 2, \"en\", %{one: \"one\", two: \"two\", other: \"other\"}\n \"other\"\n\n iex> Plausible.Cldr.Number.Cardinal.pluralize 22, \"en\", %{one: \"one\", two: \"two\", other: \"other\"}\n \"other\"\n\n iex> Plausible.Cldr.Number.Cardinal.pluralize Decimal.new(1), \"en\", %{one: \"one\"}\n \"one\"\n\n iex> Plausible.Cldr.Number.Cardinal.pluralize Decimal.new(2), \"en\", %{one: \"one\"}\n nil\n\n iex> Plausible.Cldr.Number.Cardinal.pluralize Decimal.new(2), \"en\", %{one: \"one\", two: \"two\"}\n nil\n\n iex> Plausible.Cldr.Number.Cardinal.pluralize 1..10, \"ar\", %{one: \"one\", few: \"few\", other: \"other\"}\n \"few\"\n\n iex> Plausible.Cldr.Number.Cardinal.pluralize 1..10, \"en\", %{one: \"one\", few: \"few\", other: \"other\"}\n \"other\"","ref":"Plausible.Cldr.Number.Cardinal.html#pluralize/3-examples"},{"type":"module","title":"Plausible.Cldr.Number.Format","doc":"Functions to manage the collection of number patterns defined in Cldr.\n\nNumber patterns affect how numbers are interpreted in a localized context.\nHere are some examples, based on the French locale. The \".\" shows where the\ndecimal point should go. The \",\" shows where the thousands separator should\ngo. A \"0\" indicates zero-padding: if the number is too short, a zero (in the\nlocale's numeric set) will go there. A \"#\" indicates no padding: if the\nnumber is too short, nothing goes there. A \"¤\" shows where the currency sign\nwill go. The following illustrates the effects of different patterns for the\nFrench locale, with the number \"1234.567\". Notice how the pattern characters\n',' and '.' are replaced by the characters appropriate for the locale.","ref":"Plausible.Cldr.Number.Format.html"},{"type":"module","title":"Number Pattern Examples - Plausible.Cldr.Number.Format","doc":"| Pattern\t | Currency\t | Text |\n| ------------- | :-------------: | ----------: |\n| #,##0.##\t | n/a\t | 1 234,57 |\n| #,##0.###\t | n/a\t | 1 234,567 |\n| ###0.#####\t | n/a\t | 1234,567 |\n| ###0.0000#\t | n/a\t | 1234,5670 |\n| 00000.0000\t | n/a\t | 01234,5670 |\n| #,##0.00 ¤\t | EUR\t | 1 234,57 € |\n\nThe number of # placeholder characters before the decimal do not matter,\nsince no limit is placed on the maximum number of digits. There should,\nhowever, be at least one zero some place in the pattern. In currency formats,\nthe number of digits after the decimal also do not matter, since the\ninformation in the supplemental data (see Supplemental Currency Data) is used\nto override the number of decimal places — and the rounding — according to\nthe currency that is being formatted. That can be seen in the above chart,\nwith the difference between Yen and Euro formatting.\n\nDetails of the number formats are described in the\n[Unicode documentation](http://unicode.org/reports/tr35/tr35-numbers.html#Number_Format_Patterns)","ref":"Plausible.Cldr.Number.Format.html#module-number-pattern-examples"},{"type":"function","title":"Plausible.Cldr.Number.Format.all_formats_for/1","doc":"Returns the decimal formats defined for a given locale.","ref":"Plausible.Cldr.Number.Format.html#all_formats_for/1"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.Format.all_formats_for/1","doc":"* `locale` is any valid locale name returned by\n `Plausible.Cldr.known_locale_names/0`\n or a `Cldr.LanguageTag` struct returned by\n `Plausible.Cldr.Locale.new!/1`. The default\n is `Plausible.Cldr.get_locale/0`.","ref":"Plausible.Cldr.Number.Format.html#all_formats_for/1-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.Number.Format.all_formats_for/1","doc":"* `{:ok, map}` where map is a map of decimal formats\n keyed by number system or\n\n* `{:error, {exception, message}}`","ref":"Plausible.Cldr.Number.Format.html#all_formats_for/1-returns"},{"type":"function","title":"Plausible.Cldr.Number.Format.all_formats_for!/1","doc":"Returns the decimal formats defined for a given locale.","ref":"Plausible.Cldr.Number.Format.html#all_formats_for!/1"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.Format.all_formats_for!/1","doc":"* `locale` is any valid locale name returned by\n `Plausible.Cldr.known_locale_names/0`\n or a `Cldr.LanguageTag` struct returned by\n `Plausible.Cldr.Locale.new!/1`. The default\n is `Plausible.Cldr.get_locale/0`.","ref":"Plausible.Cldr.Number.Format.html#all_formats_for!/1-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.Number.Format.all_formats_for!/1","doc":"* `{:ok, map}` where map is a map of decimal formats\n keyed by number system or\n\n* raises an exception.\n\nSee `Plausible.Cldr.Number.Format.Number.Format.all_formats_for/1` for further information.","ref":"Plausible.Cldr.Number.Format.html#all_formats_for!/1-returns"},{"type":"function","title":"Plausible.Cldr.Number.Format.currency_spacing/2","doc":"Returns the currency space for a given locale and\nnumber system.","ref":"Plausible.Cldr.Number.Format.html#currency_spacing/2"},{"type":"function","title":"Plausible.Cldr.Number.Format.decimal_format_list/0","doc":"Returns the list of decimal formats in the configured locales including\nthe list of locales configured for precompilation in `config.exs`.\n\nThis function exists to allow the decimal formatter\nto precompile all the known formats at compile time.","ref":"Plausible.Cldr.Number.Format.html#decimal_format_list/0"},{"type":"function","title":"Example - Plausible.Cldr.Number.Format.decimal_format_list/0","doc":"#=> Plausible.Cldr.Number.Format.Format.decimal_format_list\n [\"#\", \"#,##,##0%\",\n \"#,##,##0.###\", \"#,##,##0.00¤\", \"#,##,##0.00¤;(#,##,##0.00¤)\",\n \"#,##,##0 %\", \"#,##0%\", \"#,##0.###\", \"#,##0.00 ¤\",\n \"#,##0.00 ¤;(#,##0.00 ¤)\", \"#,##0.00¤\", \"#,##0.00¤;(#,##0.00¤)\",\n \"#,##0 %\", \"#0%\", \"#0.######\", \"#0.00 ¤\", \"#E0\", \"%#,##0\", \"% #,##0\",\n \"0\", \"0.000000E+000\", \"0000 M ¤\", \"0000¤\", \"000G ¤\", \"000K ¤\", \"000M ¤\",\n \"000T ¤\", \"000mM ¤\", \"000m ¤\", \"000 Bio'.' ¤\", \"000 Bln ¤\", \"000 Bn ¤\",\n \"000 B ¤\", \"000 E ¤\", \"000 K ¤\", \"000 MRD ¤\", \"000 Md ¤\", \"000 Mio'.' ¤\",\n \"000 Mio ¤\", \"000 Mld ¤\", \"000 Mln ¤\", \"000 Mn ¤\", \"000 Mrd'.' ¤\",\n \"000 Mrd ¤\", \"000 Mr ¤\", \"000 M ¤\", \"000 NT ¤\", \"000 N ¤\", \"000 Tn ¤\",\n \"000 Tr ¤\", ...]","ref":"Plausible.Cldr.Number.Format.html#decimal_format_list/0-example"},{"type":"function","title":"Plausible.Cldr.Number.Format.decimal_format_list_for/1","doc":"Returns the list of decimal formats for a configured locale.","ref":"Plausible.Cldr.Number.Format.html#decimal_format_list_for/1"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.Format.decimal_format_list_for/1","doc":"* `locale` is any valid locale name returned by\n `Plausible.Cldr.known_locale_names/0`\n or a `Cldr.LanguageTag` struct returned by\n `Plausible.Cldr.Locale.new!/1`. The default\n is `Plausible.Cldr.get_locale/0`.\n\nThis function exists to allow the decimal formatter to precompile all\nthe known formats at compile time. Its use is not otherwise recommended.","ref":"Plausible.Cldr.Number.Format.html#decimal_format_list_for/1-arguments"},{"type":"function","title":"Example - Plausible.Cldr.Number.Format.decimal_format_list_for/1","doc":"iex> Plausible.Cldr.Number.Format.decimal_format_list_for(:en)\n {:ok, [\"#,##0%\", \"#,##0.###\", \"#,##0.00\", \"#,##0.00;(#,##0.00)\",\"#E0\",\n \"0 billion\", \"0 million\", \"0 thousand\",\n \"0 trillion\", \"00 billion\", \"00 million\", \"00 thousand\", \"00 trillion\",\n \"000 billion\", \"000 million\", \"000 thousand\", \"000 trillion\", \"000B\", \"000K\",\n \"000M\", \"000T\", \"00B\", \"00K\", \"00M\", \"00T\", \"0B\", \"0K\", \"0M\", \"0T\",\n \"¤#,##0.00\", \"¤#,##0.00;(¤#,##0.00)\", \"¤000B\", \"¤000K\", \"¤000M\",\n \"¤000T\", \"¤00B\", \"¤00K\", \"¤00M\", \"¤00T\", \"¤0B\", \"¤0K\", \"¤0M\", \"¤0T\",\n \"¤ #,##0.00\", \"¤ #,##0.00;(¤ #,##0.00)\", \"¤ 000B\", \"¤ 000K\", \"¤ 000M\",\n \"¤ 000T\", \"¤ 00B\", \"¤ 00K\", \"¤ 00M\", \"¤ 00T\", \"¤ 0B\", \"¤ 0K\", \"¤ 0M\", \"¤ 0T\"]}","ref":"Plausible.Cldr.Number.Format.html#decimal_format_list_for/1-example"},{"type":"function","title":"Plausible.Cldr.Number.Format.default_grouping_for/1","doc":"Returns the default grouping for a locale as a map.","ref":"Plausible.Cldr.Number.Format.html#default_grouping_for/1"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.Format.default_grouping_for/1","doc":"* `locale` is any valid locale name returned by\n `Plausible.Cldr.known_locale_names/0`\n or a `Cldr.LanguageTag` struct returned by\n `Plausible.Cldr.Locale.new!/1`. The default\n is `Plausible.Cldr.get_locale/0`.","ref":"Plausible.Cldr.Number.Format.html#default_grouping_for/1-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.Number.Format.default_grouping_for/1","doc":"* `{:ok, grouping}` or\n\n* `{:error, {exception, message}}`","ref":"Plausible.Cldr.Number.Format.html#default_grouping_for/1-returns"},{"type":"function","title":"Examples - Plausible.Cldr.Number.Format.default_grouping_for/1","doc":"iex> Plausible.Cldr.Number.Format.default_grouping_for(:en)\n {:ok, %{fraction: %{first: 0, rest: 0}, integer: %{first: 3, rest: 3}}}","ref":"Plausible.Cldr.Number.Format.html#default_grouping_for/1-examples"},{"type":"function","title":"Plausible.Cldr.Number.Format.default_grouping_for!/1","doc":"Returns the default grouping for a locale\nor raises on error.","ref":"Plausible.Cldr.Number.Format.html#default_grouping_for!/1"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.Format.default_grouping_for!/1","doc":"* `locale` is any valid locale name returned by\n `Plausible.Cldr.known_locale_names/0`\n or a `Cldr.LanguageTag` struct returned by\n `Plausible.Cldr.Locale.new!/1`. The default\n is `Plausible.Cldr.get_locale/0`.","ref":"Plausible.Cldr.Number.Format.html#default_grouping_for!/1-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.Number.Format.default_grouping_for!/1","doc":"* `grouping` as a map or\n\n* raises an exception.","ref":"Plausible.Cldr.Number.Format.html#default_grouping_for!/1-returns"},{"type":"function","title":"Examples - Plausible.Cldr.Number.Format.default_grouping_for!/1","doc":"iex> Plausible.Cldr.Number.Format.default_grouping_for!(:en)\n %{fraction: %{first: 0, rest: 0}, integer: %{first: 3, rest: 3}}","ref":"Plausible.Cldr.Number.Format.html#default_grouping_for!/1-examples"},{"type":"function","title":"Plausible.Cldr.Number.Format.formats_for/2","doc":"Return the predfined formats for a given `locale` and `number_system`.","ref":"Plausible.Cldr.Number.Format.html#formats_for/2"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.Format.formats_for/2","doc":"* `locale` is any valid locale name returned by\n `Plausible.Cldr.known_locale_names/0`\n or a `Cldr.LanguageTag` struct returned by\n `Plausible.Cldr.Locale.new!/1`. The default\n is `Plausible.Cldr.get_locale/0`.\n\n* `number_system` is any valid number system or number system type returned\n by `Plausible.Cldr.Number.System.number_systems_for/1`.","ref":"Plausible.Cldr.Number.Format.html#formats_for/2-arguments"},{"type":"function","title":"Example - Plausible.Cldr.Number.Format.formats_for/2","doc":"Plausible.Cldr.Number.Format.formats_for :fr, :native\n #=> %Cldr.Number.Format{\n accounting: \"#,##0.00 ¤;(#,##0.00 ¤)\",\n currency: \"#,##0.00 ¤\",\n percent: \"#,##0 %\",\n scientific: \"#E0\",\n standard: \"#,##0.###\"\n currency_short: [{\"1000\", [one: \"0 k ¤\", other: \"0 k ¤\"]},\n {\"10000\", [one: \"00 k ¤\", other: \"00 k ¤\"]},\n {\"100000\", [one: \"000 k ¤\", other: \"000 k ¤\"]},\n {\"1000000\", [one: \"0 M ¤\", other: \"0 M ¤\"]},\n {\"10000000\", [one: \"00 M ¤\", other: \"00 M ¤\"]},\n {\"100000000\", [one: \"000 M ¤\", other: \"000 M ¤\"]},\n {\"1000000000\", [one: \"0 Md ¤\", other: \"0 Md ¤\"]},\n {\"10000000000\", [one: \"00 Md ¤\", other: \"00 Md ¤\"]},\n {\"100000000000\", [one: \"000 Md ¤\", other: \"000 Md ¤\"]},\n {\"1000000000000\", [one: \"0 Bn ¤\", other: \"0 Bn ¤\"]},\n {\"10000000000000\", [one: \"00 Bn ¤\", other: \"00 Bn ¤\"]},\n {\"100000000000000\", [one: \"000 Bn ¤\", other: \"000 Bn ¤\"]}],\n ...\n }","ref":"Plausible.Cldr.Number.Format.html#formats_for/2-example"},{"type":"function","title":"Plausible.Cldr.Number.Format.formats_for!/2","doc":"","ref":"Plausible.Cldr.Number.Format.html#formats_for!/2"},{"type":"function","title":"Plausible.Cldr.Number.Format.minimum_grouping_digits_for/1","doc":"Returns the minimum grouping digits for a locale.","ref":"Plausible.Cldr.Number.Format.html#minimum_grouping_digits_for/1"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.Format.minimum_grouping_digits_for/1","doc":"* `locale` is any valid locale name returned by\n `Plausible.Cldr.known_locale_names/0`\n or a `Cldr.LanguageTag` struct returned by\n `Plausible.Cldr.Locale.new!/1`. The default\n is `Plausible.Cldr.get_locale/0`.","ref":"Plausible.Cldr.Number.Format.html#minimum_grouping_digits_for/1-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.Number.Format.minimum_grouping_digits_for/1","doc":"* `{:ok, minumum_digits}` or\n\n* `{:error, {exception, message}}`","ref":"Plausible.Cldr.Number.Format.html#minimum_grouping_digits_for/1-returns"},{"type":"function","title":"Examples - Plausible.Cldr.Number.Format.minimum_grouping_digits_for/1","doc":"iex> Plausible.Cldr.Number.Format.minimum_grouping_digits_for(\"en\")\n {:ok, 1}","ref":"Plausible.Cldr.Number.Format.html#minimum_grouping_digits_for/1-examples"},{"type":"function","title":"Plausible.Cldr.Number.Format.minimum_grouping_digits_for!/1","doc":"Returns the minimum grouping digits for a locale\nor raises on error.","ref":"Plausible.Cldr.Number.Format.html#minimum_grouping_digits_for!/1"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.Format.minimum_grouping_digits_for!/1","doc":"* `locale` is any valid locale name returned by\n `Plausible.Cldr.known_locale_names/0`\n or a `Cldr.LanguageTag` struct returned by\n `Plausible.Cldr.Locale.new!/1`. The default\n is `Plausible.Cldr.get_locale/0`.","ref":"Plausible.Cldr.Number.Format.html#minimum_grouping_digits_for!/1-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.Number.Format.minimum_grouping_digits_for!/1","doc":"* `minumum_digits` or\n\n* raises an exception.","ref":"Plausible.Cldr.Number.Format.html#minimum_grouping_digits_for!/1-returns"},{"type":"function","title":"Examples - Plausible.Cldr.Number.Format.minimum_grouping_digits_for!/1","doc":"iex> Plausible.Cldr.Number.Format.minimum_grouping_digits_for!(\"en\")\n 1","ref":"Plausible.Cldr.Number.Format.html#minimum_grouping_digits_for!/1-examples"},{"type":"module","title":"Plausible.Cldr.Number.Formatter.Decimal","doc":"","ref":"Plausible.Cldr.Number.Formatter.Decimal.html"},{"type":"function","title":"Plausible.Cldr.Number.Formatter.Decimal.metadata!/1","doc":"","ref":"Plausible.Cldr.Number.Formatter.Decimal.html#metadata!/1"},{"type":"function","title":"Plausible.Cldr.Number.Formatter.Decimal.to_string/3","doc":"Formats a number according to a decimal format string.","ref":"Plausible.Cldr.Number.Formatter.Decimal.html#to_string/3"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.Formatter.Decimal.to_string/3","doc":"* `number` is an integer, float or Decimal\n\n* `format` is a format string. See `Plausible.Cldr.Number` for further information.\n\n* `options` is a map of options. See `Plausible.Cldr.Number.to_string/2`\n for further information.","ref":"Plausible.Cldr.Number.Formatter.Decimal.html#to_string/3-arguments"},{"type":"module","title":"Plausible.Cldr.Number.Ordinal","doc":"Implements ordinal plural rules for numbers.","ref":"Plausible.Cldr.Number.Ordinal.html"},{"type":"function","title":"Plausible.Cldr.Number.Ordinal.available_locale_names/0","doc":"The locale names for which plural rules are defined.","ref":"Plausible.Cldr.Number.Ordinal.html#available_locale_names/0"},{"type":"function","title":"Plausible.Cldr.Number.Ordinal.known_locale_names/0","doc":"The configured locales for which plural rules are defined.\n\nReturns the intersection of `Plausible.Cldr.known_locale_names/0` and\nthe locales for which Ordinal plural rules are defined.\n\nThere are many `Cldr` locales which don't have their own plural\nrules so this list is the intersection of `Cldr`'s configured\nlocales and those that have rules.","ref":"Plausible.Cldr.Number.Ordinal.html#known_locale_names/0"},{"type":"function","title":"Plausible.Cldr.Number.Ordinal.plural_rule/3","doc":"Return the plural key for a given number in a given locale\n\nReturns which plural key (`:zero`, `:one`, `:two`, `:few`,\n`:many` or `:other`) a given number fits into within the\ncontext of a given locale.\n\nNote that these key names should not be interpreted\nliterally. For example, the key returned from\n`Cldr.Number.Ordinal.plural_rule(0, \"en\")` is actually\n`:other`, not `:zero`.\n\nThis key can then be used to format a number, date, time, unit,\nlist or other content in a plural-sensitive way.","ref":"Plausible.Cldr.Number.Ordinal.html#plural_rule/3"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.Ordinal.plural_rule/3","doc":"* `number` is any `integer`, `float` or `Decimal`\n\n* `locale` is any locale returned by `Cldr.Locale.new!/2` or any\n `locale_name` returned by `Plausible.Cldr.known_locale_names/0`\n\n* `rounding` is one of `[:down, :up, :ceiling, :floor, :half_even, :half_up, :half_down]`. The\n default is `:half_even`.","ref":"Plausible.Cldr.Number.Ordinal.html#plural_rule/3-arguments"},{"type":"function","title":"Examples - Plausible.Cldr.Number.Ordinal.plural_rule/3","doc":"iex> Plausible.Cldr.Number.Ordinal.plural_rule 0, \"fr\"\n :other\n\n iex> Plausible.Cldr.Number.Ordinal.plural_rule 1, \"en\"\n :one","ref":"Plausible.Cldr.Number.Ordinal.html#plural_rule/3-examples"},{"type":"function","title":"Plausible.Cldr.Number.Ordinal.plural_rules/0","doc":"Returns all the plural rules defined in CLDR.","ref":"Plausible.Cldr.Number.Ordinal.html#plural_rules/0"},{"type":"function","title":"Plausible.Cldr.Number.Ordinal.plural_rules_for/1","doc":"Return the plural rules for a locale.","ref":"Plausible.Cldr.Number.Ordinal.html#plural_rules_for/1"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.Ordinal.plural_rules_for/1","doc":"* `locale` is any locale returned by `Plausible.Cldr.Locale.new!/1` or any\n `locale_name` returned by `Plausible.Cldr.known_locale_names/0`\n\nThe rules are returned in AST form after parsing.","ref":"Plausible.Cldr.Number.Ordinal.html#plural_rules_for/1-arguments"},{"type":"function","title":"Plausible.Cldr.Number.Ordinal.pluralize/3","doc":"Pluralize a number using ordinal plural rules\nand a substitution map.","ref":"Plausible.Cldr.Number.Ordinal.html#pluralize/3"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.Ordinal.pluralize/3","doc":"* `number` is an integer, float or Decimal or a `Range.t{}`. When a range, The\n is that in any usage, the start value is strictly less than the end value,\n and that no values are negative. Results for any cases that do not meet\n these criteria are undefined.\n\n* `locale` is any locale returned by `Plausible.Cldr.Locale.new!/1` or any\n `locale_name` returned by `Plausible.Cldr.known_locale_names/0`\n\n* `substitutions` is a map that maps plural keys to a string.\n The valid substitution keys are `:zero`, `:one`, `:two`,\n `:few`, `:many` and `:other`.\n\nSee also `Plausible.Cldr.Number.Ordinal.Ordinal.plural_rule/3`.","ref":"Plausible.Cldr.Number.Ordinal.html#pluralize/3-arguments"},{"type":"function","title":"Examples - Plausible.Cldr.Number.Ordinal.pluralize/3","doc":"iex> Plausible.Cldr.Number.Ordinal.pluralize 1, :en, %{one: \"one\"}\n \"one\"\n\n iex> Plausible.Cldr.Number.Ordinal.pluralize 2, :en, %{one: \"one\"}\n nil\n\n iex> Plausible.Cldr.Number.Ordinal.pluralize 2, :en, %{one: \"one\", two: \"two\"}\n \"two\"\n\n iex> Plausible.Cldr.Number.Ordinal.pluralize 22, :en, %{one: \"one\", two: \"two\", other: \"other\"}\n \"two\"\n\n iex> Plausible.Cldr.Number.Ordinal.pluralize Decimal.new(1), :en, %{one: \"one\"}\n \"one\"\n\n iex> Plausible.Cldr.Number.Ordinal.pluralize Decimal.new(2), :en, %{one: \"one\"}\n nil\n\n iex> Plausible.Cldr.Number.Ordinal.pluralize Decimal.new(2), :en, %{one: \"one\", two: \"two\"}\n \"two\"\n\n iex> Plausible.Cldr.Number.Ordinal.pluralize 1..10, \"ar\", %{one: \"one\", few: \"few\", other: \"other\"}\n \"other\"\n\n iex> Plausible.Cldr.Number.Ordinal.pluralize 1..10, \"en\", %{one: \"one\", few: \"few\", other: \"other\"}\n \"other\"","ref":"Plausible.Cldr.Number.Ordinal.html#pluralize/3-examples"},{"type":"module","title":"Plausible.Cldr.Number.PluralRule.Range","doc":"Implements plural rules for ranges","ref":"Plausible.Cldr.Number.PluralRule.Range.html"},{"type":"function","title":"Plausible.Cldr.Number.PluralRule.Range.plural_rule/3","doc":"Returns a final plural type for a start-of-range plural\ntype, an end-of-range plural type and a locale.","ref":"Plausible.Cldr.Number.PluralRule.Range.html#plural_rule/3"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.PluralRule.Range.plural_rule/3","doc":"* `first` is a plural type for the start of a range\n\n* `last` is a plural type for the end of a range\n\n* `locale` is any `Cldr.LanguageTag.t` or a language name\n (not locale name)","ref":"Plausible.Cldr.Number.PluralRule.Range.html#plural_rule/3-arguments"},{"type":"function","title":"Example - Plausible.Cldr.Number.PluralRule.Range.plural_rule/3","doc":"iex> Plausible.Cldr.Number.PluralRule.Range.plural_rule :other, :few, \"ar\"\n :few","ref":"Plausible.Cldr.Number.PluralRule.Range.html#plural_rule/3-example"},{"type":"module","title":"Plausible.Cldr.Number.Symbol","doc":"","ref":"Plausible.Cldr.Number.Symbol.html"},{"type":"function","title":"Plausible.Cldr.Number.Symbol.all_decimal_symbols/0","doc":"Returns a list of all decimal symbols defined\nby the locales configured in this backend as\na list.","ref":"Plausible.Cldr.Number.Symbol.html#all_decimal_symbols/0"},{"type":"function","title":"Plausible.Cldr.Number.Symbol.all_decimal_symbols_class/0","doc":"Returns a list of all decimal symbols defined\nby the locales configured in this backend as\na string.\n\nThis string can be used as a character class\nwhen builing a regular expression.","ref":"Plausible.Cldr.Number.Symbol.html#all_decimal_symbols_class/0"},{"type":"function","title":"Plausible.Cldr.Number.Symbol.all_grouping_symbols/0","doc":"Returns a list of all grouping symbols defined\nby the locales configured in this backend as\na list.","ref":"Plausible.Cldr.Number.Symbol.html#all_grouping_symbols/0"},{"type":"function","title":"Plausible.Cldr.Number.Symbol.all_grouping_symbols_class/0","doc":"Returns a list of all grouping symbols defined\nby the locales configured in this backend as\na string.\n\nThis string can be used as a character class\nwhen builing a regular expression.","ref":"Plausible.Cldr.Number.Symbol.html#all_grouping_symbols_class/0"},{"type":"function","title":"Plausible.Cldr.Number.Symbol.number_symbols_for/1","doc":"Returns a map of `Cldr.Number.Symbol.t` structs of the number symbols for each\nof the number systems of a locale.","ref":"Plausible.Cldr.Number.Symbol.html#number_symbols_for/1"},{"type":"function","title":"Options - Plausible.Cldr.Number.Symbol.number_symbols_for/1","doc":"* `locale` is any valid locale name returned by\n `Plausible.Cldr.known_locale_names/0`\n or a `Cldr.LanguageTag` struct returned by\n `Plausible.Cldr.Locale.new!/1`. The default\n is `Plausible.Cldr.get_locale/0`.","ref":"Plausible.Cldr.Number.Symbol.html#number_symbols_for/1-options"},{"type":"function","title":"Example: - Plausible.Cldr.Number.Symbol.number_symbols_for/1","doc":"iex> Plausible.Cldr.Number.Symbol.number_symbols_for(:th)\n {:ok, %{\n latn: %Cldr.Number.Symbol{\n decimal: \".\",\n exponential: \"E\",\n group: \",\",\n infinity: \"∞\",\n list: \";\",\n minus_sign: \"-\",\n nan: \"NaN\",\n per_mille: \"‰\",\n percent_sign: \"%\",\n plus_sign: \"+\",\n superscripting_exponent: \"×\",\n time_separator: \":\"\n },\n thai: %Cldr.Number.Symbol{\n decimal: \".\",\n exponential: \"E\",\n group: \",\",\n infinity: \"∞\",\n list: \";\",\n minus_sign: \"-\",\n nan: \"NaN\",\n per_mille: \"‰\",\n percent_sign: \"%\",\n plus_sign: \"+\",\n superscripting_exponent: \"×\",\n time_separator: \":\"\n }\n }}","ref":"Plausible.Cldr.Number.Symbol.html#number_symbols_for/1-example"},{"type":"function","title":"Plausible.Cldr.Number.Symbol.number_symbols_for/2","doc":"","ref":"Plausible.Cldr.Number.Symbol.html#number_symbols_for/2"},{"type":"module","title":"Plausible.Cldr.Number.System","doc":"","ref":"Plausible.Cldr.Number.System.html"},{"type":"function","title":"Plausible.Cldr.Number.System.number_system_for/2","doc":"Returns the actual number system from a number system type.\n\n* `locale` is any valid locale name returned by `Cldr.known_locale_names/0`\n or a `Cldr.LanguageTag` struct returned by ``Cldr.Locale.new!/2``\n\n* `system_name` is any number system name returned by\n `Cldr.known_number_systems/0` or a number system type\n returned by `Cldr.known_number_system_types/0`\n\nThis function will decode a number system type into the actual\nnumber system. If the number system provided can't be decoded\nit is returned as is.","ref":"Plausible.Cldr.Number.System.html#number_system_for/2"},{"type":"function","title":"Examples - Plausible.Cldr.Number.System.number_system_for/2","doc":"iex> Plausible.Cldr.Number.System.number_system_for \"th\", :latn\n {:ok, %{digits: \"0123456789\", type: :numeric}}\n\n iex> Plausible.Cldr.Number.System.number_system_for \"en\", :default\n {:ok, %{digits: \"0123456789\", type: :numeric}}\n\n iex> Plausible.Cldr.Number.System.number_system_for \"he\", :traditional\n {:ok, %{rules: \"hebrew\", type: :algorithmic}}\n\n iex> Plausible.Cldr.Number.System.number_system_for \"en\", :native\n {:ok, %{digits: \"0123456789\", type: :numeric}}\n\n iex> Plausible.Cldr.Number.System.number_system_for \"en\", :finance\n {\n :error,\n {Cldr.UnknownNumberSystemError,\n \"The number system :finance is unknown for the locale named :en. Valid number systems are %{default: :latn, native: :latn}\"}\n }","ref":"Plausible.Cldr.Number.System.html#number_system_for/2-examples"},{"type":"function","title":"Plausible.Cldr.Number.System.number_system_from_locale/1","doc":"Returns the number system from a language tag or\nlocale name.","ref":"Plausible.Cldr.Number.System.html#number_system_from_locale/1"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.System.number_system_from_locale/1","doc":"* `locale` is any language tag returned be `Cldr.Locale.new/2`\n or a locale name in the list returned by `Cldr.known_locale_names/1`","ref":"Plausible.Cldr.Number.System.html#number_system_from_locale/1-arguments"},{"type":"function","title":"Returns - Plausible.Cldr.Number.System.number_system_from_locale/1","doc":"* A number system name as an atom","ref":"Plausible.Cldr.Number.System.html#number_system_from_locale/1-returns"},{"type":"function","title":"Examples - Plausible.Cldr.Number.System.number_system_from_locale/1","doc":"iex> Plausible.Cldr.Number.System.number_system_from_locale \"en-US-u-nu-thai\"\n :thai\n\n iex> Plausible.Cldr.Number.System.number_system_from_locale \"en-US\"\n :latn","ref":"Plausible.Cldr.Number.System.html#number_system_from_locale/1-examples"},{"type":"function","title":"Plausible.Cldr.Number.System.number_system_names_for/1","doc":"Returns the number systems available for a locale\nor `{:error, message}` if the locale is not known.\n\n* `locale` is any valid locale name returned by `Plausible.Cldr.known_locale_names/0`\n or a `Cldr.LanguageTag` struct returned by `Plausible.Cldr.Locale.new!/1`","ref":"Plausible.Cldr.Number.System.html#number_system_names_for/1"},{"type":"function","title":"Examples - Plausible.Cldr.Number.System.number_system_names_for/1","doc":"iex> Plausible.Cldr.Number.System.number_system_names_for \"en\"\n {:ok, [:latn]}\n\n iex> Plausible.Cldr.Number.System.number_system_names_for \"zz\"\n {:error, {Cldr.InvalidLanguageError, \"The language \\\"zz\\\" is invalid\"}}","ref":"Plausible.Cldr.Number.System.html#number_system_names_for/1-examples"},{"type":"function","title":"Plausible.Cldr.Number.System.number_system_names_for!/1","doc":"","ref":"Plausible.Cldr.Number.System.html#number_system_names_for!/1"},{"type":"function","title":"Plausible.Cldr.Number.System.number_system_types_for/1","doc":"","ref":"Plausible.Cldr.Number.System.html#number_system_types_for/1"},{"type":"function","title":"Plausible.Cldr.Number.System.number_systems_for/1","doc":"Returns the number systems available for a locale\nor `{:error, message}` if the locale is not known.\n\n* `locale` is any valid locale name returned by `Plausible.Cldr.known_locale_names/0`\n or a `Cldr.LanguageTag` struct returned by `Plausible.Cldr.Locale.new!/1`","ref":"Plausible.Cldr.Number.System.html#number_systems_for/1"},{"type":"function","title":"Examples - Plausible.Cldr.Number.System.number_systems_for/1","doc":"iex> Plausible.Cldr.Number.System.number_systems_for \"en\"\n {:ok, %{default: :latn, native: :latn}}\n\n iex> Plausible.Cldr.Number.System.number_systems_for \"th\"\n {:ok, %{default: :latn, native: :thai}}\n\n iex> Plausible.Cldr.Number.System.number_systems_for \"zz\"\n {:error, {Cldr.InvalidLanguageError, \"The language \\\"zz\\\" is invalid\"}}","ref":"Plausible.Cldr.Number.System.html#number_systems_for/1-examples"},{"type":"function","title":"Plausible.Cldr.Number.System.number_systems_for!/1","doc":"","ref":"Plausible.Cldr.Number.System.html#number_systems_for!/1"},{"type":"function","title":"Plausible.Cldr.Number.System.number_systems_like/2","doc":"","ref":"Plausible.Cldr.Number.System.html#number_systems_like/2"},{"type":"function","title":"Plausible.Cldr.Number.System.system_name_from/2","doc":"Returns a number system name for a given locale and number system reference.\n\n* `system_name` is any number system name returned by\n `Plausible.Cldr.known_number_systems/0` or a number system type\n returned by `Plausible.Cldr.known_number_system_types/0`\n\n* `locale` is any valid locale name returned by `Plausible.Cldr.known_locale_names/0`\n or a `Cldr.LanguageTag` struct returned by `Plausible.Cldr.Locale.new!/1`\n\nNumber systems can be references in one of two ways:\n\n* As a number system type such as :default, :native, :traditional and\n :finance. This allows references to a number system for a locale in a\n consistent fashion for a given use\n\n* WIth the number system name directly, such as :latn, :arab or any of the\n other 70 or so\n\nThis function dereferences the supplied `system_name` and returns the\nactual system name.","ref":"Plausible.Cldr.Number.System.html#system_name_from/2"},{"type":"function","title":"Examples - Plausible.Cldr.Number.System.system_name_from/2","doc":"ex> Plausible.Cldr.Number.System.system_name_from(:default, \"en\")\n {:ok, :latn}\n\n iex> Plausible.Cldr.Number.System.system_name_from(\"latn\", \"en\")\n {:ok, :latn}\n\n iex> Plausible.Cldr.Number.System.system_name_from(:native, \"en\")\n {:ok, :latn}\n\n iex> Plausible.Cldr.Number.System.system_name_from(:nope, \"en\")\n {\n :error,\n {Cldr.UnknownNumberSystemError, \"The number system :nope is unknown\"}\n }\n\nNote that return value is not guaranteed to be a valid\nnumber system for the given locale as demonstrated in the third example.","ref":"Plausible.Cldr.Number.System.html#system_name_from/2-examples"},{"type":"function","title":"Plausible.Cldr.Number.System.to_system/2","doc":"Converts a number into the representation of\na non-latin number system.\n\nThis function converts numbers to a known\nnumber system only, it does not provide number\nformatting.\n\n* `number` is a `float`, `integer` or `Decimal`\n\n* `system_name` is any number system name returned by\n `Cldr.known_number_systems/0` or a number system type\n returned by `Cldr.known_number_system_types/0`\n\nThere are two types of number systems in CLDR:\n\n* `:numeric` in which the number system defines\n a direct mapping between the latin digits `0..9`\n into a the number system equivalent. In this case,\n` to_system/2` invokes `Cldr.Number.Transliterate.transliterate_digits/3`\n for the given number.\n\n* `:algorithmic` in which the number system\n does not have the same structure as the `:latn`\n number system and therefore the conversion is\n done algorithmically. For CLDR the algorithm\n is implemented through `Cldr.Rbnf` rulesets.\n These rulesets are considered by CLDR to be\n less rigorous than the `:numeric` number systems\n and caution and testing for a specific use case\n is recommended.","ref":"Plausible.Cldr.Number.System.html#to_system/2"},{"type":"function","title":"Examples - Plausible.Cldr.Number.System.to_system/2","doc":"iex> Plausible.Cldr.Number.System.to_system 123456, :hebr\n {:ok, \"קכ״ג׳תנ״ו\"}\n\n iex> Plausible.Cldr.Number.System.to_system 123, :hans\n {:ok, \"一百二十三\"}\n\n iex> Plausible.Cldr.Number.System.to_system 123, :hant\n {:ok, \"一百二十三\"}\n\n iex> Plausible.Cldr.Number.System.to_system 123, :hansfin\n {:ok, \"壹佰贰拾叁\"}","ref":"Plausible.Cldr.Number.System.html#to_system/2-examples"},{"type":"function","title":"Plausible.Cldr.Number.System.to_system!/2","doc":"Converts a number into the representation of\na non-latin number system. Returns a converted\nstring or raises on error.\n\n* `number` is a `float`, `integer` or `Decimal`\n\n* `system_name` is any number system name returned by\n `Plausible.Cldr.known_number_systems/0` or a number system type\n returned by `Plausible.Cldr.known_number_system_types/0`\n\nSee `Plausible.Cldr.Number.System.to_system/2` for further\ninformation.","ref":"Plausible.Cldr.Number.System.html#to_system!/2"},{"type":"function","title":"Examples - Plausible.Cldr.Number.System.to_system!/2","doc":"iex> Plausible.Cldr.Number.System.to_system! 123, :hans\n \"一百二十三\"\n\n iex> Plausible.Cldr.Number.System.to_system! 123, :hant\n \"一百二十三\"\n\n iex> Plausible.Cldr.Number.System.to_system! 123, :hansfin\n \"壹佰贰拾叁\"","ref":"Plausible.Cldr.Number.System.html#to_system!/2-examples"},{"type":"module","title":"Plausible.Cldr.Number.Transliterate","doc":"Transliteration for digits and separators.\n\nTransliterating a string is an expensive business. First the string has to\nbe exploded into its component graphemes. Then for each grapheme we have\nto map to the equivalent in the other `{locale, number_system}`. Then we\nhave to reassemble the string.\n\nEffort is made to short circuit where possible. Transliteration is not\nrequired for any `{locale, number_system}` that is the same as `{\"en\",\n\"latn\"}` since the implementation uses this combination for the placeholders during\nformatting already. When short circuiting is possible (typically the en-*\nlocales with \"latn\" number_system - the total number of short circuited\nlocales is 211 of the 537 in CLDR) the overall number formatting is twice as\nfast than when formal transliteration is required.\n\n#","ref":"Plausible.Cldr.Number.Transliterate.html"},{"type":"module","title":"Configuring precompilation of digit transliterations - Plausible.Cldr.Number.Transliterate","doc":"This module includes `Cldr.Number.Transliterate.transliterate_digits/3` which transliterates\ndigits between number systems. For example from :arabic to :latn. Since generating a\ntransliteration map is slow, pairs of transliterations can be configured so that the\ntransliteration map is created at compile time and therefore speeding up transliteration at\nrun time.\n\nTo configure these transliteration pairs, add the to the `use Cldr` configuration\nin a backend module:\n\n defmodule MyApp.Cldr do\n use Cldr,\n locale: [\"en\", \"fr\", \"th\"],\n default_locale: \"en\",\n precompile_transliterations: [{:latn, :thai}, {:arab, :thai}]\n end\n\nWhere each tuple in the list configures one transliteration map. In this example, two maps are\nconfigured: from `:latn` to `:thai` and from `:arab` to `:thai`.\n\nA list of configurable number systems is returned by `Cldr.Number.System.numeric_systems/0`.\n\nIf a transliteration is requested between two number pairs that have not been configured for\nprecompilation, a warning is logged.","ref":"Plausible.Cldr.Number.Transliterate.html#module-configuring-precompilation-of-digit-transliterations"},{"type":"function","title":"Plausible.Cldr.Number.Transliterate.transliterate/3","doc":"Transliterates from latin digits to another number system's digits.\n\nTransliterates the latin digits 0..9 to their equivalents in\nanother number system. Also transliterates the decimal and grouping\nseparators as well as the plus, minus and exponent symbols. Any other character\nin the string will be returned \"as is\".","ref":"Plausible.Cldr.Number.Transliterate.html#transliterate/3"},{"type":"function","title":"Arguments - Plausible.Cldr.Number.Transliterate.transliterate/3","doc":"* `sequence` is the string to be transliterated.\n\n* `locale` is any known locale, defaulting to `Plausible.Cldr.get_locale/0`.\n\n* `number_system` is any known number system. If expressed as a `string` it\n is the actual name of a known number system. If epressed as an `atom` it is\n used as a key to look up a number system for the locale (the usual keys are\n `:default` and `:native` but :traditional and :finance are also part of the\n standard). See `Plausible.Cldr.Number.System.number_systems_for/1` for a locale to\n see what number system types are defined. The default is `:default`.\n\nFor available number systems see `Cldr.Number.System.number_systems/0`\nand `Plausible.Cldr.Number.System.number_systems_for/1`. Also see\n`Plausible.Cldr.Number.Symbol.number_symbols_for/1`.","ref":"Plausible.Cldr.Number.Transliterate.html#transliterate/3-arguments"},{"type":"function","title":"Examples - Plausible.Cldr.Number.Transliterate.transliterate/3","doc":"iex> Plausible.Cldr.Number.Transliterate.transliterate(\"123556\")\n \"123556\"\n\n iex> Plausible.Cldr.Number.Transliterate.transliterate(\"123,556.000\", \"fr\", :default)\n \"123 556,000\"\n\n iex> Plausible.Cldr.Number.Transliterate.transliterate(\"123556\", \"th\", :default)\n \"123556\"\n\n iex> Plausible.Cldr.Number.Transliterate.transliterate(\"123556\", \"th\", \"thai\")\n \"๑๒๓๕๕๖\"\n\n iex> Plausible.Cldr.Number.Transliterate.transliterate(\"123556\", \"th\", :native)\n \"๑๒๓๕๕๖\"\n\n iex> Plausible.Cldr.Number.Transliterate.transliterate(\"Some number is: 123556\", \"th\", \"thai\")\n \"Some number is: ๑๒๓๕๕๖\"","ref":"Plausible.Cldr.Number.Transliterate.html#transliterate/3-examples"},{"type":"function","title":"Plausible.Cldr.Number.Transliterate.transliterate!/3","doc":"","ref":"Plausible.Cldr.Number.Transliterate.html#transliterate!/3"},{"type":"function","title":"Plausible.Cldr.Number.Transliterate.transliterate_digits/3","doc":"Transliterates digits from one number system to another number system\n\n* `digits` is binary representation of a number\n\n* `from_system` and `to_system` are number system names in atom form. See\n`Cldr.Number.System.numeric_systems/0` for available number systems.","ref":"Plausible.Cldr.Number.Transliterate.html#transliterate_digits/3"},{"type":"function","title":"Example - Plausible.Cldr.Number.Transliterate.transliterate_digits/3","doc":"iex> Plausible.Cldr.Number.Transliterate.transliterate_digits \"٠١٢٣٤٥٦٧٨٩\", :arab, :latn\n \"0123456789\"","ref":"Plausible.Cldr.Number.Transliterate.html#transliterate_digits/3-example"},{"type":"module","title":"Plausible.Cldr.Rbnf.NumberSystem","doc":"Functions to implement the number system rule-based-number-format rules of CLDR.\n\nThese rules are defined only on the \"und\" locale and represent specialised\nnumber formatting.\n\nThe standard public API for RBNF is via the `Cldr.Number.to_string/2` function.\n\nThe functions on this module are defined at compile time based upon the RBNF rules\ndefined in the Unicode CLDR data repository. Available rules are identified by:\n\n iex> Plausible.Cldr.Rbnf.NumberSystem.rule_sets(:und)\n ...> |> Enum.sort()\n [\n :armenian_lower,\n :armenian_upper,\n :cyrillic_lower,\n :ethiopic,\n :georgian,\n :greek_lower,\n :greek_upper,\n :hebrew,\n :hebrew_item,\n :roman_lower,\n :roman_upper,\n :tamil,\n :zz_default\n ]\n\nA rule can then be invoked on an available rule_set. For example\n\n iex> Plausible.Cldr.Rbnf.NumberSystem.roman_upper(123, :und)\n \"CXXIII\"\n\nThis particular call is equivalent to the call through the public API of:\n\n iex> Plausible.Cldr.Number.to_string(123, format: :roman)\n {:ok, \"CXXIII\"}","ref":"Plausible.Cldr.Rbnf.NumberSystem.html"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.all_rule_sets/0","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#all_rule_sets/0"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.armenian_lower/1","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#armenian_lower/1"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.armenian_lower/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#armenian_lower/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.armenian_upper/1","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#armenian_upper/1"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.armenian_upper/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#armenian_upper/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.cyrillic_lower/1","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#cyrillic_lower/1"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.cyrillic_lower/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#cyrillic_lower/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.cyrillic_lower_1_10/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#cyrillic_lower_1_10/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.cyrillic_lower_final/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#cyrillic_lower_final/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.cyrillic_lower_post/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#cyrillic_lower_post/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.cyrillic_lower_thousands/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#cyrillic_lower_thousands/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.ethiopic/1","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#ethiopic/1"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.ethiopic/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#ethiopic/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.ethiopic_p1/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#ethiopic_p1/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.ethiopic_p2/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#ethiopic_p2/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.ethiopic_p3/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#ethiopic_p3/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.ethiopic_p/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#ethiopic_p/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.georgian/1","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#georgian/1"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.georgian/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#georgian/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.greek_lower/1","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#greek_lower/1"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.greek_lower/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#greek_lower/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.greek_numeral_majuscules/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#greek_numeral_majuscules/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.greek_numeral_minuscules/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#greek_numeral_minuscules/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.greek_upper/1","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#greek_upper/1"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.greek_upper/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#greek_upper/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.hebrew/1","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#hebrew/1"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.hebrew/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#hebrew/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.hebrew_0_99/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#hebrew_0_99/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.hebrew_item/1","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#hebrew_item/1"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.hebrew_item/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#hebrew_item/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.hebrew_item_hundreds/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#hebrew_item_hundreds/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.hebrew_thousands/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#hebrew_thousands/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.roman_lower/1","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#roman_lower/1"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.roman_lower/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#roman_lower/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.roman_upper/1","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#roman_upper/1"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.roman_upper/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#roman_upper/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.rule_sets/0","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#rule_sets/0"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.rule_sets/1","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#rule_sets/1"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.tamil/1","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#tamil/1"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.tamil/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#tamil/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.tamil_thousands/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#tamil_thousands/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.zz_default/1","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#zz_default/1"},{"type":"function","title":"Plausible.Cldr.Rbnf.NumberSystem.zz_default/2","doc":"","ref":"Plausible.Cldr.Rbnf.NumberSystem.html#zz_default/2"},{"type":"module","title":"Plausible.Cldr.Rbnf.Ordinal","doc":"Functions to implement the ordinal rule-based-number-format rules of CLDR.\n\nAs CLDR notes, the data is incomplete or non-existent for many languages. It\nis considered complete for English however.\n\nThe standard public API for RBNF is via the `Cldr.Number.to_string/2` function.\n\nThe functions on this module are defined at compile time based upon the RBNF rules\ndefined in the Unicode CLDR data repository. Available rules are identified by:\n\n iex> Plausible.Cldr.Rbnf.Ordinal.rule_sets(:en)\n [:digits_ordinal]\n\n iex> Plausible.Cldr.Rbnf.Ordinal.rule_sets(\"fr\")\n ...> |> Enum.sort()\n [\n :digits_ordinal,\n :digits_ordinal_feminine,\n :digits_ordinal_feminine_plural,\n :digits_ordinal_masculine,\n :digits_ordinal_masculine_plural\n ]\n\nA rule can then be invoked on an available rule_set. For example\n\n iex> Plausible.Cldr.Rbnf.Ordinal.digits_ordinal(123, :en)\n \"123rd\"\n\nThis call is equivalent to the call through the public API of:\n\n iex> Plausible.Cldr.Number.to_string(123, format: :ordinal)\n {:ok, \"123rd\"}","ref":"Plausible.Cldr.Rbnf.Ordinal.html"},{"type":"function","title":"Plausible.Cldr.Rbnf.Ordinal.all_rule_sets/0","doc":"","ref":"Plausible.Cldr.Rbnf.Ordinal.html#all_rule_sets/0"},{"type":"function","title":"Plausible.Cldr.Rbnf.Ordinal.digits_ordinal/2","doc":"","ref":"Plausible.Cldr.Rbnf.Ordinal.html#digits_ordinal/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.Ordinal.rule_sets/0","doc":"","ref":"Plausible.Cldr.Rbnf.Ordinal.html#rule_sets/0"},{"type":"function","title":"Plausible.Cldr.Rbnf.Ordinal.rule_sets/1","doc":"","ref":"Plausible.Cldr.Rbnf.Ordinal.html#rule_sets/1"},{"type":"module","title":"Plausible.Cldr.Rbnf.Spellout","doc":"Functions to implement the spellout rule-based-number-format rules of CLDR.\n\nAs CLDR notes, the data is incomplete or non-existent for many languages. It\nis considered complete for English however.\n\nThe standard public API for RBNF is via the `Cldr.Number.to_string/2` function.\n\nThe functions on this module are defined at compile time based upon the RBNF rules\ndefined in the Unicode CLDR data repository. Available rules are identified by:\n\n iex> Plausible.Cldr.Rbnf.Spellout.rule_sets(\"en\")\n ...> |> Enum.sort()\n [\n :spellout_cardinal,\n :spellout_cardinal_verbose,\n :spellout_numbering,\n :spellout_numbering_verbose,\n :spellout_numbering_year,\n :spellout_ordinal,\n :spellout_ordinal_verbose\n ]\n\nA rule can then be invoked on an available rule_set. For example:\n\n iex> Plausible.Cldr.Rbnf.Spellout.spellout_ordinal(123, \"en\")\n \"one hundred twenty-third\"\n\nThis call is equivalent to the call through the public API of:\n\n iex> Plausible.Cldr.Number.to_string(123, format: :spellout)\n {:ok, \"one hundred twenty-three\"}","ref":"Plausible.Cldr.Rbnf.Spellout.html"},{"type":"function","title":"Plausible.Cldr.Rbnf.Spellout.all_rule_sets/0","doc":"","ref":"Plausible.Cldr.Rbnf.Spellout.html#all_rule_sets/0"},{"type":"function","title":"Plausible.Cldr.Rbnf.Spellout.and/2","doc":"","ref":"Plausible.Cldr.Rbnf.Spellout.html#and/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.Spellout.and_o/2","doc":"","ref":"Plausible.Cldr.Rbnf.Spellout.html#and_o/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.Spellout.commas/2","doc":"","ref":"Plausible.Cldr.Rbnf.Spellout.html#commas/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.Spellout.commas_o/2","doc":"","ref":"Plausible.Cldr.Rbnf.Spellout.html#commas_o/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.Spellout.r2d_year/2","doc":"","ref":"Plausible.Cldr.Rbnf.Spellout.html#r2d_year/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.Spellout.rule_sets/0","doc":"","ref":"Plausible.Cldr.Rbnf.Spellout.html#rule_sets/0"},{"type":"function","title":"Plausible.Cldr.Rbnf.Spellout.rule_sets/1","doc":"","ref":"Plausible.Cldr.Rbnf.Spellout.html#rule_sets/1"},{"type":"function","title":"Plausible.Cldr.Rbnf.Spellout.spellout_cardinal/2","doc":"","ref":"Plausible.Cldr.Rbnf.Spellout.html#spellout_cardinal/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.Spellout.spellout_cardinal_verbose/2","doc":"","ref":"Plausible.Cldr.Rbnf.Spellout.html#spellout_cardinal_verbose/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.Spellout.spellout_numbering/2","doc":"","ref":"Plausible.Cldr.Rbnf.Spellout.html#spellout_numbering/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.Spellout.spellout_numbering_verbose/2","doc":"","ref":"Plausible.Cldr.Rbnf.Spellout.html#spellout_numbering_verbose/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.Spellout.spellout_numbering_year/2","doc":"","ref":"Plausible.Cldr.Rbnf.Spellout.html#spellout_numbering_year/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.Spellout.spellout_ordinal/2","doc":"","ref":"Plausible.Cldr.Rbnf.Spellout.html#spellout_ordinal/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.Spellout.spellout_ordinal_verbose/2","doc":"","ref":"Plausible.Cldr.Rbnf.Spellout.html#spellout_ordinal_verbose/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.Spellout.th/2","doc":"","ref":"Plausible.Cldr.Rbnf.Spellout.html#th/2"},{"type":"function","title":"Plausible.Cldr.Rbnf.Spellout.tieth/2","doc":"","ref":"Plausible.Cldr.Rbnf.Spellout.html#tieth/2"},{"type":"module","title":"Plausible.ClickhouseEventV2","doc":"Event schema for when NumericIDs migration is complete","ref":"Plausible.ClickhouseEventV2.html"},{"type":"function","title":"Plausible.ClickhouseEventV2.merge_session/2","doc":"","ref":"Plausible.ClickhouseEventV2.html#merge_session/2"},{"type":"function","title":"Plausible.ClickhouseEventV2.new/1","doc":"","ref":"Plausible.ClickhouseEventV2.html#new/1"},{"type":"module","title":"Plausible.ClickhouseLocationData","doc":"Schema for storing location id <-> translation mappings in ClickHouse\n\nIndirectly read via dictionary `location_data_dictionary` in ALIAS columns in\n`events_v2`, `sessions_v2` and `imported_locations` table.","ref":"Plausible.ClickhouseLocationData.html"},{"type":"module","title":"Plausible.ClickhouseRepo","doc":"","ref":"Plausible.ClickhouseRepo.html"},{"type":"function","title":"Plausible.ClickhouseRepo.aggregate/3","doc":"","ref":"Plausible.ClickhouseRepo.html#aggregate/3"},{"type":"function","title":"Plausible.ClickhouseRepo.aggregate/4","doc":"","ref":"Plausible.ClickhouseRepo.html#aggregate/4"},{"type":"function","title":"Plausible.ClickhouseRepo.all/2","doc":"","ref":"Plausible.ClickhouseRepo.html#all/2"},{"type":"function","title":"Plausible.ClickhouseRepo.alter_update_all/3","doc":"Similar to `Ecto.Repo.update_all/3` but uses [`ALTER TABLE ... UPDATE`](https://clickhouse.com/docs/en/sql-reference/statements/alter/update) instead.\n\nFor more information and performance implications please see:\n\n - https://clickhouse.com/blog/handling-updates-and-deletes-in-clickhouse\n - https://clickhouse.com/docs/en/guides/developer/mutations","ref":"Plausible.ClickhouseRepo.html#alter_update_all/3"},{"type":"function","title":"Plausible.ClickhouseRepo.checked_out?/0","doc":"","ref":"Plausible.ClickhouseRepo.html#checked_out?/0"},{"type":"function","title":"Plausible.ClickhouseRepo.checkout/2","doc":"","ref":"Plausible.ClickhouseRepo.html#checkout/2"},{"type":"function","title":"Plausible.ClickhouseRepo.child_spec/1","doc":"","ref":"Plausible.ClickhouseRepo.html#child_spec/1"},{"type":"function","title":"Plausible.ClickhouseRepo.config/0","doc":"","ref":"Plausible.ClickhouseRepo.html#config/0"},{"type":"function","title":"Plausible.ClickhouseRepo.default_options/1","doc":"","ref":"Plausible.ClickhouseRepo.html#default_options/1"},{"type":"function","title":"Plausible.ClickhouseRepo.disconnect_all/2","doc":"A convenience function for SQL-based repositories that forces all connections in the\npool to disconnect within the given interval.\n\nSee `Ecto.Adapters.SQL.disconnect_all/3` for more information.","ref":"Plausible.ClickhouseRepo.html#disconnect_all/2"},{"type":"function","title":"Plausible.ClickhouseRepo.exists?/2","doc":"","ref":"Plausible.ClickhouseRepo.html#exists?/2"},{"type":"function","title":"Plausible.ClickhouseRepo.get/3","doc":"","ref":"Plausible.ClickhouseRepo.html#get/3"},{"type":"function","title":"Plausible.ClickhouseRepo.get!/3","doc":"","ref":"Plausible.ClickhouseRepo.html#get!/3"},{"type":"function","title":"Plausible.ClickhouseRepo.get_by/3","doc":"","ref":"Plausible.ClickhouseRepo.html#get_by/3"},{"type":"function","title":"Plausible.ClickhouseRepo.get_by!/3","doc":"","ref":"Plausible.ClickhouseRepo.html#get_by!/3"},{"type":"function","title":"Plausible.ClickhouseRepo.get_dynamic_repo/0","doc":"","ref":"Plausible.ClickhouseRepo.html#get_dynamic_repo/0"},{"type":"function","title":"Plausible.ClickhouseRepo.insert_stream/3","doc":"Similar to `insert_all/2` but with the following differences:\n\n - accepts rows as streams or lists\n - sends rows as a chunked request\n - doesn't autogenerate ids or does any other preprocessing\n\nExample:\n\n Repo.query!(\"create table ecto_ch_demo(a UInt64, b String) engine Null\")\n\n defmodule Demo do\n use Ecto.Schema\n\n @primary_key false\n schema \"ecto_ch_demo\" do\n field :a, Ch, type: \"UInt64\"\n field :b, :string\n end\n end\n\n rows = Stream.map(1..100_000, fn i -> %{a: i, b: to_string(i)} end)\n {100_000, nil} = Repo.insert_stream(Demo, rows)\n\n # schemaless\n {100_000, nil} = Repo.insert_stream(\"ecto_ch_demo\", rows, types: [a: Ch.Types.u64(), b: :string])","ref":"Plausible.ClickhouseRepo.html#insert_stream/3"},{"type":"function","title":"Plausible.ClickhouseRepo.load/2","doc":"","ref":"Plausible.ClickhouseRepo.html#load/2"},{"type":"function","title":"Plausible.ClickhouseRepo.one/2","doc":"","ref":"Plausible.ClickhouseRepo.html#one/2"},{"type":"function","title":"Plausible.ClickhouseRepo.one!/2","doc":"","ref":"Plausible.ClickhouseRepo.html#one!/2"},{"type":"function","title":"Plausible.ClickhouseRepo.parallel_tasks/2","doc":"","ref":"Plausible.ClickhouseRepo.html#parallel_tasks/2"},{"type":"function","title":"Plausible.ClickhouseRepo.preload/3","doc":"","ref":"Plausible.ClickhouseRepo.html#preload/3"},{"type":"function","title":"Plausible.ClickhouseRepo.put_dynamic_repo/1","doc":"","ref":"Plausible.ClickhouseRepo.html#put_dynamic_repo/1"},{"type":"function","title":"Plausible.ClickhouseRepo.query/3","doc":"A convenience function for SQL-based repositories that executes the given query.\n\nSee `Ecto.Adapters.SQL.query/4` for more information.","ref":"Plausible.ClickhouseRepo.html#query/3"},{"type":"function","title":"Plausible.ClickhouseRepo.query!/3","doc":"A convenience function for SQL-based repositories that executes the given query.\n\nSee `Ecto.Adapters.SQL.query!/4` for more information.","ref":"Plausible.ClickhouseRepo.html#query!/3"},{"type":"function","title":"Plausible.ClickhouseRepo.reload/2","doc":"","ref":"Plausible.ClickhouseRepo.html#reload/2"},{"type":"function","title":"Plausible.ClickhouseRepo.reload!/2","doc":"","ref":"Plausible.ClickhouseRepo.html#reload!/2"},{"type":"function","title":"Plausible.ClickhouseRepo.start_link/1","doc":"","ref":"Plausible.ClickhouseRepo.html#start_link/1"},{"type":"function","title":"Plausible.ClickhouseRepo.stop/1","doc":"","ref":"Plausible.ClickhouseRepo.html#stop/1"},{"type":"function","title":"Plausible.ClickhouseRepo.stream/2","doc":"","ref":"Plausible.ClickhouseRepo.html#stream/2"},{"type":"function","title":"Plausible.ClickhouseRepo.to_inline_sql/2","doc":"Similar to `to_sql/2` but inlines the parameters into the SQL query.\n\nSee `Ecto.Adapters.ClickHouse.to_inline_sql/2` for more information.","ref":"Plausible.ClickhouseRepo.html#to_inline_sql/2"},{"type":"function","title":"Plausible.ClickhouseRepo.to_sql/2","doc":"A convenience function for SQL-based repositories that translates the given query to SQL.\n\nSee `Ecto.Adapters.SQL.to_sql/3` for more information.","ref":"Plausible.ClickhouseRepo.html#to_sql/2"},{"type":"module","title":"Plausible.ClickhouseSessionV2","doc":"Session schema for when NumericIDs migration is complete","ref":"Plausible.ClickhouseSessionV2.html"},{"type":"function","title":"Plausible.ClickhouseSessionV2.random_uint64/0","doc":"","ref":"Plausible.ClickhouseSessionV2.html#random_uint64/0"},{"type":"module","title":"Plausible.ClickhouseSessionV2.BoolUInt8","doc":"Custom type to cast Bool as UInt8","ref":"Plausible.ClickhouseSessionV2.BoolUInt8.html"},{"type":"function","title":"Plausible.ClickhouseSessionV2.BoolUInt8.embed_as/1","doc":"","ref":"Plausible.ClickhouseSessionV2.BoolUInt8.html#embed_as/1"},{"type":"function","title":"Plausible.ClickhouseSessionV2.BoolUInt8.equal?/2","doc":"","ref":"Plausible.ClickhouseSessionV2.BoolUInt8.html#equal?/2"},{"type":"module","title":"Plausible.ConfigHelpers","doc":"","ref":"Plausible.ConfigHelpers.html"},{"type":"function","title":"Plausible.ConfigHelpers.get_int_from_path_or_env/3","doc":"","ref":"Plausible.ConfigHelpers.html#get_int_from_path_or_env/3"},{"type":"function","title":"Plausible.ConfigHelpers.get_var_from_path_or_env/3","doc":"","ref":"Plausible.ConfigHelpers.html#get_var_from_path_or_env/3"},{"type":"module","title":"Plausible.CrmExtensions","doc":"Extensions for Kaffy CRM","ref":"Plausible.CrmExtensions.html"},{"type":"function","title":"Plausible.CrmExtensions.javascripts/1","doc":"","ref":"Plausible.CrmExtensions.html#javascripts/1"},{"type":"module","title":"Plausible.DataCase","doc":"This module defines the setup for tests requiring\naccess to the application's data layer.\n\nYou may define functions here to be used as helpers in\nyour tests.\n\nFinally, if the test case interacts with the database,\nit cannot be async. For this reason, every test runs\ninside a transaction which is reset at the beginning\nof the test unless the test case is marked as async.","ref":"Plausible.DataCase.html"},{"type":"module","title":"Plausible.DataMigration","doc":"Base module for coordinated Clickhouse data migrations\nrun via remote shell or otherwise (TBD).","ref":"Plausible.DataMigration.html"},{"type":"module","title":"Plausible.DataMigration.CleanUpDemoSiteReferrerSource","doc":"Clean up referrer_source entries for demo site with\n`Direct / None` for value populated by dogfooding\nPlausible stats.","ref":"Plausible.DataMigration.CleanUpDemoSiteReferrerSource.html"},{"type":"function","title":"Plausible.DataMigration.CleanUpDemoSiteReferrerSource.run/1","doc":"","ref":"Plausible.DataMigration.CleanUpDemoSiteReferrerSource.html#run/1"},{"type":"module","title":"Plausible.DataMigration.LocationsSync","doc":"ClickHouse locations data migration for storing location names in ClickHouse.\n\nOnly run when `Location.version()` changes: either as a migration or in cron.\n\nThe migration:\n1. Truncates existing `location_data` table (if exists)\n2. Creates new table (if needed)\n3. Inserts new data from Location module\n4. (Re-)Creates dictionary to read location data from table\n5. Creates ALIAS columns in `events_v2`, `sessions_v2` and `imported_locations` table to make reading location names easy\n6. Updates table comment for `location_data` to indicate last version synced.\n\nNote that the dictionary is large enough to cache the whole dataset in memory, making lookups fast.\n\nThis migration is intended to be idempotent and rerunnable - if run multiple times, it should always set things to the same\nresult as if run once.\n\nSQL files available at: priv/data_migrations/LocationsSync/sql","ref":"Plausible.DataMigration.LocationsSync.html"},{"type":"function","title":"Plausible.DataMigration.LocationsSync.confirm/3","doc":"","ref":"Plausible.DataMigration.LocationsSync.html#confirm/3"},{"type":"function","title":"Plausible.DataMigration.LocationsSync.out_of_date?/0","doc":"","ref":"Plausible.DataMigration.LocationsSync.html#out_of_date?/0"},{"type":"function","title":"Plausible.DataMigration.LocationsSync.run/0","doc":"","ref":"Plausible.DataMigration.LocationsSync.html#run/0"},{"type":"function","title":"Plausible.DataMigration.LocationsSync.run_sql/3","doc":"","ref":"Plausible.DataMigration.LocationsSync.html#run_sql/3"},{"type":"function","title":"Plausible.DataMigration.LocationsSync.run_sql_confirm/2","doc":"","ref":"Plausible.DataMigration.LocationsSync.html#run_sql_confirm/2"},{"type":"module","title":"Plausible.DataMigration.NumericIDs","doc":"Numeric IDs migration, SQL files available at:\npriv/data_migrations/NumericIDs/sql","ref":"Plausible.DataMigration.NumericIDs.html"},{"type":"function","title":"Plausible.DataMigration.NumericIDs.confirm/3","doc":"","ref":"Plausible.DataMigration.NumericIDs.html#confirm/3"},{"type":"function","title":"Plausible.DataMigration.NumericIDs.run/1","doc":"","ref":"Plausible.DataMigration.NumericIDs.html#run/1"},{"type":"function","title":"Plausible.DataMigration.NumericIDs.run_sql/3","doc":"","ref":"Plausible.DataMigration.NumericIDs.html#run_sql/3"},{"type":"function","title":"Plausible.DataMigration.NumericIDs.run_sql_confirm/2","doc":"","ref":"Plausible.DataMigration.NumericIDs.html#run_sql_confirm/2"},{"type":"module","title":"Plausible.DataMigration.PopulateEventSessionColumns","doc":"Populates event session columns with data from sessions table.\n\nRun via: ./bin/plausible rpc \"Plausible.DataMigration.PopulateEventSessionColumns.run\"\nKill via: ./bin/plausible rpc \"Plausible.DataMigration.PopulateEventSessionColumns.kill\"\nMonitor via ./bin/plausible rpc \"Plausible.DataMigration.PopulateEventSessionColumns.report_progress\"\n\nSuggested to run in a screen/tmux session to be able to easily monitor\n\nSQL files available at: priv/data_migrations/PopulateEventSessionColumns/sql","ref":"Plausible.DataMigration.PopulateEventSessionColumns.html"},{"type":"function","title":"Plausible.DataMigration.PopulateEventSessionColumns.confirm/3","doc":"","ref":"Plausible.DataMigration.PopulateEventSessionColumns.html#confirm/3"},{"type":"function","title":"Plausible.DataMigration.PopulateEventSessionColumns.kill/1","doc":"","ref":"Plausible.DataMigration.PopulateEventSessionColumns.html#kill/1"},{"type":"function","title":"Plausible.DataMigration.PopulateEventSessionColumns.report_progress/1","doc":"","ref":"Plausible.DataMigration.PopulateEventSessionColumns.html#report_progress/1"},{"type":"function","title":"Plausible.DataMigration.PopulateEventSessionColumns.run/1","doc":"","ref":"Plausible.DataMigration.PopulateEventSessionColumns.html#run/1"},{"type":"function","title":"Plausible.DataMigration.PopulateEventSessionColumns.run_sql/3","doc":"","ref":"Plausible.DataMigration.PopulateEventSessionColumns.html#run_sql/3"},{"type":"function","title":"Plausible.DataMigration.PopulateEventSessionColumns.run_sql_confirm/2","doc":"","ref":"Plausible.DataMigration.PopulateEventSessionColumns.html#run_sql_confirm/2"},{"type":"function","title":"Plausible.DataMigration.PopulateEventSessionColumns.wait_until_mutations_complete/1","doc":"","ref":"Plausible.DataMigration.PopulateEventSessionColumns.html#wait_until_mutations_complete/1"},{"type":"module","title":"Plausible.DataMigration.Repo","doc":"Ecto.Repo for Clickhouse data migrations, to be started manually,\noutside of the main application supervision tree.","ref":"Plausible.DataMigration.Repo.html"},{"type":"function","title":"Plausible.DataMigration.Repo.aggregate/3","doc":"","ref":"Plausible.DataMigration.Repo.html#aggregate/3"},{"type":"function","title":"Plausible.DataMigration.Repo.aggregate/4","doc":"","ref":"Plausible.DataMigration.Repo.html#aggregate/4"},{"type":"function","title":"Plausible.DataMigration.Repo.all/2","doc":"","ref":"Plausible.DataMigration.Repo.html#all/2"},{"type":"function","title":"Plausible.DataMigration.Repo.alter_update_all/3","doc":"Similar to `Ecto.Repo.update_all/3` but uses [`ALTER TABLE ... UPDATE`](https://clickhouse.com/docs/en/sql-reference/statements/alter/update) instead.\n\nFor more information and performance implications please see:\n\n - https://clickhouse.com/blog/handling-updates-and-deletes-in-clickhouse\n - https://clickhouse.com/docs/en/guides/developer/mutations","ref":"Plausible.DataMigration.Repo.html#alter_update_all/3"},{"type":"function","title":"Plausible.DataMigration.Repo.checked_out?/0","doc":"","ref":"Plausible.DataMigration.Repo.html#checked_out?/0"},{"type":"function","title":"Plausible.DataMigration.Repo.checkout/2","doc":"","ref":"Plausible.DataMigration.Repo.html#checkout/2"},{"type":"function","title":"Plausible.DataMigration.Repo.child_spec/1","doc":"","ref":"Plausible.DataMigration.Repo.html#child_spec/1"},{"type":"function","title":"Plausible.DataMigration.Repo.config/0","doc":"","ref":"Plausible.DataMigration.Repo.html#config/0"},{"type":"function","title":"Plausible.DataMigration.Repo.default_options/1","doc":"","ref":"Plausible.DataMigration.Repo.html#default_options/1"},{"type":"function","title":"Plausible.DataMigration.Repo.delete/2","doc":"","ref":"Plausible.DataMigration.Repo.html#delete/2"},{"type":"function","title":"Plausible.DataMigration.Repo.delete!/2","doc":"","ref":"Plausible.DataMigration.Repo.html#delete!/2"},{"type":"function","title":"Plausible.DataMigration.Repo.delete_all/2","doc":"","ref":"Plausible.DataMigration.Repo.html#delete_all/2"},{"type":"function","title":"Plausible.DataMigration.Repo.disconnect_all/2","doc":"A convenience function for SQL-based repositories that forces all connections in the\npool to disconnect within the given interval.\n\nSee `Ecto.Adapters.SQL.disconnect_all/3` for more information.","ref":"Plausible.DataMigration.Repo.html#disconnect_all/2"},{"type":"function","title":"Plausible.DataMigration.Repo.exists?/2","doc":"","ref":"Plausible.DataMigration.Repo.html#exists?/2"},{"type":"function","title":"Plausible.DataMigration.Repo.get/3","doc":"","ref":"Plausible.DataMigration.Repo.html#get/3"},{"type":"function","title":"Plausible.DataMigration.Repo.get!/3","doc":"","ref":"Plausible.DataMigration.Repo.html#get!/3"},{"type":"function","title":"Plausible.DataMigration.Repo.get_by/3","doc":"","ref":"Plausible.DataMigration.Repo.html#get_by/3"},{"type":"function","title":"Plausible.DataMigration.Repo.get_by!/3","doc":"","ref":"Plausible.DataMigration.Repo.html#get_by!/3"},{"type":"function","title":"Plausible.DataMigration.Repo.get_dynamic_repo/0","doc":"","ref":"Plausible.DataMigration.Repo.html#get_dynamic_repo/0"},{"type":"function","title":"Plausible.DataMigration.Repo.insert/2","doc":"","ref":"Plausible.DataMigration.Repo.html#insert/2"},{"type":"function","title":"Plausible.DataMigration.Repo.insert!/2","doc":"","ref":"Plausible.DataMigration.Repo.html#insert!/2"},{"type":"function","title":"Plausible.DataMigration.Repo.insert_all/3","doc":"","ref":"Plausible.DataMigration.Repo.html#insert_all/3"},{"type":"function","title":"Plausible.DataMigration.Repo.insert_or_update/2","doc":"","ref":"Plausible.DataMigration.Repo.html#insert_or_update/2"},{"type":"function","title":"Plausible.DataMigration.Repo.insert_or_update!/2","doc":"","ref":"Plausible.DataMigration.Repo.html#insert_or_update!/2"},{"type":"function","title":"Plausible.DataMigration.Repo.insert_stream/3","doc":"Similar to `insert_all/2` but with the following differences:\n\n - accepts rows as streams or lists\n - sends rows as a chunked request\n - doesn't autogenerate ids or does any other preprocessing\n\nExample:\n\n Repo.query!(\"create table ecto_ch_demo(a UInt64, b String) engine Null\")\n\n defmodule Demo do\n use Ecto.Schema\n\n @primary_key false\n schema \"ecto_ch_demo\" do\n field :a, Ch, type: \"UInt64\"\n field :b, :string\n end\n end\n\n rows = Stream.map(1..100_000, fn i -> %{a: i, b: to_string(i)} end)\n {100_000, nil} = Repo.insert_stream(Demo, rows)\n\n # schemaless\n {100_000, nil} = Repo.insert_stream(\"ecto_ch_demo\", rows, types: [a: Ch.Types.u64(), b: :string])","ref":"Plausible.DataMigration.Repo.html#insert_stream/3"},{"type":"function","title":"Plausible.DataMigration.Repo.load/2","doc":"","ref":"Plausible.DataMigration.Repo.html#load/2"},{"type":"function","title":"Plausible.DataMigration.Repo.one/2","doc":"","ref":"Plausible.DataMigration.Repo.html#one/2"},{"type":"function","title":"Plausible.DataMigration.Repo.one!/2","doc":"","ref":"Plausible.DataMigration.Repo.html#one!/2"},{"type":"function","title":"Plausible.DataMigration.Repo.preload/3","doc":"","ref":"Plausible.DataMigration.Repo.html#preload/3"},{"type":"function","title":"Plausible.DataMigration.Repo.prepare_query/3","doc":"","ref":"Plausible.DataMigration.Repo.html#prepare_query/3"},{"type":"function","title":"Plausible.DataMigration.Repo.put_dynamic_repo/1","doc":"","ref":"Plausible.DataMigration.Repo.html#put_dynamic_repo/1"},{"type":"function","title":"Plausible.DataMigration.Repo.query/3","doc":"A convenience function for SQL-based repositories that executes the given query.\n\nSee `Ecto.Adapters.SQL.query/4` for more information.","ref":"Plausible.DataMigration.Repo.html#query/3"},{"type":"function","title":"Plausible.DataMigration.Repo.query!/3","doc":"A convenience function for SQL-based repositories that executes the given query.\n\nSee `Ecto.Adapters.SQL.query!/4` for more information.","ref":"Plausible.DataMigration.Repo.html#query!/3"},{"type":"function","title":"Plausible.DataMigration.Repo.reload/2","doc":"","ref":"Plausible.DataMigration.Repo.html#reload/2"},{"type":"function","title":"Plausible.DataMigration.Repo.reload!/2","doc":"","ref":"Plausible.DataMigration.Repo.html#reload!/2"},{"type":"function","title":"Plausible.DataMigration.Repo.start/2","doc":"","ref":"Plausible.DataMigration.Repo.html#start/2"},{"type":"function","title":"Plausible.DataMigration.Repo.start_link/1","doc":"","ref":"Plausible.DataMigration.Repo.html#start_link/1"},{"type":"function","title":"Plausible.DataMigration.Repo.stop/1","doc":"","ref":"Plausible.DataMigration.Repo.html#stop/1"},{"type":"function","title":"Plausible.DataMigration.Repo.stream/2","doc":"","ref":"Plausible.DataMigration.Repo.html#stream/2"},{"type":"function","title":"Plausible.DataMigration.Repo.to_inline_sql/2","doc":"Similar to `to_sql/2` but inlines the parameters into the SQL query.\n\nSee `Ecto.Adapters.ClickHouse.to_inline_sql/2` for more information.","ref":"Plausible.DataMigration.Repo.html#to_inline_sql/2"},{"type":"function","title":"Plausible.DataMigration.Repo.to_sql/2","doc":"A convenience function for SQL-based repositories that translates the given query to SQL.\n\nSee `Ecto.Adapters.SQL.to_sql/3` for more information.","ref":"Plausible.DataMigration.Repo.html#to_sql/2"},{"type":"function","title":"Plausible.DataMigration.Repo.update/2","doc":"","ref":"Plausible.DataMigration.Repo.html#update/2"},{"type":"function","title":"Plausible.DataMigration.Repo.update!/2","doc":"","ref":"Plausible.DataMigration.Repo.html#update!/2"},{"type":"function","title":"Plausible.DataMigration.Repo.update_all/3","doc":"","ref":"Plausible.DataMigration.Repo.html#update_all/3"},{"type":"module","title":"Plausible.DataMigration.SiteImports","doc":"!!!WARNING!!!: This script is used in migrations. Please take special care\nwhen altering it.\n\nSite imports migration backfilling SiteImport entries for old imports\nand alters import end dates to match actual end date of respective import stats.","ref":"Plausible.DataMigration.SiteImports.html"},{"type":"function","title":"Plausible.DataMigration.SiteImports.run/1","doc":"","ref":"Plausible.DataMigration.SiteImports.html#run/1"},{"type":"module","title":"Plausible.DataMigration.VersionedSessions","doc":"!!!WARNING!!!: This script is used in migrations. Please take special care\nwhen altering it.\n\nSessions CollapsingMergeTree -> VersionedCollapsingMergeTree migration,\nSQL files available at:\n\npriv/data_migrations/VersionedSessions/sql","ref":"Plausible.DataMigration.VersionedSessions.html"},{"type":"function","title":"Plausible.DataMigration.VersionedSessions.confirm/3","doc":"","ref":"Plausible.DataMigration.VersionedSessions.html#confirm/3"},{"type":"function","title":"Plausible.DataMigration.VersionedSessions.run/1","doc":"","ref":"Plausible.DataMigration.VersionedSessions.html#run/1"},{"type":"function","title":"Plausible.DataMigration.VersionedSessions.run_sql/3","doc":"","ref":"Plausible.DataMigration.VersionedSessions.html#run_sql/3"},{"type":"function","title":"Plausible.DataMigration.VersionedSessions.run_sql_confirm/2","doc":"","ref":"Plausible.DataMigration.VersionedSessions.html#run_sql_confirm/2"},{"type":"module","title":"Plausible.DebugReplayInfo","doc":"Function execution context (with arguments) to Sentry reports.","ref":"Plausible.DebugReplayInfo.html"},{"type":"function","title":"Plausible.DebugReplayInfo.deserialize/1","doc":"","ref":"Plausible.DebugReplayInfo.html#deserialize/1"},{"type":"macro","title":"Plausible.DebugReplayInfo.include_sentry_replay_info/0","doc":"","ref":"Plausible.DebugReplayInfo.html#include_sentry_replay_info/0"},{"type":"module","title":"Plausible.Ecto.EventName","doc":"Custom type for event name. Accepts Strings and Integers and stores them as String. Returns\n cast error if any other type is provided. Accepting integers is important for 404 tracking.","ref":"Plausible.Ecto.EventName.html"},{"type":"function","title":"Plausible.Ecto.EventName.cast/1","doc":"","ref":"Plausible.Ecto.EventName.html#cast/1"},{"type":"function","title":"Plausible.Ecto.EventName.dump/1","doc":"","ref":"Plausible.Ecto.EventName.html#dump/1"},{"type":"function","title":"Plausible.Ecto.EventName.embed_as/1","doc":"","ref":"Plausible.Ecto.EventName.html#embed_as/1"},{"type":"function","title":"Plausible.Ecto.EventName.equal?/2","doc":"","ref":"Plausible.Ecto.EventName.html#equal?/2"},{"type":"function","title":"Plausible.Ecto.EventName.load/1","doc":"","ref":"Plausible.Ecto.EventName.html#load/1"},{"type":"function","title":"Plausible.Ecto.EventName.type/0","doc":"","ref":"Plausible.Ecto.EventName.html#type/0"},{"type":"module","title":"Plausible.Ecto.Types.CompiledRegex","doc":"Ensures that the regex is compiled on load","ref":"Plausible.Ecto.Types.CompiledRegex.html"},{"type":"function","title":"Plausible.Ecto.Types.CompiledRegex.cast/1","doc":"","ref":"Plausible.Ecto.Types.CompiledRegex.html#cast/1"},{"type":"function","title":"Plausible.Ecto.Types.CompiledRegex.dump/1","doc":"","ref":"Plausible.Ecto.Types.CompiledRegex.html#dump/1"},{"type":"function","title":"Plausible.Ecto.Types.CompiledRegex.embed_as/1","doc":"","ref":"Plausible.Ecto.Types.CompiledRegex.html#embed_as/1"},{"type":"function","title":"Plausible.Ecto.Types.CompiledRegex.equal?/2","doc":"","ref":"Plausible.Ecto.Types.CompiledRegex.html#equal?/2"},{"type":"function","title":"Plausible.Ecto.Types.CompiledRegex.load/1","doc":"","ref":"Plausible.Ecto.Types.CompiledRegex.html#load/1"},{"type":"function","title":"Plausible.Ecto.Types.CompiledRegex.type/0","doc":"","ref":"Plausible.Ecto.Types.CompiledRegex.html#type/0"},{"type":"module","title":"Plausible.Exports","doc":"Contains functions to export data for events and sessions as Zip archives.","ref":"Plausible.Exports.html"},{"type":"function","title":"Plausible.Exports.archive_filename/2","doc":"Renders export archive filename.\n\nExamples:\n\n iex> archive_filename(\"plausible.io\", _created_on = ~D[2024-12-31])\n \"plausible_io_20241231.zip\"","ref":"Plausible.Exports.html#archive_filename/2"},{"type":"function","title":"Plausible.Exports.content_disposition/1","doc":"Safely renders content disposition for an arbitrary export filename.\n\nExamples:\n\n iex> content_disposition(\"plausible_io_20241231.zip\")\n \"attachment; filename=\\\"plausible_io_20241231.zip\\\"\"\n\n iex> content_disposition(\"📊.zip\")\n \"attachment; filename=\\\"plausible-export.zip\\\"; filename*=utf-8''%F0%9F%93%8A.zip\"","ref":"Plausible.Exports.html#content_disposition/1"},{"type":"function","title":"Plausible.Exports.date_range/2","doc":"Returns the date range for the site's events data in site's timezone or `nil` if there is no data","ref":"Plausible.Exports.html#date_range/2"},{"type":"function","title":"Plausible.Exports.delete_local_export/1","doc":"Deletes local export for a site","ref":"Plausible.Exports.html#delete_local_export/1"},{"type":"function","title":"Plausible.Exports.delete_s3_export!/1","doc":"Deletes S3 export for a site. Raises if object storage is unavailable.","ref":"Plausible.Exports.html#delete_s3_export!/1"},{"type":"function","title":"Plausible.Exports.export_queries/2","doc":"Builds Ecto queries to export data from `events_v2` and `sessions_v2`\ntables into the format of `imported_*` tables for a website.","ref":"Plausible.Exports.html#export_queries/2"},{"type":"function","title":"Plausible.Exports.get_last_export_job/1","doc":"Gets last CSV export job for a site","ref":"Plausible.Exports.html#get_last_export_job/1"},{"type":"function","title":"Plausible.Exports.get_local_export/3","doc":"Gets local export for a site","ref":"Plausible.Exports.html#get_local_export/3"},{"type":"function","title":"Plausible.Exports.get_s3_export!/2","doc":"Gets S3 export for a site. Raises if object storage is unavailable.","ref":"Plausible.Exports.html#get_s3_export!/2"},{"type":"function","title":"Plausible.Exports.oban_listen/0","doc":"Subscribes to CSV export job notifications","ref":"Plausible.Exports.html#oban_listen/0"},{"type":"function","title":"Plausible.Exports.schedule_local_export/2","doc":"Schedules CSV export job to local storage","ref":"Plausible.Exports.html#schedule_local_export/2"},{"type":"function","title":"Plausible.Exports.schedule_s3_export/2","doc":"Schedules CSV export job to S3 storage","ref":"Plausible.Exports.html#schedule_s3_export/2"},{"type":"function","title":"Plausible.Exports.stream_archive/3","doc":"Creates a streamable Zip archive from the provided (named) Ecto queries.\n\nExample usage:\n\n {:ok, pool} = Ch.start_link(pool_size: 1)\n\n DBConnection.run(pool, fn conn ->\n conn\n |> stream_archive(export_queries(_site_id = 1), format: \"CSVWithNames\")\n |> Stream.into(File.stream!(\"export.zip\"))\n |> Stream.run()\n end)","ref":"Plausible.Exports.html#stream_archive/3"},{"type":"type","title":"Plausible.Exports.export/0","doc":"","ref":"Plausible.Exports.html#t:export/0"},{"type":"module","title":"Plausible.Factory","doc":"","ref":"Plausible.Factory.html"},{"type":"function","title":"Plausible.Factory.api_key_factory/0","doc":"","ref":"Plausible.Factory.html#api_key_factory/0"},{"type":"function","title":"Plausible.Factory.build/2","doc":"","ref":"Plausible.Factory.html#build/2"},{"type":"function","title":"Plausible.Factory.build_list/3","doc":"","ref":"Plausible.Factory.html#build_list/3"},{"type":"function","title":"Plausible.Factory.build_pair/2","doc":"","ref":"Plausible.Factory.html#build_pair/2"},{"type":"function","title":"Plausible.Factory.business_subscription_factory/0","doc":"","ref":"Plausible.Factory.html#business_subscription_factory/0"},{"type":"function","title":"Plausible.Factory.ch_session_factory/0","doc":"","ref":"Plausible.Factory.html#ch_session_factory/0"},{"type":"function","title":"Plausible.Factory.country_rule_factory/0","doc":"","ref":"Plausible.Factory.html#country_rule_factory/0"},{"type":"function","title":"Plausible.Factory.create/1","doc":"","ref":"Plausible.Factory.html#create/1"},{"type":"function","title":"Plausible.Factory.create/2","doc":"","ref":"Plausible.Factory.html#create/2"},{"type":"function","title":"Plausible.Factory.create_list/3","doc":"","ref":"Plausible.Factory.html#create_list/3"},{"type":"function","title":"Plausible.Factory.create_pair/2","doc":"","ref":"Plausible.Factory.html#create_pair/2"},{"type":"function","title":"Plausible.Factory.drop_notification_factory/0","doc":"","ref":"Plausible.Factory.html#drop_notification_factory/0"},{"type":"function","title":"Plausible.Factory.enterprise_plan_factory/0","doc":"","ref":"Plausible.Factory.html#enterprise_plan_factory/0"},{"type":"function","title":"Plausible.Factory.event_factory/0","doc":"","ref":"Plausible.Factory.html#event_factory/0"},{"type":"function","title":"Plausible.Factory.factory/1","doc":"Raises a helpful error if no factory is defined.","ref":"Plausible.Factory.html#factory/1"},{"type":"function","title":"Plausible.Factory.goal_factory/1","doc":"","ref":"Plausible.Factory.html#goal_factory/1"},{"type":"function","title":"Plausible.Factory.google_auth_factory/0","doc":"","ref":"Plausible.Factory.html#google_auth_factory/0"},{"type":"function","title":"Plausible.Factory.growth_subscription_factory/0","doc":"","ref":"Plausible.Factory.html#growth_subscription_factory/0"},{"type":"function","title":"Plausible.Factory.imported_browsers_factory/0","doc":"","ref":"Plausible.Factory.html#imported_browsers_factory/0"},{"type":"function","title":"Plausible.Factory.imported_custom_events_factory/0","doc":"","ref":"Plausible.Factory.html#imported_custom_events_factory/0"},{"type":"function","title":"Plausible.Factory.imported_devices_factory/0","doc":"","ref":"Plausible.Factory.html#imported_devices_factory/0"},{"type":"function","title":"Plausible.Factory.imported_entry_pages_factory/0","doc":"","ref":"Plausible.Factory.html#imported_entry_pages_factory/0"},{"type":"function","title":"Plausible.Factory.imported_exit_pages_factory/0","doc":"","ref":"Plausible.Factory.html#imported_exit_pages_factory/0"},{"type":"function","title":"Plausible.Factory.imported_locations_factory/0","doc":"","ref":"Plausible.Factory.html#imported_locations_factory/0"},{"type":"function","title":"Plausible.Factory.imported_operating_systems_factory/0","doc":"","ref":"Plausible.Factory.html#imported_operating_systems_factory/0"},{"type":"function","title":"Plausible.Factory.imported_pages_factory/0","doc":"","ref":"Plausible.Factory.html#imported_pages_factory/0"},{"type":"function","title":"Plausible.Factory.imported_sources_factory/0","doc":"","ref":"Plausible.Factory.html#imported_sources_factory/0"},{"type":"function","title":"Plausible.Factory.imported_visitors_factory/0","doc":"","ref":"Plausible.Factory.html#imported_visitors_factory/0"},{"type":"function","title":"Plausible.Factory.insert/1","doc":"","ref":"Plausible.Factory.html#insert/1"},{"type":"function","title":"Plausible.Factory.insert/2","doc":"","ref":"Plausible.Factory.html#insert/2"},{"type":"function","title":"Plausible.Factory.insert/3","doc":"","ref":"Plausible.Factory.html#insert/3"},{"type":"function","title":"Plausible.Factory.insert_list/3","doc":"","ref":"Plausible.Factory.html#insert_list/3"},{"type":"function","title":"Plausible.Factory.insert_list/4","doc":"","ref":"Plausible.Factory.html#insert_list/4"},{"type":"function","title":"Plausible.Factory.insert_pair/2","doc":"","ref":"Plausible.Factory.html#insert_pair/2"},{"type":"function","title":"Plausible.Factory.insert_pair/3","doc":"","ref":"Plausible.Factory.html#insert_pair/3"},{"type":"function","title":"Plausible.Factory.invitation_factory/0","doc":"","ref":"Plausible.Factory.html#invitation_factory/0"},{"type":"function","title":"Plausible.Factory.ip_rule_factory/0","doc":"","ref":"Plausible.Factory.html#ip_rule_factory/0"},{"type":"function","title":"Plausible.Factory.monthly_report_factory/0","doc":"","ref":"Plausible.Factory.html#monthly_report_factory/0"},{"type":"function","title":"Plausible.Factory.pageview_factory/0","doc":"","ref":"Plausible.Factory.html#pageview_factory/0"},{"type":"function","title":"Plausible.Factory.params_for/2","doc":"","ref":"Plausible.Factory.html#params_for/2"},{"type":"function","title":"Plausible.Factory.params_with_assocs/2","doc":"","ref":"Plausible.Factory.html#params_with_assocs/2"},{"type":"function","title":"Plausible.Factory.shared_link_factory/0","doc":"","ref":"Plausible.Factory.html#shared_link_factory/0"},{"type":"function","title":"Plausible.Factory.site_factory/1","doc":"","ref":"Plausible.Factory.html#site_factory/1"},{"type":"function","title":"Plausible.Factory.site_import_factory/0","doc":"","ref":"Plausible.Factory.html#site_import_factory/0"},{"type":"function","title":"Plausible.Factory.site_membership_factory/0","doc":"","ref":"Plausible.Factory.html#site_membership_factory/0"},{"type":"function","title":"Plausible.Factory.spike_notification_factory/0","doc":"","ref":"Plausible.Factory.html#spike_notification_factory/0"},{"type":"function","title":"Plausible.Factory.string_params_for/2","doc":"","ref":"Plausible.Factory.html#string_params_for/2"},{"type":"function","title":"Plausible.Factory.string_params_with_assocs/2","doc":"","ref":"Plausible.Factory.html#string_params_with_assocs/2"},{"type":"function","title":"Plausible.Factory.subscription_factory/0","doc":"","ref":"Plausible.Factory.html#subscription_factory/0"},{"type":"function","title":"Plausible.Factory.user_factory/1","doc":"","ref":"Plausible.Factory.html#user_factory/1"},{"type":"function","title":"Plausible.Factory.weekly_report_factory/0","doc":"","ref":"Plausible.Factory.html#weekly_report_factory/0"},{"type":"module","title":"Plausible.Funnel","doc":"A funnel is a marketing term used to capture and describe the journey\nthat users go through, from initial step to conversion.\nA funnel consists of several steps (here: 2..8).\n\nThis module defines the database schema for storing funnels\nand changeset helpers for enumerating the steps within.\n\nEach step references a goal (either a Custom Event or Visit)\n- see: `Plausible.Goal`.","ref":"Plausible.Funnel.html"},{"type":"function","title":"Plausible.Funnel.changeset/2","doc":"","ref":"Plausible.Funnel.html#changeset/2"},{"type":"macro","title":"Plausible.Funnel.max_steps/0","doc":"","ref":"Plausible.Funnel.html#max_steps/0"},{"type":"macro","title":"Plausible.Funnel.min_steps/0","doc":"","ref":"Plausible.Funnel.html#min_steps/0"},{"type":"function","title":"Plausible.Funnel.put_steps/2","doc":"","ref":"Plausible.Funnel.html#put_steps/2"},{"type":"type","title":"Plausible.Funnel.t/0","doc":"","ref":"Plausible.Funnel.html#t:t/0"},{"type":"module","title":"Plausible.Funnel.Const","doc":"Compile-time convenience constants for funnel characteristics.","ref":"Plausible.Funnel.Const.html"},{"type":"macro","title":"Plausible.Funnel.Const.max_steps/0","doc":"","ref":"Plausible.Funnel.Const.html#max_steps/0"},{"type":"macro","title":"Plausible.Funnel.Const.min_steps/0","doc":"","ref":"Plausible.Funnel.Const.html#min_steps/0"},{"type":"module","title":"Plausible.Funnel.Step","doc":"This module defines the database schema for a single Funnel step.\nSee: `Plausible.Funnel` for more information.","ref":"Plausible.Funnel.Step.html"},{"type":"function","title":"Plausible.Funnel.Step.changeset/2","doc":"","ref":"Plausible.Funnel.Step.html#changeset/2"},{"type":"type","title":"Plausible.Funnel.Step.t/0","doc":"","ref":"Plausible.Funnel.Step.html#t:t/0"},{"type":"module","title":"Plausible.Funnels","doc":"This module implements contextual Funnel interface, allowing listing,\ncreating and deleting funnel definitions.\n\nFor brief explanation of what a Funnel is, please see `Plausible.Funnel` schema.\nSee `Plausible.Stats.Funnel` for the evaluation logic.","ref":"Plausible.Funnels.html"},{"type":"function","title":"Plausible.Funnels.create/3","doc":"","ref":"Plausible.Funnels.html#create/3"},{"type":"function","title":"Plausible.Funnels.create_changeset/3","doc":"","ref":"Plausible.Funnels.html#create_changeset/3"},{"type":"function","title":"Plausible.Funnels.delete/2","doc":"","ref":"Plausible.Funnels.html#delete/2"},{"type":"function","title":"Plausible.Funnels.edit_changeset/3","doc":"","ref":"Plausible.Funnels.html#edit_changeset/3"},{"type":"function","title":"Plausible.Funnels.ephemeral_definition/3","doc":"","ref":"Plausible.Funnels.html#ephemeral_definition/3"},{"type":"function","title":"Plausible.Funnels.get/2","doc":"","ref":"Plausible.Funnels.html#get/2"},{"type":"function","title":"Plausible.Funnels.list/1","doc":"","ref":"Plausible.Funnels.html#list/1"},{"type":"function","title":"Plausible.Funnels.update/3","doc":"","ref":"Plausible.Funnels.html#update/3"},{"type":"function","title":"Plausible.Funnels.with_goals_query/1","doc":"","ref":"Plausible.Funnels.html#with_goals_query/1"},{"type":"module","title":"Plausible.Geo","doc":"This module provides an API for fetching IP geolocation.","ref":"Plausible.Geo.html"},{"type":"function","title":"Plausible.Geo.await_loader/0","doc":"Waits for the database to start after calling `load_db/1` with the async option.","ref":"Plausible.Geo.html#await_loader/0"},{"type":"function","title":"Plausible.Geo.database_type/0","doc":"Returns geodatabase type.\n\nUsed for deciding whether to show the DB-IP disclaimer or not.","ref":"Plausible.Geo.html#database_type/0"},{"type":"function","title":"Examples - Plausible.Geo.database_type/0","doc":"In the case of a DB-IP database:\n\n iex> database_type()\n \"DBIP-City-Lite\"\n\n In the case of a MaxMind database:\n\n iex> database_type()\n \"GeoLite2-City\"","ref":"Plausible.Geo.html#database_type/0-examples"},{"type":"function","title":"Plausible.Geo.load_db/1","doc":"Starts the geodatabase loading process. Two modes are supported: local file\nand MaxMind license key.","ref":"Plausible.Geo.html#load_db/1"},{"type":"function","title":"Options - Plausible.Geo.load_db/1","doc":"* `:path` - the path to the .mmdb database local file. When present,\n `:license_key` and `:edition` are not required.\n\n * `:license_key` - the [license key](https://support.maxmind.com/hc/en-us/articles/4407111582235-Generate-a-License-Key)\n from MaxMind to authenticate requests to MaxMind.\n\n * `:edition` - the name of the MaxMind database to be downloaded from MaxMind\n servers. Defaults to `GeoLite2-City`.\n\n * `:cache_dir` - if set, the downloaded .mmdb files are cached there across\n restarts.\n\n * `:async` - when used, configures the database loading to run\n asynchronously.","ref":"Plausible.Geo.html#load_db/1-options"},{"type":"function","title":"Examples - Plausible.Geo.load_db/1","doc":"Loading from a local file:\n\n iex> load_db(path: \"/etc/plausible/dbip-city.mmdb\")\n :ok\n\n Downloading a MaxMind DB (this license key is no longer active):\n\n iex> load_db(license_key: \"LNpsJCCKPis6XvBP\", edition: \"GeoLite2-City\", async: true)\n :ok","ref":"Plausible.Geo.html#load_db/1-examples"},{"type":"function","title":"Plausible.Geo.lookup/1","doc":"Looks up geo info about an IP address.","ref":"Plausible.Geo.html#lookup/1"},{"type":"function","title":"Examples - Plausible.Geo.lookup/1","doc":"iex> lookup(\"8.7.6.5\")\n %{\n \"city\" => %{\n \"geoname_id\" => 5349755,\n \"names\" => %{\n \"de\" => \"Fontana\",\n \"en\" => \"Fontana\",\n \"ja\" => \"フォンタナ\",\n \"ru\" => \"Фонтана\"\n }\n },\n \"continent\" => %{\n \"code\" => \"NA\",\n \"geoname_id\" => 6255149,\n \"names\" => %{\n \"de\" => \"Nordamerika\",\n \"en\" => \"North America\",\n \"es\" => \"Norteamérica\",\n \"fr\" => \"Amérique du Nord\",\n \"ja\" => \"北アメリカ\",\n \"pt-BR\" => \"América do Norte\",\n \"ru\" => \"Северная Америка\",\n \"zh-CN\" => \"北美洲\"\n }\n },\n \"country\" => %{\n \"geoname_id\" => 6252001,\n \"iso_code\" => \"US\",\n \"names\" => %{\n \"de\" => \"Vereinigte Staaten\",\n \"en\" => \"United States\",\n \"es\" => \"Estados Unidos\",\n \"fr\" => \"États Unis\",\n \"ja\" => \"アメリカ\",\n \"pt-BR\" => \"EUA\",\n \"ru\" => \"США\",\n \"zh-CN\" => \"美国\"\n }\n },\n \"location\" => %{\n \"accuracy_radius\" => 50,\n \"latitude\" => 34.1211,\n \"longitude\" => -117.4362,\n \"metro_code\" => 803,\n \"time_zone\" => \"America/Los_Angeles\"\n },\n \"postal\" => %{\"code\" => \"92336\"},\n \"registered_country\" => %{\n \"geoname_id\" => 6252001,\n \"iso_code\" => \"US\",\n \"names\" => %{\n \"de\" => \"Vereinigte Staaten\",\n \"en\" => \"United States\",\n \"es\" => \"Estados Unidos\",\n \"fr\" => \"États Unis\",\n \"ja\" => \"アメリカ\",\n \"pt-BR\" => \"EUA\",\n \"ru\" => \"США\",\n \"zh-CN\" => \"美国\"\n }\n },\n \"subdivisions\" => [\n %{\n \"geoname_id\" => 5332921,\n \"iso_code\" => \"CA\",\n \"names\" => %{\n \"de\" => \"Kalifornien\",\n \"en\" => \"California\",\n \"es\" => \"California\",\n \"fr\" => \"Californie\",\n \"ja\" => \"カリフォルニア州\",\n \"pt-BR\" => \"Califórnia\",\n \"ru\" => \"Калифорния\",\n \"zh-CN\" => \"加州\"\n }\n }\n ]\n }","ref":"Plausible.Geo.html#lookup/1-examples"},{"type":"module","title":"Plausible.Goal","doc":"","ref":"Plausible.Goal.html"},{"type":"function","title":"Plausible.Goal.changeset/2","doc":"","ref":"Plausible.Goal.html#changeset/2"},{"type":"function","title":"Plausible.Goal.display_name/1","doc":"","ref":"Plausible.Goal.html#display_name/1"},{"type":"function","title":"Plausible.Goal.max_event_name_length/0","doc":"","ref":"Plausible.Goal.html#max_event_name_length/0"},{"type":"function","title":"Plausible.Goal.type/1","doc":"","ref":"Plausible.Goal.html#type/1"},{"type":"type","title":"Plausible.Goal.t/0","doc":"","ref":"Plausible.Goal.html#t:t/0"},{"type":"module","title":"Plausible.Goal.Revenue","doc":"Currency specific functions for revenue goals","ref":"Plausible.Goal.Revenue.html"},{"type":"function","title":"Plausible.Goal.Revenue.currency_option/1","doc":"","ref":"Plausible.Goal.Revenue.html#currency_option/1"},{"type":"function","title":"Plausible.Goal.Revenue.currency_options/0","doc":"","ref":"Plausible.Goal.Revenue.html#currency_options/0"},{"type":"function","title":"Plausible.Goal.Revenue.display/1","doc":"","ref":"Plausible.Goal.Revenue.html#display/1"},{"type":"function","title":"Plausible.Goal.Revenue.revenue?/1","doc":"","ref":"Plausible.Goal.Revenue.html#revenue?/1"},{"type":"function","title":"Plausible.Goal.Revenue.valid_currencies/0","doc":"","ref":"Plausible.Goal.Revenue.html#valid_currencies/0"},{"type":"module","title":"Plausible.Goals","doc":"","ref":"Plausible.Goals.html"},{"type":"function","title":"Plausible.Goals.batch_create_event_goals/2","doc":"","ref":"Plausible.Goals.html#batch_create_event_goals/2"},{"type":"function","title":"Plausible.Goals.count/1","doc":"","ref":"Plausible.Goals.html#count/1"},{"type":"function","title":"Plausible.Goals.create/3","doc":"Creates a Goal for a site.\n\nIf the created goal is a revenue goal, it sets site.updated_at to be\nrefreshed by the sites cache, as revenue goals are used during ingestion.","ref":"Plausible.Goals.html#create/3"},{"type":"function","title":"Plausible.Goals.delete/2","doc":"If a goal belongs to funnel(s), we need to inspect their number of steps.\n\nIf it exceeds the minimum allowed (defined via `Plausible.Funnel.min_steps/0`),\nthe funnel will be reduced (i.e. a step associated with the goal to be deleted\nis removed), so that the minimum number of steps is preserved. This is done\nimplicitly, by postgres, as per on_delete: :delete_all.\n\nOtherwise, for associated funnel(s) consisting of minimum number steps only,\nfunnel record(s) are removed completely along with the targeted goal.","ref":"Plausible.Goals.html#delete/2"},{"type":"function","title":"Plausible.Goals.find_or_create/2","doc":"","ref":"Plausible.Goals.html#find_or_create/2"},{"type":"function","title":"Plausible.Goals.for_site/2","doc":"","ref":"Plausible.Goals.html#for_site/2"},{"type":"function","title":"Plausible.Goals.for_site_query/2","doc":"","ref":"Plausible.Goals.html#for_site_query/2"},{"type":"function","title":"Plausible.Goals.get/2","doc":"","ref":"Plausible.Goals.html#get/2"},{"type":"function","title":"Plausible.Goals.list_revenue_goals/1","doc":"","ref":"Plausible.Goals.html#list_revenue_goals/1"},{"type":"function","title":"Plausible.Goals.update/2","doc":"","ref":"Plausible.Goals.html#update/2"},{"type":"module","title":"Plausible.Google.API","doc":"API to Google services.","ref":"Plausible.Google.API.html"},{"type":"function","title":"Plausible.Google.API.fetch_access_token!/1","doc":"","ref":"Plausible.Google.API.html#fetch_access_token!/1"},{"type":"function","title":"Plausible.Google.API.fetch_stats/4","doc":"","ref":"Plausible.Google.API.html#fetch_stats/4"},{"type":"function","title":"Plausible.Google.API.fetch_verified_properties/1","doc":"","ref":"Plausible.Google.API.html#fetch_verified_properties/1"},{"type":"function","title":"Plausible.Google.API.get_analytics_end_date/2","doc":"","ref":"Plausible.Google.API.html#get_analytics_end_date/2"},{"type":"function","title":"Plausible.Google.API.get_analytics_start_date/2","doc":"","ref":"Plausible.Google.API.html#get_analytics_start_date/2"},{"type":"function","title":"Plausible.Google.API.get_property/2","doc":"","ref":"Plausible.Google.API.html#get_property/2"},{"type":"function","title":"Plausible.Google.API.import_authorize_url/1","doc":"","ref":"Plausible.Google.API.html#import_authorize_url/1"},{"type":"function","title":"Plausible.Google.API.list_properties/1","doc":"","ref":"Plausible.Google.API.html#list_properties/1"},{"type":"function","title":"Plausible.Google.API.maybe_refresh_token/1","doc":"","ref":"Plausible.Google.API.html#maybe_refresh_token/1"},{"type":"function","title":"Plausible.Google.API.property?/1","doc":"","ref":"Plausible.Google.API.html#property?/1"},{"type":"function","title":"Plausible.Google.API.search_console_authorize_url/1","doc":"","ref":"Plausible.Google.API.html#search_console_authorize_url/1"},{"type":"module","title":"Plausible.Google.API.Mock","doc":"Mock of API to Google services.","ref":"Plausible.Google.API.Mock.html"},{"type":"function","title":"Plausible.Google.API.Mock.fetch_stats/4","doc":"","ref":"Plausible.Google.API.Mock.html#fetch_stats/4"},{"type":"module","title":"Plausible.Google.GA4.API","doc":"API for Google Analytics 4.","ref":"Plausible.Google.GA4.API.html"},{"type":"function","title":"Plausible.Google.GA4.API.fetch_and_persist/2","doc":"","ref":"Plausible.Google.GA4.API.html#fetch_and_persist/2"},{"type":"function","title":"Plausible.Google.GA4.API.get_analytics_end_date/2","doc":"","ref":"Plausible.Google.GA4.API.html#get_analytics_end_date/2"},{"type":"function","title":"Plausible.Google.GA4.API.get_analytics_start_date/2","doc":"","ref":"Plausible.Google.GA4.API.html#get_analytics_start_date/2"},{"type":"function","title":"Plausible.Google.GA4.API.get_property/2","doc":"","ref":"Plausible.Google.GA4.API.html#get_property/2"},{"type":"function","title":"Plausible.Google.GA4.API.import_analytics/4","doc":"","ref":"Plausible.Google.GA4.API.html#import_analytics/4"},{"type":"function","title":"Plausible.Google.GA4.API.list_properties/1","doc":"","ref":"Plausible.Google.GA4.API.html#list_properties/1"},{"type":"type","title":"Plausible.Google.GA4.API.import_auth/0","doc":"","ref":"Plausible.Google.GA4.API.html#t:import_auth/0"},{"type":"module","title":"Plausible.Google.GA4.HTTP","doc":"HTTP client implementation for Google Analytics 4 API.","ref":"Plausible.Google.GA4.HTTP.html"},{"type":"function","title":"Plausible.Google.GA4.HTTP.get_analytics_end_date/2","doc":"","ref":"Plausible.Google.GA4.HTTP.html#get_analytics_end_date/2"},{"type":"function","title":"Plausible.Google.GA4.HTTP.get_analytics_start_date/2","doc":"","ref":"Plausible.Google.GA4.HTTP.html#get_analytics_start_date/2"},{"type":"function","title":"Plausible.Google.GA4.HTTP.get_property/2","doc":"","ref":"Plausible.Google.GA4.HTTP.html#get_property/2"},{"type":"function","title":"Plausible.Google.GA4.HTTP.get_report/1","doc":"","ref":"Plausible.Google.GA4.HTTP.html#get_report/1"},{"type":"function","title":"Plausible.Google.GA4.HTTP.list_accounts_for_user/1","doc":"","ref":"Plausible.Google.GA4.HTTP.html#list_accounts_for_user/1"},{"type":"module","title":"Plausible.Google.GA4.ReportRequest","doc":"Report request struct for Google Analytics 4 API","ref":"Plausible.Google.GA4.ReportRequest.html"},{"type":"function","title":"Plausible.Google.GA4.ReportRequest.full_report/0","doc":"","ref":"Plausible.Google.GA4.ReportRequest.html#full_report/0"},{"type":"type","title":"Plausible.Google.GA4.ReportRequest.t/0","doc":"","ref":"Plausible.Google.GA4.ReportRequest.html#t:t/0"},{"type":"module","title":"Plausible.Google.HTTP","doc":"","ref":"Plausible.Google.HTTP.html"},{"type":"function","title":"Plausible.Google.HTTP.fetch_access_token!/1","doc":"","ref":"Plausible.Google.HTTP.html#fetch_access_token!/1"},{"type":"function","title":"Plausible.Google.HTTP.list_sites/1","doc":"","ref":"Plausible.Google.HTTP.html#list_sites/1"},{"type":"function","title":"Plausible.Google.HTTP.list_stats/5","doc":"","ref":"Plausible.Google.HTTP.html#list_stats/5"},{"type":"function","title":"Plausible.Google.HTTP.refresh_auth_token/1","doc":"","ref":"Plausible.Google.HTTP.html#refresh_auth_token/1"},{"type":"module","title":"Plausible.HTTPClient","doc":"HTTP Client built on top of Finch.\n\nBy default, request parameters are json-encoded.\n\nIf a raw binary value is supplied, no encoding is performed.\nIf x-www-form-urlencoded content-type is set in headers,\nURL encoding is invoked.","ref":"Plausible.HTTPClient.html"},{"type":"function","title":"Plausible.HTTPClient.get/3","doc":"Make a GET request","ref":"Plausible.HTTPClient.html#get/3"},{"type":"function","title":"Plausible.HTTPClient.impl/0","doc":"","ref":"Plausible.HTTPClient.html#impl/0"},{"type":"function","title":"Plausible.HTTPClient.post/4","doc":"Make a POST request","ref":"Plausible.HTTPClient.html#post/4"},{"type":"behaviour","title":"Plausible.HTTPClient.Interface","doc":"","ref":"Plausible.HTTPClient.Interface.html"},{"type":"callback","title":"Plausible.HTTPClient.Interface.get/1","doc":"","ref":"Plausible.HTTPClient.Interface.html#c:get/1"},{"type":"callback","title":"Plausible.HTTPClient.Interface.get/2","doc":"","ref":"Plausible.HTTPClient.Interface.html#c:get/2"},{"type":"callback","title":"Plausible.HTTPClient.Interface.get/3","doc":"","ref":"Plausible.HTTPClient.Interface.html#c:get/3"},{"type":"callback","title":"Plausible.HTTPClient.Interface.post/3","doc":"","ref":"Plausible.HTTPClient.Interface.html#c:post/3"},{"type":"callback","title":"Plausible.HTTPClient.Interface.post/4","doc":"","ref":"Plausible.HTTPClient.Interface.html#c:post/4"},{"type":"type","title":"Plausible.HTTPClient.Interface.finch_request_opts/0","doc":"","ref":"Plausible.HTTPClient.Interface.html#t:finch_request_opts/0"},{"type":"type","title":"Plausible.HTTPClient.Interface.headers/0","doc":"","ref":"Plausible.HTTPClient.Interface.html#t:headers/0"},{"type":"type","title":"Plausible.HTTPClient.Interface.params/0","doc":"","ref":"Plausible.HTTPClient.Interface.html#t:params/0"},{"type":"type","title":"Plausible.HTTPClient.Interface.response/0","doc":"","ref":"Plausible.HTTPClient.Interface.html#t:response/0"},{"type":"type","title":"Plausible.HTTPClient.Interface.url/0","doc":"","ref":"Plausible.HTTPClient.Interface.html#t:url/0"},{"type":"module","title":"Plausible.HTTPClient.Non200Error","doc":"","ref":"Plausible.HTTPClient.Non200Error.html"},{"type":"function","title":"Plausible.HTTPClient.Non200Error.new/1","doc":"","ref":"Plausible.HTTPClient.Non200Error.html#new/1"},{"type":"type","title":"Plausible.HTTPClient.Non200Error.t/0","doc":"","ref":"Plausible.HTTPClient.Non200Error.html#t:t/0"},{"type":"module","title":"Plausible.HelpScout","doc":"HelpScout callback API logic.","ref":"Plausible.HelpScout.html"},{"type":"function","title":"Plausible.HelpScout.get_details_for_customer/1","doc":"","ref":"Plausible.HelpScout.html#get_details_for_customer/1"},{"type":"function","title":"Plausible.HelpScout.get_details_for_emails/2","doc":"","ref":"Plausible.HelpScout.html#get_details_for_emails/2"},{"type":"function","title":"Plausible.HelpScout.search_users/2","doc":"","ref":"Plausible.HelpScout.html#search_users/2"},{"type":"function","title":"Plausible.HelpScout.signature_errors/0","doc":"","ref":"Plausible.HelpScout.html#signature_errors/0"},{"type":"function","title":"Plausible.HelpScout.validate_signature/1","doc":"Validates signature against secret key configured for the\nHelpScout application.\n\nNOTE: HelpScout signature generation procedure at\nhttps://developer.helpscout.com/apps/guides/signature-validation/\nfails to mention that it's implicitly dependent on request params\norder getting preserved. PHP arrays are ordered maps, so they provide\nthis guarantee. Here, on the other hand, we have to determine the original\norder of the keys directly from the query string and serialize\nparams to JSON using wrapper struct, informing Jason to put the values\nin the serialized object in this particular order matching query string.","ref":"Plausible.HelpScout.html#validate_signature/1"},{"type":"type","title":"Plausible.HelpScout.signature_error/0","doc":"","ref":"Plausible.HelpScout.html#t:signature_error/0"},{"type":"module","title":"Plausible.HelpScout.Vault","doc":"Provides a vault that will be used to encrypt/decrypt the stored HelpScout API access tokens.","ref":"Plausible.HelpScout.Vault.html"},{"type":"function","title":"Plausible.HelpScout.Vault.child_spec/1","doc":"Returns a specification to start this module under a supervisor.\n\nSee `Supervisor`.","ref":"Plausible.HelpScout.Vault.html#child_spec/1"},{"type":"function","title":"Plausible.HelpScout.Vault.start_link/1","doc":"","ref":"Plausible.HelpScout.Vault.html#start_link/1"},{"type":"module","title":"Plausible.Helpers.JSON","doc":"Common helpers for JSON handling","ref":"Plausible.Helpers.JSON.html"},{"type":"function","title":"Plausible.Helpers.JSON.decode_or_fallback/1","doc":"","ref":"Plausible.Helpers.JSON.html#decode_or_fallback/1"},{"type":"module","title":"Plausible.ImportDeletionRepo","doc":"A dedicated repo for import related mutations","ref":"Plausible.ImportDeletionRepo.html"},{"type":"function","title":"Plausible.ImportDeletionRepo.aggregate/3","doc":"","ref":"Plausible.ImportDeletionRepo.html#aggregate/3"},{"type":"function","title":"Plausible.ImportDeletionRepo.aggregate/4","doc":"","ref":"Plausible.ImportDeletionRepo.html#aggregate/4"},{"type":"function","title":"Plausible.ImportDeletionRepo.all/2","doc":"","ref":"Plausible.ImportDeletionRepo.html#all/2"},{"type":"function","title":"Plausible.ImportDeletionRepo.alter_update_all/3","doc":"Similar to `Ecto.Repo.update_all/3` but uses [`ALTER TABLE ... UPDATE`](https://clickhouse.com/docs/en/sql-reference/statements/alter/update) instead.\n\nFor more information and performance implications please see:\n\n - https://clickhouse.com/blog/handling-updates-and-deletes-in-clickhouse\n - https://clickhouse.com/docs/en/guides/developer/mutations","ref":"Plausible.ImportDeletionRepo.html#alter_update_all/3"},{"type":"function","title":"Plausible.ImportDeletionRepo.checked_out?/0","doc":"","ref":"Plausible.ImportDeletionRepo.html#checked_out?/0"},{"type":"function","title":"Plausible.ImportDeletionRepo.checkout/2","doc":"","ref":"Plausible.ImportDeletionRepo.html#checkout/2"},{"type":"function","title":"Plausible.ImportDeletionRepo.child_spec/1","doc":"","ref":"Plausible.ImportDeletionRepo.html#child_spec/1"},{"type":"function","title":"Plausible.ImportDeletionRepo.config/0","doc":"","ref":"Plausible.ImportDeletionRepo.html#config/0"},{"type":"function","title":"Plausible.ImportDeletionRepo.default_options/1","doc":"","ref":"Plausible.ImportDeletionRepo.html#default_options/1"},{"type":"function","title":"Plausible.ImportDeletionRepo.delete/2","doc":"","ref":"Plausible.ImportDeletionRepo.html#delete/2"},{"type":"function","title":"Plausible.ImportDeletionRepo.delete!/2","doc":"","ref":"Plausible.ImportDeletionRepo.html#delete!/2"},{"type":"function","title":"Plausible.ImportDeletionRepo.delete_all/2","doc":"","ref":"Plausible.ImportDeletionRepo.html#delete_all/2"},{"type":"function","title":"Plausible.ImportDeletionRepo.disconnect_all/2","doc":"A convenience function for SQL-based repositories that forces all connections in the\npool to disconnect within the given interval.\n\nSee `Ecto.Adapters.SQL.disconnect_all/3` for more information.","ref":"Plausible.ImportDeletionRepo.html#disconnect_all/2"},{"type":"function","title":"Plausible.ImportDeletionRepo.exists?/2","doc":"","ref":"Plausible.ImportDeletionRepo.html#exists?/2"},{"type":"function","title":"Plausible.ImportDeletionRepo.get/3","doc":"","ref":"Plausible.ImportDeletionRepo.html#get/3"},{"type":"function","title":"Plausible.ImportDeletionRepo.get!/3","doc":"","ref":"Plausible.ImportDeletionRepo.html#get!/3"},{"type":"function","title":"Plausible.ImportDeletionRepo.get_by/3","doc":"","ref":"Plausible.ImportDeletionRepo.html#get_by/3"},{"type":"function","title":"Plausible.ImportDeletionRepo.get_by!/3","doc":"","ref":"Plausible.ImportDeletionRepo.html#get_by!/3"},{"type":"function","title":"Plausible.ImportDeletionRepo.get_dynamic_repo/0","doc":"","ref":"Plausible.ImportDeletionRepo.html#get_dynamic_repo/0"},{"type":"function","title":"Plausible.ImportDeletionRepo.insert/2","doc":"","ref":"Plausible.ImportDeletionRepo.html#insert/2"},{"type":"function","title":"Plausible.ImportDeletionRepo.insert!/2","doc":"","ref":"Plausible.ImportDeletionRepo.html#insert!/2"},{"type":"function","title":"Plausible.ImportDeletionRepo.insert_all/3","doc":"","ref":"Plausible.ImportDeletionRepo.html#insert_all/3"},{"type":"function","title":"Plausible.ImportDeletionRepo.insert_or_update/2","doc":"","ref":"Plausible.ImportDeletionRepo.html#insert_or_update/2"},{"type":"function","title":"Plausible.ImportDeletionRepo.insert_or_update!/2","doc":"","ref":"Plausible.ImportDeletionRepo.html#insert_or_update!/2"},{"type":"function","title":"Plausible.ImportDeletionRepo.insert_stream/3","doc":"Similar to `insert_all/2` but with the following differences:\n\n - accepts rows as streams or lists\n - sends rows as a chunked request\n - doesn't autogenerate ids or does any other preprocessing\n\nExample:\n\n Repo.query!(\"create table ecto_ch_demo(a UInt64, b String) engine Null\")\n\n defmodule Demo do\n use Ecto.Schema\n\n @primary_key false\n schema \"ecto_ch_demo\" do\n field :a, Ch, type: \"UInt64\"\n field :b, :string\n end\n end\n\n rows = Stream.map(1..100_000, fn i -> %{a: i, b: to_string(i)} end)\n {100_000, nil} = Repo.insert_stream(Demo, rows)\n\n # schemaless\n {100_000, nil} = Repo.insert_stream(\"ecto_ch_demo\", rows, types: [a: Ch.Types.u64(), b: :string])","ref":"Plausible.ImportDeletionRepo.html#insert_stream/3"},{"type":"function","title":"Plausible.ImportDeletionRepo.load/2","doc":"","ref":"Plausible.ImportDeletionRepo.html#load/2"},{"type":"function","title":"Plausible.ImportDeletionRepo.one/2","doc":"","ref":"Plausible.ImportDeletionRepo.html#one/2"},{"type":"function","title":"Plausible.ImportDeletionRepo.one!/2","doc":"","ref":"Plausible.ImportDeletionRepo.html#one!/2"},{"type":"function","title":"Plausible.ImportDeletionRepo.preload/3","doc":"","ref":"Plausible.ImportDeletionRepo.html#preload/3"},{"type":"function","title":"Plausible.ImportDeletionRepo.prepare_query/3","doc":"","ref":"Plausible.ImportDeletionRepo.html#prepare_query/3"},{"type":"function","title":"Plausible.ImportDeletionRepo.put_dynamic_repo/1","doc":"","ref":"Plausible.ImportDeletionRepo.html#put_dynamic_repo/1"},{"type":"function","title":"Plausible.ImportDeletionRepo.query/3","doc":"A convenience function for SQL-based repositories that executes the given query.\n\nSee `Ecto.Adapters.SQL.query/4` for more information.","ref":"Plausible.ImportDeletionRepo.html#query/3"},{"type":"function","title":"Plausible.ImportDeletionRepo.query!/3","doc":"A convenience function for SQL-based repositories that executes the given query.\n\nSee `Ecto.Adapters.SQL.query!/4` for more information.","ref":"Plausible.ImportDeletionRepo.html#query!/3"},{"type":"function","title":"Plausible.ImportDeletionRepo.reload/2","doc":"","ref":"Plausible.ImportDeletionRepo.html#reload/2"},{"type":"function","title":"Plausible.ImportDeletionRepo.reload!/2","doc":"","ref":"Plausible.ImportDeletionRepo.html#reload!/2"},{"type":"function","title":"Plausible.ImportDeletionRepo.start_link/1","doc":"","ref":"Plausible.ImportDeletionRepo.html#start_link/1"},{"type":"function","title":"Plausible.ImportDeletionRepo.stop/1","doc":"","ref":"Plausible.ImportDeletionRepo.html#stop/1"},{"type":"function","title":"Plausible.ImportDeletionRepo.stream/2","doc":"","ref":"Plausible.ImportDeletionRepo.html#stream/2"},{"type":"function","title":"Plausible.ImportDeletionRepo.to_inline_sql/2","doc":"Similar to `to_sql/2` but inlines the parameters into the SQL query.\n\nSee `Ecto.Adapters.ClickHouse.to_inline_sql/2` for more information.","ref":"Plausible.ImportDeletionRepo.html#to_inline_sql/2"},{"type":"function","title":"Plausible.ImportDeletionRepo.to_sql/2","doc":"A convenience function for SQL-based repositories that translates the given query to SQL.\n\nSee `Ecto.Adapters.SQL.to_sql/3` for more information.","ref":"Plausible.ImportDeletionRepo.html#to_sql/2"},{"type":"function","title":"Plausible.ImportDeletionRepo.update/2","doc":"","ref":"Plausible.ImportDeletionRepo.html#update/2"},{"type":"function","title":"Plausible.ImportDeletionRepo.update!/2","doc":"","ref":"Plausible.ImportDeletionRepo.html#update!/2"},{"type":"function","title":"Plausible.ImportDeletionRepo.update_all/3","doc":"","ref":"Plausible.ImportDeletionRepo.html#update_all/3"},{"type":"module","title":"Plausible.Imported","doc":"Context for managing site statistics imports.\n\nFor list of currently supported import sources see `Plausible.Imported.ImportSources`.\n\nFor more information on implementing importers, see `Plausible.Imported.Importer`.","ref":"Plausible.Imported.html"},{"type":"function","title":"Plausible.Imported.clamp_dates/3","doc":"","ref":"Plausible.Imported.html#clamp_dates/3"},{"type":"function","title":"Plausible.Imported.clamp_dates/4","doc":"","ref":"Plausible.Imported.html#clamp_dates/4"},{"type":"function","title":"Plausible.Imported.delete_imports_for_site/1","doc":"","ref":"Plausible.Imported.html#delete_imports_for_site/1"},{"type":"function","title":"Plausible.Imported.get_cutoff_date/1","doc":"","ref":"Plausible.Imported.html#get_cutoff_date/1"},{"type":"function","title":"Plausible.Imported.get_import/2","doc":"","ref":"Plausible.Imported.html#get_import/2"},{"type":"function","title":"Plausible.Imported.get_imports_date_range/1","doc":"","ref":"Plausible.Imported.html#get_imports_date_range/1"},{"type":"function","title":"Plausible.Imported.get_legacy_import/1","doc":"","ref":"Plausible.Imported.html#get_legacy_import/1"},{"type":"function","title":"Plausible.Imported.get_occupied_date_ranges/1","doc":"","ref":"Plausible.Imported.html#get_occupied_date_ranges/1"},{"type":"function","title":"Plausible.Imported.goals_with_path/0","doc":"","ref":"Plausible.Imported.html#goals_with_path/0"},{"type":"function","title":"Plausible.Imported.goals_with_url/0","doc":"","ref":"Plausible.Imported.html#goals_with_url/0"},{"type":"function","title":"Plausible.Imported.imported_custom_props/0","doc":"","ref":"Plausible.Imported.html#imported_custom_props/0"},{"type":"function","title":"Plausible.Imported.list_all_imports/2","doc":"","ref":"Plausible.Imported.html#list_all_imports/2"},{"type":"function","title":"Plausible.Imported.list_complete_import_ids/1","doc":"","ref":"Plausible.Imported.html#list_complete_import_ids/1"},{"type":"function","title":"Plausible.Imported.listen/0","doc":"","ref":"Plausible.Imported.html#listen/0"},{"type":"function","title":"Plausible.Imported.load_import_data/1","doc":"","ref":"Plausible.Imported.html#load_import_data/1"},{"type":"function","title":"Plausible.Imported.max_complete_imports/0","doc":"","ref":"Plausible.Imported.html#max_complete_imports/0"},{"type":"function","title":"Plausible.Imported.other_imports_in_progress?/1","doc":"","ref":"Plausible.Imported.html#other_imports_in_progress?/1"},{"type":"function","title":"Plausible.Imported.schemas/0","doc":"","ref":"Plausible.Imported.html#schemas/0"},{"type":"function","title":"Plausible.Imported.tables/0","doc":"","ref":"Plausible.Imported.html#tables/0"},{"type":"module","title":"Plausible.Imported.Buffer","doc":"This GenServer inserts records into Clickhouse `imported_*` tables. Multiple buffers are\nautomatically created for each table. Records are flushed when the table buffer reaches the\nmaximum size, defined by `max_buffer_size/0`.","ref":"Plausible.Imported.Buffer.html"},{"type":"function","title":"Plausible.Imported.Buffer.child_spec/1","doc":"Returns a specification to start this module under a supervisor.\n\nSee `Supervisor`.","ref":"Plausible.Imported.Buffer.html#child_spec/1"},{"type":"function","title":"Plausible.Imported.Buffer.flush/2","doc":"Flushes all table buffers to Clickhouse.","ref":"Plausible.Imported.Buffer.html#flush/2"},{"type":"function","title":"Plausible.Imported.Buffer.handle_continue/2","doc":"","ref":"Plausible.Imported.Buffer.html#handle_continue/2"},{"type":"function","title":"Plausible.Imported.Buffer.init/1","doc":"","ref":"Plausible.Imported.Buffer.html#init/1"},{"type":"function","title":"Plausible.Imported.Buffer.insert_many/3","doc":"Puts the given records into the table buffer.","ref":"Plausible.Imported.Buffer.html#insert_many/3"},{"type":"function","title":"Plausible.Imported.Buffer.size/2","doc":"Returns the total count of items in the given table buffer.","ref":"Plausible.Imported.Buffer.html#size/2"},{"type":"function","title":"Plausible.Imported.Buffer.start_link/1","doc":"","ref":"Plausible.Imported.Buffer.html#start_link/1"},{"type":"function","title":"Plausible.Imported.Buffer.stop/1","doc":"","ref":"Plausible.Imported.Buffer.html#stop/1"},{"type":"module","title":"Plausible.Imported.CSVImporter","doc":"CSV importer from either S3 for which it uses ClickHouse [s3 table function](https://clickhouse.com/docs/en/sql-reference/table-functions/s3)\nor from local storage for which it uses [input function.](https://clickhouse.com/docs/en/sql-reference/table-functions/input)","ref":"Plausible.Imported.CSVImporter.html"},{"type":"function","title":"Plausible.Imported.CSVImporter.date_range/1","doc":"Extracts min/max date range from a list of uploads.\n\nExamples:\n\n iex> date_range([\n ...> %{\"filename\" => \"imported_devices_20190101_20210101.csv\"},\n ...> \"pages_20200101_20220101.csv\"\n ...> ])\n Date.range(~D[2019-01-01], ~D[2022-01-01])\n\n iex> date_range([])\n nil","ref":"Plausible.Imported.CSVImporter.html#date_range/1"},{"type":"function","title":"Plausible.Imported.CSVImporter.extract_table/1","doc":"Extracts the table name from the provided filename.\n\nRaises if the filename doesn't conform to the expected format.\n\nExamples:\n\n iex> extract_table(\"my_data.csv\")\n ** (ArgumentError) invalid filename\n\n iex> extract_table(\"imported_devices_00010101_20250101.csv\")\n \"imported_devices\"\n\n iex> extract_table(\"devices_00010101_20250101.csv\")\n \"imported_devices\"","ref":"Plausible.Imported.CSVImporter.html#extract_table/1"},{"type":"function","title":"Plausible.Imported.CSVImporter.local_dir/1","doc":"Returns local directory for CSV imports storage.\n\nBuilds upon `$DATA_DIR` or `$PERSISTENT_CACHE_DIR` (if set) and falls back to /tmp\n\nExamples:\n\n iex> local_dir = local_dir(_site_id = 37)\n iex> String.ends_with?(local_dir, \"/plausible-imports/37\")\n true","ref":"Plausible.Imported.CSVImporter.html#local_dir/1"},{"type":"function","title":"Plausible.Imported.CSVImporter.new_import/3","doc":"","ref":"Plausible.Imported.CSVImporter.html#new_import/3"},{"type":"function","title":"Plausible.Imported.CSVImporter.parse_filename!/1","doc":"Extracts table name and min/max dates from the filename.\n\nExamples:\n\n iex> parse_filename!(\"my_data.csv\")\n ** (ArgumentError) invalid filename\n\n iex> parse_filename!(\"imported_devices_00010101_20250101.csv\")\n {\"imported_devices\", ~D[0001-01-01], ~D[2025-01-01]}\n\n iex> parse_filename!(\"devices_00010101_20250101.csv\")\n {\"imported_devices\", ~D[0001-01-01], ~D[2025-01-01]}","ref":"Plausible.Imported.CSVImporter.html#parse_filename!/1"},{"type":"function","title":"Plausible.Imported.CSVImporter.valid_filename?/1","doc":"Checks if the provided filename conforms to the expected format.\n\nExamples:\n\n iex> valid_filename?(\"my_data.csv\")\n false\n\n iex> valid_filename?(\"imported_devices_00010101_20250101.csv\")\n true\n\n iex> valid_filename?(\"devices_00010101_20250101.csv\")\n true","ref":"Plausible.Imported.CSVImporter.html#valid_filename?/1"},{"type":"module","title":"Plausible.Imported.GoogleAnalytics4","doc":"Import implementation for Google Analytics 4.","ref":"Plausible.Imported.GoogleAnalytics4.html"},{"type":"function","title":"Plausible.Imported.GoogleAnalytics4.from_report/4","doc":"","ref":"Plausible.Imported.GoogleAnalytics4.html#from_report/4"},{"type":"function","title":"Plausible.Imported.GoogleAnalytics4.import_data/2","doc":"Imports stats from a Google Analytics 4 property to a Plausible site.\n\nThis function fetches Google Analytics 4 reports which are then passed in batches\nto Clickhouse by the `Plausible.Imported.Buffer` process.","ref":"Plausible.Imported.GoogleAnalytics4.html#import_data/2"},{"type":"function","title":"Plausible.Imported.GoogleAnalytics4.new_import/3","doc":"","ref":"Plausible.Imported.GoogleAnalytics4.html#new_import/3"},{"type":"module","title":"Plausible.Imported.ImportSources","doc":"Definitions of import sources.","ref":"Plausible.Imported.ImportSources.html"},{"type":"function","title":"Plausible.Imported.ImportSources.by_name/1","doc":"","ref":"Plausible.Imported.ImportSources.html#by_name/1"},{"type":"function","title":"Plausible.Imported.ImportSources.names/0","doc":"","ref":"Plausible.Imported.ImportSources.html#names/0"},{"type":"behaviour","title":"Plausible.Imported.Importer","doc":"Behaviour that should be implemented for each import source.\n\nAll imports are executed as background jobs run via `Plausible.Workers.ImportAnalytics`\nOban worker. Each import source must define a module conforming `Importer` behaviour.\n\nThe callbacks that need to be implemented:\n\n* `name/0` - Returns import source name as an atom. Example: `:universal_analytics`.\n* `label/0` - Descriptive, display friendly name of the source.\n Example: \"Google Analytics\".\n* `email_template/0` - Name of the email template to use for notifications in\n `PlausibleWeb.Email` (`import_success` and `import_failure`). The template\n should have content customized for a particular source.\n* `parse_args/1` - Receives Oban job arguments coming from `new_import/3`. Whatever\n options were passed to `new_import/3` will be present in the input map with string\n keys and values serialized to primitives. If, for instance `start_date: ~D[2024-01-03]`\n is passed as an option, `parse_args/1` receives `%{..., \"start_date\" => \"2024-01-03\"}`.\n The expectation is parsing the map values producing a keyword list of options to\n pass to `import_data/2`.\n* `import_data/2` - Receives site import struct and options produced by `parse_args/1`.\n This is where all the import processing is done. The way the import is implemented\n is entirely arbitrary except the requirement that the process as a whole must\n by synchronous. The callback is expected to return either `:ok` or `{:ok, %{...}}`\n on successful import or `{:error, ...}` on failure. The map in success tuple is\n used for updating site import struct and is passed to `on_success/2` callback.\n Please note that error tuple should be only returned on errors that can't be\n recovered from. For transient errors, the import should throw an exception or\n simply crash. The error tuple has an alternative `{error, reason, opts}` form,\n where `opts` allow to skip purging imported data so far via `skip_purge?` flag\n and skip marking the import as failed and notifying the user via `skip_mark_failed?`\n flag. Both flags are booleans.\n* `before_start/2` - Optional callback run right before scheduling import job. It's\n expected to either return `{:ok, site_import}` for the import to proceed\n or `{:error, ...}` tuple, which will be returned from `new_import/3` call.\n The `site_import` can be altered or replaced at this stage. The second argument\n are opts passed to `new_import/3`.\n* `on_success/2` - Optional callback run once site import is completed. Receives map\n returned from `import_data/2`. Expected to always return `:ok`.\n* `on_failure/1` - Optional callback run when import job fails permanently.\n\nAll sources must be added to the list in `Plausible.Imported.ImportSources`.\n\nIn order to schedule a new import job using a given source, respective importer's\n`new_import/3` function must be called. It accepts site, user who is doing the import\nand any options necessary to carry out the import.\n\nThere's an expectation that `start_date` and `end_date` are provided either as options\npassed to `new_import/3` or data in map returned from `import_data/2`. If these parameters\nare not provided, the import will eventually crash. These parameters define time range\nof imported data which is in turn used for efficient querying.\n\nLogic running inside `import_data/2` is expected to populated all `imported_*` tables\nin ClickHouse with `import_id` column set to site import's ID.\n\nManaging any configuration or authentication prior to running import is outside of\nscope of importer logic and is expected to be implemented separately.","ref":"Plausible.Imported.Importer.html"},{"type":"behaviour","title":"Running import fully synchronously - Plausible.Imported.Importer","doc":"In case it's necessary to run the whole import job fully synchronously, the\n`Plausible.Workers.ImportAnalytics` worker sends an `Oban.Notifier` message\non completion, failure or transient failure of the import.\n\nA basic usage scenario looks like this:\n\n```elixir\n{:ok, job} = Plausible.Imported.NoopImporter.new_import(\n site,\n user,\n start_date: ~D[2005-01-01],\n end_date: Date.utc_today(),\n # this option is necessary to setup the calling process as listener\n listen?: true\n)\n\nimport_id = job.args[:import_id]\n\nreceive do\n {:notification, :analytics_imports_jobs, %{\"event\" => \"complete\", \"import_id\" => ^import_id}} ->\n IO.puts(\"Job completed\")\n\n {:notification, :analytics_imports_jobs, %{\"event\" => \"transient_fail\", \"import_id\" => ^import_id}} ->\n IO.puts(\"Job failed transiently\")\n\n {:notification, :analytics_imports_jobs, %{\"event\" => \"fail\", \"import_id\" => ^import_id}} ->\n IO.puts(\"Job failed permanently\")\nafter\n 15_000 ->\n IO.puts(\"Job didn't finish in 15 seconds\")\nend\n```\n\nIn a more realistic scenario, job scheduling will be done inside a GenServer process\nlike LiveView, where notifications can be listened for via `handle_info/2`.","ref":"Plausible.Imported.Importer.html#module-running-import-fully-synchronously"},{"type":"callback","title":"Plausible.Imported.Importer.before_start/2","doc":"","ref":"Plausible.Imported.Importer.html#c:before_start/2"},{"type":"callback","title":"Plausible.Imported.Importer.email_template/0","doc":"","ref":"Plausible.Imported.Importer.html#c:email_template/0"},{"type":"callback","title":"Plausible.Imported.Importer.import_data/2","doc":"","ref":"Plausible.Imported.Importer.html#c:import_data/2"},{"type":"callback","title":"Plausible.Imported.Importer.label/0","doc":"","ref":"Plausible.Imported.Importer.html#c:label/0"},{"type":"function","title":"Plausible.Imported.Importer.listen/0","doc":"Allows to explicitly start listening for importer job notifications.\n\nListener must explicitly filter out a subset of imports that apply to the given context.","ref":"Plausible.Imported.Importer.html#listen/0"},{"type":"callback","title":"Plausible.Imported.Importer.name/0","doc":"","ref":"Plausible.Imported.Importer.html#c:name/0"},{"type":"callback","title":"Plausible.Imported.Importer.on_failure/1","doc":"","ref":"Plausible.Imported.Importer.html#c:on_failure/1"},{"type":"callback","title":"Plausible.Imported.Importer.on_success/2","doc":"","ref":"Plausible.Imported.Importer.html#c:on_success/2"},{"type":"callback","title":"Plausible.Imported.Importer.parse_args/1","doc":"","ref":"Plausible.Imported.Importer.html#c:parse_args/1"},{"type":"module","title":"Plausible.Imported.NoopImporter","doc":"Stub import implementation.","ref":"Plausible.Imported.NoopImporter.html"},{"type":"function","title":"Plausible.Imported.NoopImporter.new_import/3","doc":"","ref":"Plausible.Imported.NoopImporter.html#new_import/3"},{"type":"module","title":"Plausible.Imported.SiteImport","doc":"Site import schema.","ref":"Plausible.Imported.SiteImport.html"},{"type":"function","title":"Plausible.Imported.SiteImport.complete_changeset/2","doc":"","ref":"Plausible.Imported.SiteImport.html#complete_changeset/2"},{"type":"macro","title":"Plausible.Imported.SiteImport.completed/0","doc":"","ref":"Plausible.Imported.SiteImport.html#completed/0"},{"type":"function","title":"Plausible.Imported.SiteImport.create_changeset/3","doc":"","ref":"Plausible.Imported.SiteImport.html#create_changeset/3"},{"type":"function","title":"Plausible.Imported.SiteImport.fail_changeset/1","doc":"","ref":"Plausible.Imported.SiteImport.html#fail_changeset/1"},{"type":"macro","title":"Plausible.Imported.SiteImport.failed/0","doc":"","ref":"Plausible.Imported.SiteImport.html#failed/0"},{"type":"macro","title":"Plausible.Imported.SiteImport.importing/0","doc":"","ref":"Plausible.Imported.SiteImport.html#importing/0"},{"type":"function","title":"Plausible.Imported.SiteImport.label/1","doc":"","ref":"Plausible.Imported.SiteImport.html#label/1"},{"type":"macro","title":"Plausible.Imported.SiteImport.pending/0","doc":"","ref":"Plausible.Imported.SiteImport.html#pending/0"},{"type":"function","title":"Plausible.Imported.SiteImport.start_changeset/1","doc":"","ref":"Plausible.Imported.SiteImport.html#start_changeset/1"},{"type":"type","title":"Plausible.Imported.SiteImport.t/0","doc":"","ref":"Plausible.Imported.SiteImport.html#t:t/0"},{"type":"module","title":"Plausible.Imported.UniversalAnalytics","doc":"Import implementation for Universal Analytics.\n\nNOTE: As importing from UA is no longer supported, this module\nis only used to support rendering existing imports.","ref":"Plausible.Imported.UniversalAnalytics.html"},{"type":"function","title":"Plausible.Imported.UniversalAnalytics.new_import/3","doc":"","ref":"Plausible.Imported.UniversalAnalytics.html#new_import/3"},{"type":"module","title":"Plausible.IngestRepo","doc":"Write-centric Clickhouse access interface","ref":"Plausible.IngestRepo.html"},{"type":"function","title":"Plausible.IngestRepo.aggregate/3","doc":"","ref":"Plausible.IngestRepo.html#aggregate/3"},{"type":"function","title":"Plausible.IngestRepo.aggregate/4","doc":"","ref":"Plausible.IngestRepo.html#aggregate/4"},{"type":"function","title":"Plausible.IngestRepo.all/2","doc":"","ref":"Plausible.IngestRepo.html#all/2"},{"type":"function","title":"Plausible.IngestRepo.alter_update_all/3","doc":"Similar to `Ecto.Repo.update_all/3` but uses [`ALTER TABLE ... UPDATE`](https://clickhouse.com/docs/en/sql-reference/statements/alter/update) instead.\n\nFor more information and performance implications please see:\n\n - https://clickhouse.com/blog/handling-updates-and-deletes-in-clickhouse\n - https://clickhouse.com/docs/en/guides/developer/mutations","ref":"Plausible.IngestRepo.html#alter_update_all/3"},{"type":"function","title":"Plausible.IngestRepo.checked_out?/0","doc":"","ref":"Plausible.IngestRepo.html#checked_out?/0"},{"type":"function","title":"Plausible.IngestRepo.checkout/2","doc":"","ref":"Plausible.IngestRepo.html#checkout/2"},{"type":"function","title":"Plausible.IngestRepo.child_spec/1","doc":"","ref":"Plausible.IngestRepo.html#child_spec/1"},{"type":"function","title":"Plausible.IngestRepo.clustered_table?/1","doc":"","ref":"Plausible.IngestRepo.html#clustered_table?/1"},{"type":"function","title":"Plausible.IngestRepo.config/0","doc":"","ref":"Plausible.IngestRepo.html#config/0"},{"type":"function","title":"Plausible.IngestRepo.default_options/1","doc":"","ref":"Plausible.IngestRepo.html#default_options/1"},{"type":"function","title":"Plausible.IngestRepo.delete/2","doc":"","ref":"Plausible.IngestRepo.html#delete/2"},{"type":"function","title":"Plausible.IngestRepo.delete!/2","doc":"","ref":"Plausible.IngestRepo.html#delete!/2"},{"type":"function","title":"Plausible.IngestRepo.delete_all/2","doc":"","ref":"Plausible.IngestRepo.html#delete_all/2"},{"type":"function","title":"Plausible.IngestRepo.disconnect_all/2","doc":"A convenience function for SQL-based repositories that forces all connections in the\npool to disconnect within the given interval.\n\nSee `Ecto.Adapters.SQL.disconnect_all/3` for more information.","ref":"Plausible.IngestRepo.html#disconnect_all/2"},{"type":"function","title":"Plausible.IngestRepo.exists?/2","doc":"","ref":"Plausible.IngestRepo.html#exists?/2"},{"type":"function","title":"Plausible.IngestRepo.get/3","doc":"","ref":"Plausible.IngestRepo.html#get/3"},{"type":"function","title":"Plausible.IngestRepo.get!/3","doc":"","ref":"Plausible.IngestRepo.html#get!/3"},{"type":"function","title":"Plausible.IngestRepo.get_by/3","doc":"","ref":"Plausible.IngestRepo.html#get_by/3"},{"type":"function","title":"Plausible.IngestRepo.get_by!/3","doc":"","ref":"Plausible.IngestRepo.html#get_by!/3"},{"type":"function","title":"Plausible.IngestRepo.get_dynamic_repo/0","doc":"","ref":"Plausible.IngestRepo.html#get_dynamic_repo/0"},{"type":"function","title":"Plausible.IngestRepo.insert/2","doc":"","ref":"Plausible.IngestRepo.html#insert/2"},{"type":"function","title":"Plausible.IngestRepo.insert!/2","doc":"","ref":"Plausible.IngestRepo.html#insert!/2"},{"type":"function","title":"Plausible.IngestRepo.insert_all/3","doc":"","ref":"Plausible.IngestRepo.html#insert_all/3"},{"type":"function","title":"Plausible.IngestRepo.insert_or_update/2","doc":"","ref":"Plausible.IngestRepo.html#insert_or_update/2"},{"type":"function","title":"Plausible.IngestRepo.insert_or_update!/2","doc":"","ref":"Plausible.IngestRepo.html#insert_or_update!/2"},{"type":"function","title":"Plausible.IngestRepo.insert_stream/3","doc":"Similar to `insert_all/2` but with the following differences:\n\n - accepts rows as streams or lists\n - sends rows as a chunked request\n - doesn't autogenerate ids or does any other preprocessing\n\nExample:\n\n Repo.query!(\"create table ecto_ch_demo(a UInt64, b String) engine Null\")\n\n defmodule Demo do\n use Ecto.Schema\n\n @primary_key false\n schema \"ecto_ch_demo\" do\n field :a, Ch, type: \"UInt64\"\n field :b, :string\n end\n end\n\n rows = Stream.map(1..100_000, fn i -> %{a: i, b: to_string(i)} end)\n {100_000, nil} = Repo.insert_stream(Demo, rows)\n\n # schemaless\n {100_000, nil} = Repo.insert_stream(\"ecto_ch_demo\", rows, types: [a: Ch.Types.u64(), b: :string])","ref":"Plausible.IngestRepo.html#insert_stream/3"},{"type":"function","title":"Plausible.IngestRepo.load/2","doc":"","ref":"Plausible.IngestRepo.html#load/2"},{"type":"function","title":"Plausible.IngestRepo.one/2","doc":"","ref":"Plausible.IngestRepo.html#one/2"},{"type":"function","title":"Plausible.IngestRepo.one!/2","doc":"","ref":"Plausible.IngestRepo.html#one!/2"},{"type":"function","title":"Plausible.IngestRepo.preload/3","doc":"","ref":"Plausible.IngestRepo.html#preload/3"},{"type":"function","title":"Plausible.IngestRepo.prepare_query/3","doc":"","ref":"Plausible.IngestRepo.html#prepare_query/3"},{"type":"function","title":"Plausible.IngestRepo.put_dynamic_repo/1","doc":"","ref":"Plausible.IngestRepo.html#put_dynamic_repo/1"},{"type":"function","title":"Plausible.IngestRepo.query/3","doc":"A convenience function for SQL-based repositories that executes the given query.\n\nSee `Ecto.Adapters.SQL.query/4` for more information.","ref":"Plausible.IngestRepo.html#query/3"},{"type":"function","title":"Plausible.IngestRepo.query!/3","doc":"A convenience function for SQL-based repositories that executes the given query.\n\nSee `Ecto.Adapters.SQL.query!/4` for more information.","ref":"Plausible.IngestRepo.html#query!/3"},{"type":"function","title":"Plausible.IngestRepo.reload/2","doc":"","ref":"Plausible.IngestRepo.html#reload/2"},{"type":"function","title":"Plausible.IngestRepo.reload!/2","doc":"","ref":"Plausible.IngestRepo.html#reload!/2"},{"type":"function","title":"Plausible.IngestRepo.start_link/1","doc":"","ref":"Plausible.IngestRepo.html#start_link/1"},{"type":"function","title":"Plausible.IngestRepo.stop/1","doc":"","ref":"Plausible.IngestRepo.html#stop/1"},{"type":"function","title":"Plausible.IngestRepo.stream/2","doc":"","ref":"Plausible.IngestRepo.html#stream/2"},{"type":"function","title":"Plausible.IngestRepo.to_inline_sql/2","doc":"Similar to `to_sql/2` but inlines the parameters into the SQL query.\n\nSee `Ecto.Adapters.ClickHouse.to_inline_sql/2` for more information.","ref":"Plausible.IngestRepo.html#to_inline_sql/2"},{"type":"function","title":"Plausible.IngestRepo.to_sql/2","doc":"A convenience function for SQL-based repositories that translates the given query to SQL.\n\nSee `Ecto.Adapters.SQL.to_sql/3` for more information.","ref":"Plausible.IngestRepo.html#to_sql/2"},{"type":"function","title":"Plausible.IngestRepo.update/2","doc":"","ref":"Plausible.IngestRepo.html#update/2"},{"type":"function","title":"Plausible.IngestRepo.update!/2","doc":"","ref":"Plausible.IngestRepo.html#update!/2"},{"type":"function","title":"Plausible.IngestRepo.update_all/3","doc":"","ref":"Plausible.IngestRepo.html#update_all/3"},{"type":"module","title":"Plausible.Ingestion.Counters","doc":"This is instrumentation necessary for keeping track of per-domain\ninternal metrics. Due to metric labels cardinality (domain x metric_name),\nthese statistics are not suitable for prometheus/grafana exposure,\nhence an internal storage is used.\n\nThe module installs `Counters.TelemetryHandler` and periodically\nflushes the internal counter aggregates via `Counters.Buffer` interface.\n\nThe underlying database schema is running `SummingMergeTree` engine.\nTo take advantage of automatic roll-ups it provides, upon dispatching the\nbuffered records to Clickhouse this module transforms each `event_timebucket`\naggregate into a 1-minute resolution.\n\nClickhouse connection is set to insert counters asynchronously every time\na pool checkout is made. Those properties are reverted once the insert is done\n(or naturally, if the connection crashes).","ref":"Plausible.Ingestion.Counters.html"},{"type":"function","title":"Plausible.Ingestion.Counters.child_spec/1","doc":"","ref":"Plausible.Ingestion.Counters.html#child_spec/1"},{"type":"function","title":"Plausible.Ingestion.Counters.enabled?/0","doc":"","ref":"Plausible.Ingestion.Counters.html#enabled?/0"},{"type":"function","title":"Plausible.Ingestion.Counters.stop/1","doc":"","ref":"Plausible.Ingestion.Counters.html#stop/1"},{"type":"module","title":"Plausible.Ingestion.Counters.Buffer","doc":"A buffer aggregating counters for internal metrics, within 10 seconds time buckets.\n\nSee `Plausible.Ingestion.Counters` for integration.\n\nFlushing is by default possible only once the 10s bucket is complete\n(its window has moved). This is to avoid race conditions \nwhen clearing up the buffer on dequeue - because there is no atomic \"get and delete\",\nand items are buffered concurrently, there is a gap between get and delete\nin which items written may disappear otherwise.\n\n`aggregate_bucket_fn` and `flush_boundary_fn` control that semantics and\nare configurable only for test purposes.","ref":"Plausible.Ingestion.Counters.Buffer.html"},{"type":"function","title":"Plausible.Ingestion.Counters.Buffer.aggregate/4","doc":"","ref":"Plausible.Ingestion.Counters.Buffer.html#aggregate/4"},{"type":"function","title":"Plausible.Ingestion.Counters.Buffer.bucket_10s/1","doc":"","ref":"Plausible.Ingestion.Counters.Buffer.html#bucket_10s/1"},{"type":"function","title":"Plausible.Ingestion.Counters.Buffer.flush/2","doc":"","ref":"Plausible.Ingestion.Counters.Buffer.html#flush/2"},{"type":"function","title":"Plausible.Ingestion.Counters.Buffer.new/2","doc":"","ref":"Plausible.Ingestion.Counters.Buffer.html#new/2"},{"type":"function","title":"Plausible.Ingestion.Counters.Buffer.previous_10s/1","doc":"","ref":"Plausible.Ingestion.Counters.Buffer.html#previous_10s/1"},{"type":"type","title":"Plausible.Ingestion.Counters.Buffer.bucket_fn_opt/0","doc":"","ref":"Plausible.Ingestion.Counters.Buffer.html#t:bucket_fn_opt/0"},{"type":"type","title":"Plausible.Ingestion.Counters.Buffer.t/0","doc":"","ref":"Plausible.Ingestion.Counters.Buffer.html#t:t/0"},{"type":"type","title":"Plausible.Ingestion.Counters.Buffer.unix_timestamp/0","doc":"","ref":"Plausible.Ingestion.Counters.Buffer.html#t:unix_timestamp/0"},{"type":"module","title":"Plausible.Ingestion.Counters.Record","doc":"Clickhouse schema for storing ingest counter metrics","ref":"Plausible.Ingestion.Counters.Record.html"},{"type":"type","title":"Plausible.Ingestion.Counters.Record.t/0","doc":"","ref":"Plausible.Ingestion.Counters.Record.html#t:t/0"},{"type":"module","title":"Plausible.Ingestion.Counters.TelemetryHandler","doc":"Subscribes to telemetry events emitted by `Plausible.Ingestion.Event`.\nEvery time a request derived event is either dispatched to clickhouse or dropped,\na telemetry event is emitted respectively. That event is captured here,\nits metadata is extracted and sent for internal stats aggregation via\n`Counters.Buffer` interface.","ref":"Plausible.Ingestion.Counters.TelemetryHandler.html"},{"type":"function","title":"Plausible.Ingestion.Counters.TelemetryHandler.handle_event/4","doc":"","ref":"Plausible.Ingestion.Counters.TelemetryHandler.html#handle_event/4"},{"type":"function","title":"Plausible.Ingestion.Counters.TelemetryHandler.install/1","doc":"","ref":"Plausible.Ingestion.Counters.TelemetryHandler.html#install/1"},{"type":"module","title":"Plausible.Ingestion.Event","doc":"This module exposes the `build_and_buffer/1` function capable of\nturning %Plausible.Ingestion.Request{} into a series of events that in turn\nare uniformly either buffered in batches (to Clickhouse) or dropped\n(e.g. due to spam blocklist) from the processing pipeline.","ref":"Plausible.Ingestion.Event.html"},{"type":"function","title":"Plausible.Ingestion.Event.build_and_buffer/1","doc":"","ref":"Plausible.Ingestion.Event.html#build_and_buffer/1"},{"type":"function","title":"Plausible.Ingestion.Event.emit_telemetry_buffered/1","doc":"","ref":"Plausible.Ingestion.Event.html#emit_telemetry_buffered/1"},{"type":"function","title":"Plausible.Ingestion.Event.emit_telemetry_dropped/2","doc":"","ref":"Plausible.Ingestion.Event.html#emit_telemetry_dropped/2"},{"type":"function","title":"Plausible.Ingestion.Event.telemetry_event_buffered/0","doc":"","ref":"Plausible.Ingestion.Event.html#telemetry_event_buffered/0"},{"type":"function","title":"Plausible.Ingestion.Event.telemetry_event_dropped/0","doc":"","ref":"Plausible.Ingestion.Event.html#telemetry_event_dropped/0"},{"type":"function","title":"Plausible.Ingestion.Event.telemetry_pipeline_step_duration/0","doc":"","ref":"Plausible.Ingestion.Event.html#telemetry_pipeline_step_duration/0"},{"type":"type","title":"Plausible.Ingestion.Event.drop_reason/0","doc":"","ref":"Plausible.Ingestion.Event.html#t:drop_reason/0"},{"type":"type","title":"Plausible.Ingestion.Event.t/0","doc":"","ref":"Plausible.Ingestion.Event.html#t:t/0"},{"type":"module","title":"Plausible.Ingestion.Event.Revenue","doc":"Revenue specific functions for the ingestion scope","ref":"Plausible.Ingestion.Event.Revenue.html"},{"type":"function","title":"Plausible.Ingestion.Event.Revenue.get_revenue_attrs/1","doc":"","ref":"Plausible.Ingestion.Event.Revenue.html#get_revenue_attrs/1"},{"type":"module","title":"Plausible.Ingestion.Request","doc":"The %Plausible.Ingestion.Request{} struct stores all needed fields\nto create an event downstream. Pre-eliminary validation is made\nto detect user errors early.","ref":"Plausible.Ingestion.Request.html"},{"type":"function","title":"Plausible.Ingestion.Request.build/2","doc":"Builds and initially validates %Plausible.Ingestion.Request{} struct from %Plug.Conn{}.","ref":"Plausible.Ingestion.Request.html#build/2"},{"type":"function","title":"Plausible.Ingestion.Request.sanitize_hostname/1","doc":"Removes the \"www\" part of a hostname.","ref":"Plausible.Ingestion.Request.html#sanitize_hostname/1"},{"type":"type","title":"Plausible.Ingestion.Request.t/0","doc":"","ref":"Plausible.Ingestion.Request.html#t:t/0"},{"type":"module","title":"Plausible.Ingestion.Request.Revenue","doc":"Revenue specific functions for the ingestion scope","ref":"Plausible.Ingestion.Request.Revenue.html"},{"type":"function","title":"Plausible.Ingestion.Request.Revenue.put_revenue_source/2","doc":"","ref":"Plausible.Ingestion.Request.Revenue.html#put_revenue_source/2"},{"type":"module","title":"Plausible.License","doc":"This module ensures that you cannot run Plausible Analytics Enterprise Edition without a valid license key.\n The software contained within the ee/ and assets/js/dashboard/ee directories are Copyright © Plausible Insights OÜ.\n We have made this code available solely for informational and transparency purposes. No rights are granted to use,\n distribute, or exploit this software in any form.\n\n Any attempt to disable or modify the behavior of this module will be considered a violation of copyright.\n If you wish to use the Plausible Analytics Enterprise Edition for your own requirements, please contact us\n at hello@plausible.io to discuss obtaining a license.","ref":"Plausible.License.html"},{"type":"function","title":"Plausible.License.ensure_valid_license/0","doc":"","ref":"Plausible.License.html#ensure_valid_license/0"},{"type":"module","title":"Plausible.LiveViewTest","doc":"Temporary fix for `Phoenix.LiveViewTest.render_component/2` failing CI with warnings.\n\nThis module can be removed once Plausible switches to `phoenix_live_view ~> 1.0.0`","ref":"Plausible.LiveViewTest.html"},{"type":"macro","title":"Plausible.LiveViewTest.render_component/3","doc":"Same as `Phoenix.LiveViewTest.render_component/2` but with backported fixes from\nhttps://github.com/phoenixframework/phoenix_live_view/commit/489e8de024e03976e9ae38138eec517fbd456d27","ref":"Plausible.LiveViewTest.html#render_component/3"},{"type":"module","title":"Plausible.Mailer","doc":"","ref":"Plausible.Mailer.html"},{"type":"function","title":"Plausible.Mailer.deliver/1","doc":"","ref":"Plausible.Mailer.html#deliver/1"},{"type":"function","title":"Plausible.Mailer.deliver_later/2","doc":"","ref":"Plausible.Mailer.html#deliver_later/2"},{"type":"function","title":"Plausible.Mailer.deliver_later!/2","doc":"","ref":"Plausible.Mailer.html#deliver_later!/2"},{"type":"function","title":"Plausible.Mailer.deliver_now/2","doc":"","ref":"Plausible.Mailer.html#deliver_now/2"},{"type":"function","title":"Plausible.Mailer.deliver_now!/2","doc":"","ref":"Plausible.Mailer.html#deliver_now!/2"},{"type":"function","title":"Plausible.Mailer.send/1","doc":"","ref":"Plausible.Mailer.html#send/1"},{"type":"type","title":"Plausible.Mailer.result/0","doc":"","ref":"Plausible.Mailer.html#t:result/0"},{"type":"module","title":"Plausible.MigrationUtils","doc":"Base module for to use in Clickhouse migrations","ref":"Plausible.MigrationUtils.html"},{"type":"function","title":"Plausible.MigrationUtils.dictionary_connection_params/0","doc":"","ref":"Plausible.MigrationUtils.html#dictionary_connection_params/0"},{"type":"function","title":"Plausible.MigrationUtils.on_cluster_statement/1","doc":"","ref":"Plausible.MigrationUtils.html#on_cluster_statement/1"},{"type":"module","title":"Plausible.OpenTelemetry.Sampler","doc":"[Custom OpenTelemetry sampler](https://hexdocs.pm/opentelemetry/readme.html#samplers)\nimplementation that ignores particular traces to reduce noise. Ingestion\nHTTP requests and queries to Oban tables are ignored, for example.\n\nFor non-ignored traces, implements trace ID ratio-based sampling following the method\nfrom [built-in sampler](https://github.com/open-telemetry/opentelemetry-erlang/blob/main/apps/opentelemetry/src/otel_sampler_trace_id_ratio_based.erl).","ref":"Plausible.OpenTelemetry.Sampler.html"},{"type":"module","title":"Plausible.PaddleApi.Mock","doc":"","ref":"Plausible.PaddleApi.Mock.html"},{"type":"function","title":"Plausible.PaddleApi.Mock.fetch_prices/2","doc":"","ref":"Plausible.PaddleApi.Mock.html#fetch_prices/2"},{"type":"function","title":"Plausible.PaddleApi.Mock.get_invoices/1","doc":"","ref":"Plausible.PaddleApi.Mock.html#get_invoices/1"},{"type":"function","title":"Plausible.PaddleApi.Mock.get_subscription/1","doc":"","ref":"Plausible.PaddleApi.Mock.html#get_subscription/1"},{"type":"function","title":"Plausible.PaddleApi.Mock.update_subscription/2","doc":"","ref":"Plausible.PaddleApi.Mock.html#update_subscription/2"},{"type":"function","title":"Plausible.PaddleApi.Mock.update_subscription_preview/2","doc":"","ref":"Plausible.PaddleApi.Mock.html#update_subscription_preview/2"},{"type":"module","title":"Plausible.Pagination","doc":"Cursor-based pagination.","ref":"Plausible.Pagination.html"},{"type":"function","title":"Plausible.Pagination.paginate/4","doc":"","ref":"Plausible.Pagination.html#paginate/4"},{"type":"module","title":"Plausible.Plugins.API.Capabilities","doc":"Context module for querying API capabilities","ref":"Plausible.Plugins.API.Capabilities.html"},{"type":"function","title":"Plausible.Plugins.API.Capabilities.get/1","doc":"","ref":"Plausible.Plugins.API.Capabilities.html#get/1"},{"type":"module","title":"Plausible.Plugins.API.CustomProps","doc":"Plugins API context module for Custom Props.\nAll high level Custom Props operations should be implemented here.","ref":"Plausible.Plugins.API.CustomProps.html"},{"type":"function","title":"Plausible.Plugins.API.CustomProps.disable/2","doc":"","ref":"Plausible.Plugins.API.CustomProps.html#disable/2"},{"type":"function","title":"Plausible.Plugins.API.CustomProps.enable/2","doc":"","ref":"Plausible.Plugins.API.CustomProps.html#enable/2"},{"type":"module","title":"Plausible.Plugins.API.Funnels","doc":"Plugins API context module for Funnels.\nAll high level Funnel operations should be implemented here.","ref":"Plausible.Plugins.API.Funnels.html"},{"type":"function","title":"Plausible.Plugins.API.Funnels.create/2","doc":"","ref":"Plausible.Plugins.API.Funnels.html#create/2"},{"type":"function","title":"Plausible.Plugins.API.Funnels.get/2","doc":"","ref":"Plausible.Plugins.API.Funnels.html#get/2"},{"type":"function","title":"Plausible.Plugins.API.Funnels.get_funnels/2","doc":"","ref":"Plausible.Plugins.API.Funnels.html#get_funnels/2"},{"type":"type","title":"Plausible.Plugins.API.Funnels.create_request/0","doc":"","ref":"Plausible.Plugins.API.Funnels.html#t:create_request/0"},{"type":"module","title":"Plausible.Plugins.API.Goals","doc":"Plugins API context module for Goals.\nAll high level Goal operations should be implemented here.","ref":"Plausible.Plugins.API.Goals.html"},{"type":"function","title":"Plausible.Plugins.API.Goals.create/2","doc":"","ref":"Plausible.Plugins.API.Goals.html#create/2"},{"type":"function","title":"Plausible.Plugins.API.Goals.delete/2","doc":"","ref":"Plausible.Plugins.API.Goals.html#delete/2"},{"type":"function","title":"Plausible.Plugins.API.Goals.get/2","doc":"","ref":"Plausible.Plugins.API.Goals.html#get/2"},{"type":"function","title":"Plausible.Plugins.API.Goals.get_goals/2","doc":"","ref":"Plausible.Plugins.API.Goals.html#get_goals/2"},{"type":"type","title":"Plausible.Plugins.API.Goals.create_request/0","doc":"","ref":"Plausible.Plugins.API.Goals.html#t:create_request/0"},{"type":"module","title":"Plausible.Plugins.API.SharedLinks","doc":"Plugins API context module for Shared Links.\nAll high level Shared Links operations should be implemented here.","ref":"Plausible.Plugins.API.SharedLinks.html"},{"type":"function","title":"Plausible.Plugins.API.SharedLinks.get/2","doc":"","ref":"Plausible.Plugins.API.SharedLinks.html#get/2"},{"type":"function","title":"Plausible.Plugins.API.SharedLinks.get_or_create/3","doc":"","ref":"Plausible.Plugins.API.SharedLinks.html#get_or_create/3"},{"type":"function","title":"Plausible.Plugins.API.SharedLinks.get_shared_links/2","doc":"","ref":"Plausible.Plugins.API.SharedLinks.html#get_shared_links/2"},{"type":"module","title":"Plausible.Plugins.API.Token","doc":"Ecto schema for Plugins API Tokens.\nTokens are stored hashed and require a description.\n\nTokens are considered secret, although the Plugins API\nby nature will expose very little, if any, destructive/insecure operations.\n\nThe raw token version is meant to be presented to the user upon creation.\nIt is prefixed with a plain text identifier allowing source scanning\nfor leaked secrets.","ref":"Plausible.Plugins.API.Token.html"},{"type":"function","title":"Plausible.Plugins.API.Token.generate/1","doc":"","ref":"Plausible.Plugins.API.Token.html#generate/1"},{"type":"function","title":"Plausible.Plugins.API.Token.hash/1","doc":"","ref":"Plausible.Plugins.API.Token.html#hash/1"},{"type":"function","title":"Plausible.Plugins.API.Token.insert_changeset/3","doc":"","ref":"Plausible.Plugins.API.Token.html#insert_changeset/3"},{"type":"function","title":"Plausible.Plugins.API.Token.last_used_humanize/1","doc":"","ref":"Plausible.Plugins.API.Token.html#last_used_humanize/1"},{"type":"function","title":"Plausible.Plugins.API.Token.prefix/0","doc":"Raw tokens are prefixed so that tools like\nhttps://docs.github.com/en/code-security/secret-scanning/about-secret-scanning\ncan scan repositories for accidental secret commits.","ref":"Plausible.Plugins.API.Token.html#prefix/0"},{"type":"type","title":"Plausible.Plugins.API.Token.t/0","doc":"","ref":"Plausible.Plugins.API.Token.html#t:t/0"},{"type":"module","title":"Plausible.Plugins.API.Tokens","doc":"Context module for Plugins API Tokens.\nExposes high-level operation for token-based authentication flows.","ref":"Plausible.Plugins.API.Tokens.html"},{"type":"function","title":"Plausible.Plugins.API.Tokens.any?/1","doc":"","ref":"Plausible.Plugins.API.Tokens.html#any?/1"},{"type":"function","title":"Plausible.Plugins.API.Tokens.create/3","doc":"","ref":"Plausible.Plugins.API.Tokens.html#create/3"},{"type":"function","title":"Plausible.Plugins.API.Tokens.delete/2","doc":"","ref":"Plausible.Plugins.API.Tokens.html#delete/2"},{"type":"function","title":"Plausible.Plugins.API.Tokens.find/1","doc":"","ref":"Plausible.Plugins.API.Tokens.html#find/1"},{"type":"function","title":"Plausible.Plugins.API.Tokens.list/1","doc":"","ref":"Plausible.Plugins.API.Tokens.html#list/1"},{"type":"function","title":"Plausible.Plugins.API.Tokens.update_last_seen/2","doc":"","ref":"Plausible.Plugins.API.Tokens.html#update_last_seen/2"},{"type":"module","title":"Plausible.PromEx","doc":"","ref":"Plausible.PromEx.html"},{"type":"function","title":"Plausible.PromEx.child_spec/1","doc":"Returns a specification to start this module under a supervisor.\n\nSee `Supervisor`.","ref":"Plausible.PromEx.html#child_spec/1"},{"type":"module","title":"Plausible.PromEx.Plugins.PlausibleMetrics","doc":"Custom PromEx plugin for instrumenting code within Plausible app.","ref":"Plausible.PromEx.Plugins.PlausibleMetrics.html"},{"type":"function","title":"Plausible.PromEx.Plugins.PlausibleMetrics.execute_cache_metrics/0","doc":"Fire telemetry events for various caches","ref":"Plausible.PromEx.Plugins.PlausibleMetrics.html#execute_cache_metrics/0"},{"type":"function","title":"Plausible.PromEx.Plugins.PlausibleMetrics.execute_write_buffer_metrics/0","doc":"Add telemetry events for Session and Event write buffers","ref":"Plausible.PromEx.Plugins.PlausibleMetrics.html#execute_write_buffer_metrics/0"},{"type":"function","title":"Plausible.PromEx.Plugins.PlausibleMetrics.measure_duration/3","doc":"","ref":"Plausible.PromEx.Plugins.PlausibleMetrics.html#measure_duration/3"},{"type":"module","title":"Plausible.Props","doc":"Context module for handling custom event props.","ref":"Plausible.Props.html"},{"type":"function","title":"Plausible.Props.allow/2","doc":"Allows a prop key or a list of props keys to be included in ClickHouse\nqueries. Allowing prop keys does not affect ingestion, as we don't want any\ndata to be dropped or lost.","ref":"Plausible.Props.html#allow/2"},{"type":"function","title":"Plausible.Props.allow_changeset/2","doc":"","ref":"Plausible.Props.html#allow_changeset/2"},{"type":"function","title":"Plausible.Props.allow_existing_props/1","doc":"Allows the 300 most frequent props keys for a specific site over\nthe past 6 months.","ref":"Plausible.Props.html#allow_existing_props/1"},{"type":"function","title":"Plausible.Props.allowed_for/2","doc":"Returns the custom props allowed in queries for the given site. There are\ntwo factors deciding whether a custom property is allowed for a site.\n\n#","ref":"Plausible.Props.html#allowed_for/2"},{"type":"function","title":"1. Subscription plan including the props feature. - Plausible.Props.allowed_for/2","doc":"Internally used keys (i.e. `[\"url\", \"path\", \"search_query\"]`) are always allowed,\neven for plans that don't include props. For any other props, access to the\nCustom Properties feature is required.\n\n#","ref":"Plausible.Props.html#allowed_for/2-1-subscription-plan-including-the-props-feature"},{"type":"function","title":"2. The site having an `allowed_event_props` list configured. - Plausible.Props.allowed_for/2","doc":"For customers with a configured `allowed_event_props` list, this function\nreturns that list (+ internally used keys). That helps to filter out garbage\nprops which people might not want to see in their dashboards.\n\nWith the `bypass_setup?` boolean option you can override the requirement of\nthe site having set up props in the `allowed_event_props` list. For example,\nthis is currently used for fetching allowed properties in Stats API queries\nin order to ensure the props feature access.\n\nSince `allowed_event_props` was added after the props feature had already\nbeen used for a while, there are sites with `allowed_event_props = nil`. For\nthose sites, all custom properties that exist in the database are allowed to\nbe queried.","ref":"Plausible.Props.html#allowed_for/2-2-the-site-having-an-allowed_event_props-list-configured"},{"type":"function","title":"Plausible.Props.configured?/1","doc":"Returns whether the site has configured custom props or not.","ref":"Plausible.Props.html#configured?/1"},{"type":"function","title":"Plausible.Props.disallow/2","doc":"Removes previously allowed prop key(s) from the allow list. This means this\nprop key won't be included in ClickHouse queries. This doesn't drop any\nClickHouse data, nor affects ingestion.","ref":"Plausible.Props.html#disallow/2"},{"type":"function","title":"Plausible.Props.ensure_prop_key_accessible/2","doc":"","ref":"Plausible.Props.html#ensure_prop_key_accessible/2"},{"type":"function","title":"Plausible.Props.internal_keys/0","doc":"Lists prop keys used internally.\n\nThese props should be allowed by default, and should not be displayed in the\nprops settings page. For example, `url` is a special prop key used for file\ndownloads and outbound links. It doesn't make sense to remove this prop key\nfrom the allow list, or to suggest users to add this prop key.","ref":"Plausible.Props.html#internal_keys/0"},{"type":"function","title":"Plausible.Props.max_prop_key_length/0","doc":"","ref":"Plausible.Props.html#max_prop_key_length/0"},{"type":"function","title":"Plausible.Props.max_prop_value_length/0","doc":"","ref":"Plausible.Props.html#max_prop_value_length/0"},{"type":"function","title":"Plausible.Props.max_props/0","doc":"","ref":"Plausible.Props.html#max_props/0"},{"type":"function","title":"Plausible.Props.suggest_keys_to_allow/2","doc":"Queries the events table to fetch the 300 most frequent prop keys\nfor a specific site over the past 6 months, excluding keys that are already\nallowed.","ref":"Plausible.Props.html#suggest_keys_to_allow/2"},{"type":"type","title":"Plausible.Props.prop/0","doc":"","ref":"Plausible.Props.html#t:prop/0"},{"type":"module","title":"Plausible.Purge","doc":"Deletes data from a site.\n\nStats are stored on Clickhouse, and unlike other databases data deletion is\ndone asynchronously.\n\nAll import tables have MergeTree's deduplication mechanism _disabled_ by setting\n`replicated_deduplication_window` from default 100 to 0. When enabled, every insert\ninto a given table is compared against hashes of 100 previous inserts (as complete\nparts, not concrete rows) and ignored when match is found. The prupose of that\nmechanism is making inserts of exact same batches idempotent when retrying them\nshortly after - for instance due to timeout, when the client can't easily tell if\nprevious insert succeeded or not. Deduplication, however, only considers inserts,\nnot mutations. Deletions do not affect stored hashes, so further inserts of parts\nthat were deleted will still be treated as duplicates. That's why this feature\nis disabled for import tables.\n\nAlthough deletions are asynchronous, the parts to delete are \"remembered\", so there's\nno risk of overlapping deletion causing problems with import following right after it.\n\nIMPORTANT: Deletion requires revision if/when import tables get moved to sharded CH\ncluster setup. Mutation queries, which have to be run with `ON CLUSTER` in such setup,\ndispatch independent queries across shards and those queries can start at different\ntimes. This in turn means risk of deletions corrupting data of follow-up inserts\nin some edge cases. Ideally, imported entries should be unique for a given import\n- an extra `import_id` column can be introduced, holding identifier. Last processed\nimport identifier should be stored with other site data and should be used for scoping\nimported stats queries. No longer used imports can then be safely removed fully\nasynchronously.\n\n- [Clickhouse `ALTER TABLE ... DELETE` Statement](https://clickhouse.com/docs/en/sql-reference/statements/alter/delete)\n- [Synchronicity of `ALTER` Queries](https://clickhouse.com/docs/en/sql-reference/statements/alter/#synchronicity-of-alter-queries)","ref":"Plausible.Purge.html"},{"type":"function","title":"Plausible.Purge.delete_imported_stats!/1","doc":"Deletes imported stats from and clears the `stats_start_date` field.\n\nThe `stats_start_date` is expected to get repopulated the next time\n`Plausible.Sites.stats_start_date/1` is called.\n\nIf the input argument is a site, all imported stats are deleted. If it's a site import,\nonly imported stats for that import are deleted.","ref":"Plausible.Purge.html#delete_imported_stats!/1"},{"type":"function","title":"Plausible.Purge.delete_imported_stats!/2","doc":"","ref":"Plausible.Purge.html#delete_imported_stats!/2"},{"type":"function","title":"Plausible.Purge.delete_native_stats!/1","doc":"Move stats pointers so that no historical stats are available.","ref":"Plausible.Purge.html#delete_native_stats!/1"},{"type":"function","title":"Plausible.Purge.reset!/1","doc":"","ref":"Plausible.Purge.html#reset!/1"},{"type":"module","title":"Plausible.RateLimit","doc":"Thin wrapper around `:ets.update_counter/4` and a\nclean-up process to act as a rate limiter.","ref":"Plausible.RateLimit.html"},{"type":"function","title":"Plausible.RateLimit.check_rate/5","doc":"Checks the rate-limit for a key.","ref":"Plausible.RateLimit.html#check_rate/5"},{"type":"function","title":"Plausible.RateLimit.child_spec/1","doc":"Returns a specification to start this module under a supervisor.\n\nSee `Supervisor`.","ref":"Plausible.RateLimit.html#child_spec/1"},{"type":"function","title":"Plausible.RateLimit.start_link/1","doc":"Starts the process that creates and cleans the ETS table.\n\nAccepts the following options:\n - `GenServer.options()`\n - `:table` for the ETS table name, defaults to `Elixir.Plausible.RateLimit`\n - `:clean_period` for how often to perform garbage collection","ref":"Plausible.RateLimit.html#start_link/1"},{"type":"module","title":"Plausible.Release","doc":"","ref":"Plausible.Release.html"},{"type":"function","title":"Plausible.Release.configure_ref_inspector/0","doc":"","ref":"Plausible.Release.html#configure_ref_inspector/0"},{"type":"function","title":"Plausible.Release.configure_ua_inspector/0","doc":"","ref":"Plausible.Release.html#configure_ua_inspector/0"},{"type":"function","title":"Plausible.Release.createdb/0","doc":"","ref":"Plausible.Release.html#createdb/0"},{"type":"function","title":"Plausible.Release.dump_plans/0","doc":"","ref":"Plausible.Release.html#dump_plans/0"},{"type":"function","title":"Plausible.Release.migrate/0","doc":"","ref":"Plausible.Release.html#migrate/0"},{"type":"function","title":"Plausible.Release.pending_migrations/0","doc":"","ref":"Plausible.Release.html#pending_migrations/0"},{"type":"function","title":"Plausible.Release.rollback/0","doc":"","ref":"Plausible.Release.html#rollback/0"},{"type":"function","title":"Plausible.Release.seed/0","doc":"","ref":"Plausible.Release.html#seed/0"},{"type":"function","title":"Plausible.Release.should_be_first_launch?/0","doc":"","ref":"Plausible.Release.html#should_be_first_launch?/0"},{"type":"module","title":"Plausible.Repo","doc":"","ref":"Plausible.Repo.html"},{"type":"function","title":"Plausible.Repo.aggregate/3","doc":"","ref":"Plausible.Repo.html#aggregate/3"},{"type":"function","title":"Plausible.Repo.aggregate/4","doc":"","ref":"Plausible.Repo.html#aggregate/4"},{"type":"function","title":"Plausible.Repo.all/2","doc":"","ref":"Plausible.Repo.html#all/2"},{"type":"function","title":"Plausible.Repo.checked_out?/0","doc":"","ref":"Plausible.Repo.html#checked_out?/0"},{"type":"function","title":"Plausible.Repo.checkout/2","doc":"","ref":"Plausible.Repo.html#checkout/2"},{"type":"function","title":"Plausible.Repo.child_spec/1","doc":"","ref":"Plausible.Repo.html#child_spec/1"},{"type":"function","title":"Plausible.Repo.config/0","doc":"","ref":"Plausible.Repo.html#config/0"},{"type":"function","title":"Plausible.Repo.default_options/1","doc":"","ref":"Plausible.Repo.html#default_options/1"},{"type":"function","title":"Plausible.Repo.delete/2","doc":"","ref":"Plausible.Repo.html#delete/2"},{"type":"function","title":"Plausible.Repo.delete!/2","doc":"","ref":"Plausible.Repo.html#delete!/2"},{"type":"function","title":"Plausible.Repo.delete_all/2","doc":"","ref":"Plausible.Repo.html#delete_all/2"},{"type":"function","title":"Plausible.Repo.disconnect_all/2","doc":"A convenience function for SQL-based repositories that forces all connections in the\npool to disconnect within the given interval.\n\nSee `Ecto.Adapters.SQL.disconnect_all/3` for more information.","ref":"Plausible.Repo.html#disconnect_all/2"},{"type":"function","title":"Plausible.Repo.exists?/2","doc":"","ref":"Plausible.Repo.html#exists?/2"},{"type":"function","title":"Plausible.Repo.explain/3","doc":"A convenience function for SQL-based repositories that executes an EXPLAIN statement or similar\ndepending on the adapter to obtain statistics for the given query.\n\nSee `Ecto.Adapters.SQL.explain/4` for more information.","ref":"Plausible.Repo.html#explain/3"},{"type":"function","title":"Plausible.Repo.get/3","doc":"","ref":"Plausible.Repo.html#get/3"},{"type":"function","title":"Plausible.Repo.get!/3","doc":"","ref":"Plausible.Repo.html#get!/3"},{"type":"function","title":"Plausible.Repo.get_by/3","doc":"","ref":"Plausible.Repo.html#get_by/3"},{"type":"function","title":"Plausible.Repo.get_by!/3","doc":"","ref":"Plausible.Repo.html#get_by!/3"},{"type":"function","title":"Plausible.Repo.get_dynamic_repo/0","doc":"","ref":"Plausible.Repo.html#get_dynamic_repo/0"},{"type":"function","title":"Plausible.Repo.in_transaction?/0","doc":"","ref":"Plausible.Repo.html#in_transaction?/0"},{"type":"function","title":"Plausible.Repo.insert/2","doc":"","ref":"Plausible.Repo.html#insert/2"},{"type":"function","title":"Plausible.Repo.insert!/2","doc":"","ref":"Plausible.Repo.html#insert!/2"},{"type":"function","title":"Plausible.Repo.insert_all/3","doc":"","ref":"Plausible.Repo.html#insert_all/3"},{"type":"function","title":"Plausible.Repo.insert_or_update/2","doc":"","ref":"Plausible.Repo.html#insert_or_update/2"},{"type":"function","title":"Plausible.Repo.insert_or_update!/2","doc":"","ref":"Plausible.Repo.html#insert_or_update!/2"},{"type":"function","title":"Plausible.Repo.load/2","doc":"","ref":"Plausible.Repo.html#load/2"},{"type":"function","title":"Plausible.Repo.one/2","doc":"","ref":"Plausible.Repo.html#one/2"},{"type":"function","title":"Plausible.Repo.one!/2","doc":"","ref":"Plausible.Repo.html#one!/2"},{"type":"function","title":"Plausible.Repo.paginate/2","doc":"","ref":"Plausible.Repo.html#paginate/2"},{"type":"function","title":"Plausible.Repo.preload/3","doc":"","ref":"Plausible.Repo.html#preload/3"},{"type":"function","title":"Plausible.Repo.prepare_query/3","doc":"","ref":"Plausible.Repo.html#prepare_query/3"},{"type":"function","title":"Plausible.Repo.put_dynamic_repo/1","doc":"","ref":"Plausible.Repo.html#put_dynamic_repo/1"},{"type":"function","title":"Plausible.Repo.query/3","doc":"A convenience function for SQL-based repositories that executes the given query.\n\nSee `Ecto.Adapters.SQL.query/4` for more information.","ref":"Plausible.Repo.html#query/3"},{"type":"function","title":"Plausible.Repo.query!/3","doc":"A convenience function for SQL-based repositories that executes the given query.\n\nSee `Ecto.Adapters.SQL.query!/4` for more information.","ref":"Plausible.Repo.html#query!/3"},{"type":"function","title":"Plausible.Repo.query_many/3","doc":"A convenience function for SQL-based repositories that executes the given multi-result query.\n\nSee `Ecto.Adapters.SQL.query_many/4` for more information.","ref":"Plausible.Repo.html#query_many/3"},{"type":"function","title":"Plausible.Repo.query_many!/3","doc":"A convenience function for SQL-based repositories that executes the given multi-result query.\n\nSee `Ecto.Adapters.SQL.query_many!/4` for more information.","ref":"Plausible.Repo.html#query_many!/3"},{"type":"function","title":"Plausible.Repo.reload/2","doc":"","ref":"Plausible.Repo.html#reload/2"},{"type":"function","title":"Plausible.Repo.reload!/2","doc":"","ref":"Plausible.Repo.html#reload!/2"},{"type":"function","title":"Plausible.Repo.rollback/1","doc":"","ref":"Plausible.Repo.html#rollback/1"},{"type":"function","title":"Plausible.Repo.scrivener_defaults/0","doc":"","ref":"Plausible.Repo.html#scrivener_defaults/0"},{"type":"function","title":"Plausible.Repo.start_link/1","doc":"","ref":"Plausible.Repo.html#start_link/1"},{"type":"function","title":"Plausible.Repo.stop/1","doc":"","ref":"Plausible.Repo.html#stop/1"},{"type":"function","title":"Plausible.Repo.stream/2","doc":"","ref":"Plausible.Repo.html#stream/2"},{"type":"function","title":"Plausible.Repo.to_sql/2","doc":"A convenience function for SQL-based repositories that translates the given query to SQL.\n\nSee `Ecto.Adapters.SQL.to_sql/3` for more information.","ref":"Plausible.Repo.html#to_sql/2"},{"type":"function","title":"Plausible.Repo.transaction/2","doc":"","ref":"Plausible.Repo.html#transaction/2"},{"type":"function","title":"Plausible.Repo.update/2","doc":"","ref":"Plausible.Repo.html#update/2"},{"type":"function","title":"Plausible.Repo.update!/2","doc":"","ref":"Plausible.Repo.html#update!/2"},{"type":"function","title":"Plausible.Repo.update_all/3","doc":"","ref":"Plausible.Repo.html#update_all/3"},{"type":"module","title":"Plausible.RequestLogger","doc":"Custom request logger which:\n- Includes query parameters on the same line\n- Includes request duration on the same line","ref":"Plausible.RequestLogger.html"},{"type":"function","title":"Plausible.RequestLogger.log_request/4","doc":"","ref":"Plausible.RequestLogger.html#log_request/4"},{"type":"module","title":"Plausible.S3","doc":"Helper functions for S3 exports/imports.","ref":"Plausible.S3.html"},{"type":"function","title":"Plausible.S3.download_url/2","doc":"Returns a presigned URL to download the exported Zip archive from S3.\nThe URL expires in 300 seconds, which should be enough for a redirect.\n\nIn the current implementation the bucket always goes into the path component.","ref":"Plausible.S3.html#download_url/2"},{"type":"function","title":"Plausible.S3.export_upload_multipart/4","doc":"Chunks and uploads Zip archive to the provided S3 destination.\n\nIn the current implementation the bucket always goes into the path component.","ref":"Plausible.S3.html#export_upload_multipart/4"},{"type":"function","title":"Plausible.S3.exports_bucket/0","doc":"Returns the pre-configured S3 bucket for CSV exports.\n\n config :plausible, Plausible.S3,\n exports_bucket: System.fetch_env!(\"S3_EXPORTS_BUCKET\")\n\nExample:\n\n iex> exports_bucket()\n \"test-exports\"","ref":"Plausible.S3.html#exports_bucket/0"},{"type":"function","title":"Plausible.S3.import_clickhouse_credentials/0","doc":"Returns `access_key_id` and `secret_access_key` to be used by ClickHouse during imports from S3.\n\nExample:\n\n iex> import_clickhouse_credentials()\n %{access_key_id: \"minioadmin\", secret_access_key: \"minioadmin\"}","ref":"Plausible.S3.html#import_clickhouse_credentials/0"},{"type":"function","title":"Plausible.S3.import_presign_upload/2","doc":"Presigns an upload for an imported file.\n\nIn the current implementation the bucket always goes into the path component.\n\nExample:\n\n iex> upload = import_presign_upload(_site_id = 123, _filename = \"imported_browsers.csv\")\n iex> true = String.ends_with?(upload.s3_url, \"/test-imports/123/imported_browsers.csv\")\n iex> true = String.contains?(upload.presigned_url, \"/test-imports/123/imported_browsers.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&\")","ref":"Plausible.S3.html#import_presign_upload/2"},{"type":"function","title":"Plausible.S3.imports_bucket/0","doc":"Returns the pre-configured S3 bucket for CSV imports.\n\n config :plausible, Plausible.S3,\n imports_bucket: System.fetch_env!(\"S3_IMPORTS_BUCKET\")\n\nExample:\n\n iex> imports_bucket()\n \"test-imports\"","ref":"Plausible.S3.html#imports_bucket/0"},{"type":"module","title":"Plausible.Sentry.Client","doc":"","ref":"Plausible.Sentry.Client.html"},{"type":"function","title":"Plausible.Sentry.Client.post/3","doc":"","ref":"Plausible.Sentry.Client.html#post/3"},{"type":"module","title":"Plausible.SentryFilter","doc":"Sentry callbacks for filtering and grouping events","ref":"Plausible.SentryFilter.html"},{"type":"function","title":"Plausible.SentryFilter.before_send/1","doc":"","ref":"Plausible.SentryFilter.html#before_send/1"},{"type":"module","title":"Plausible.Session.CacheStore","doc":"","ref":"Plausible.Session.CacheStore.html"},{"type":"function","title":"Plausible.Session.CacheStore.on_event/4","doc":"","ref":"Plausible.Session.CacheStore.html#on_event/4"},{"type":"module","title":"Plausible.Session.Salts","doc":"","ref":"Plausible.Session.Salts.html"},{"type":"function","title":"Plausible.Session.Salts.child_spec/1","doc":"Returns a specification to start this module under a supervisor.\n\nSee `Supervisor`.","ref":"Plausible.Session.Salts.html#child_spec/1"},{"type":"function","title":"Plausible.Session.Salts.fetch/0","doc":"","ref":"Plausible.Session.Salts.html#fetch/0"},{"type":"function","title":"Plausible.Session.Salts.rotate/0","doc":"","ref":"Plausible.Session.Salts.html#rotate/0"},{"type":"function","title":"Plausible.Session.Salts.start_link/1","doc":"","ref":"Plausible.Session.Salts.html#start_link/1"},{"type":"module","title":"Plausible.Shield.CountryRule","doc":"Schema for Country Block List","ref":"Plausible.Shield.CountryRule.html"},{"type":"function","title":"Plausible.Shield.CountryRule.changeset/2","doc":"","ref":"Plausible.Shield.CountryRule.html#changeset/2"},{"type":"type","title":"Plausible.Shield.CountryRule.t/0","doc":"","ref":"Plausible.Shield.CountryRule.html#t:t/0"},{"type":"module","title":"Plausible.Shield.CountryRuleCache","doc":"Allows retrieving Country Rules by domain and country code","ref":"Plausible.Shield.CountryRuleCache.html"},{"type":"function","title":"Plausible.Shield.CountryRuleCache.child_spec/1","doc":"","ref":"Plausible.Shield.CountryRuleCache.html#child_spec/1"},{"type":"function","title":"Plausible.Shield.CountryRuleCache.get/2","doc":"","ref":"Plausible.Shield.CountryRuleCache.html#get/2"},{"type":"function","title":"Plausible.Shield.CountryRuleCache.get_or_store/3","doc":"","ref":"Plausible.Shield.CountryRuleCache.html#get_or_store/3"},{"type":"function","title":"Plausible.Shield.CountryRuleCache.hit_rate/1","doc":"","ref":"Plausible.Shield.CountryRuleCache.html#hit_rate/1"},{"type":"function","title":"Plausible.Shield.CountryRuleCache.merge_items/2","doc":"","ref":"Plausible.Shield.CountryRuleCache.html#merge_items/2"},{"type":"function","title":"Plausible.Shield.CountryRuleCache.ready?/1","doc":"Ensures the cache has non-zero size unless no items exist.\nUseful for orchestrating app startup to prevent the service\ngoing up asynchronously with an empty cache.","ref":"Plausible.Shield.CountryRuleCache.html#ready?/1"},{"type":"function","title":"Plausible.Shield.CountryRuleCache.refresh_all/1","doc":"","ref":"Plausible.Shield.CountryRuleCache.html#refresh_all/1"},{"type":"function","title":"Plausible.Shield.CountryRuleCache.refresh_updated_recently/1","doc":"","ref":"Plausible.Shield.CountryRuleCache.html#refresh_updated_recently/1"},{"type":"function","title":"Plausible.Shield.CountryRuleCache.size/1","doc":"","ref":"Plausible.Shield.CountryRuleCache.html#size/1"},{"type":"function","title":"Plausible.Shield.CountryRuleCache.telemetry_event_refresh/2","doc":"","ref":"Plausible.Shield.CountryRuleCache.html#telemetry_event_refresh/2"},{"type":"module","title":"Plausible.Shield.HostnameRule","doc":"Schema for Hostnames allow list","ref":"Plausible.Shield.HostnameRule.html"},{"type":"function","title":"Plausible.Shield.HostnameRule.changeset/2","doc":"","ref":"Plausible.Shield.HostnameRule.html#changeset/2"},{"type":"type","title":"Plausible.Shield.HostnameRule.t/0","doc":"","ref":"Plausible.Shield.HostnameRule.html#t:t/0"},{"type":"module","title":"Plausible.Shield.HostnameRuleCache","doc":"Allows retrieving Hostname Rules by domain","ref":"Plausible.Shield.HostnameRuleCache.html"},{"type":"function","title":"Plausible.Shield.HostnameRuleCache.child_spec/1","doc":"","ref":"Plausible.Shield.HostnameRuleCache.html#child_spec/1"},{"type":"function","title":"Plausible.Shield.HostnameRuleCache.get/2","doc":"","ref":"Plausible.Shield.HostnameRuleCache.html#get/2"},{"type":"function","title":"Plausible.Shield.HostnameRuleCache.get_or_store/3","doc":"","ref":"Plausible.Shield.HostnameRuleCache.html#get_or_store/3"},{"type":"function","title":"Plausible.Shield.HostnameRuleCache.hit_rate/1","doc":"","ref":"Plausible.Shield.HostnameRuleCache.html#hit_rate/1"},{"type":"function","title":"Plausible.Shield.HostnameRuleCache.merge_items/2","doc":"","ref":"Plausible.Shield.HostnameRuleCache.html#merge_items/2"},{"type":"function","title":"Plausible.Shield.HostnameRuleCache.ready?/1","doc":"Ensures the cache has non-zero size unless no items exist.\nUseful for orchestrating app startup to prevent the service\ngoing up asynchronously with an empty cache.","ref":"Plausible.Shield.HostnameRuleCache.html#ready?/1"},{"type":"function","title":"Plausible.Shield.HostnameRuleCache.refresh_all/1","doc":"","ref":"Plausible.Shield.HostnameRuleCache.html#refresh_all/1"},{"type":"function","title":"Plausible.Shield.HostnameRuleCache.refresh_updated_recently/1","doc":"","ref":"Plausible.Shield.HostnameRuleCache.html#refresh_updated_recently/1"},{"type":"function","title":"Plausible.Shield.HostnameRuleCache.size/1","doc":"","ref":"Plausible.Shield.HostnameRuleCache.html#size/1"},{"type":"function","title":"Plausible.Shield.HostnameRuleCache.telemetry_event_refresh/2","doc":"","ref":"Plausible.Shield.HostnameRuleCache.html#telemetry_event_refresh/2"},{"type":"module","title":"Plausible.Shield.IPRule","doc":"Schema for IP block list","ref":"Plausible.Shield.IPRule.html"},{"type":"function","title":"Plausible.Shield.IPRule.changeset/2","doc":"","ref":"Plausible.Shield.IPRule.html#changeset/2"},{"type":"type","title":"Plausible.Shield.IPRule.t/0","doc":"","ref":"Plausible.Shield.IPRule.html#t:t/0"},{"type":"module","title":"Plausible.Shield.IPRuleCache","doc":"Allows retrieving IP Rules by domain and IP","ref":"Plausible.Shield.IPRuleCache.html"},{"type":"function","title":"Plausible.Shield.IPRuleCache.child_spec/1","doc":"","ref":"Plausible.Shield.IPRuleCache.html#child_spec/1"},{"type":"function","title":"Plausible.Shield.IPRuleCache.get/2","doc":"","ref":"Plausible.Shield.IPRuleCache.html#get/2"},{"type":"function","title":"Plausible.Shield.IPRuleCache.get_or_store/3","doc":"","ref":"Plausible.Shield.IPRuleCache.html#get_or_store/3"},{"type":"function","title":"Plausible.Shield.IPRuleCache.hit_rate/1","doc":"","ref":"Plausible.Shield.IPRuleCache.html#hit_rate/1"},{"type":"function","title":"Plausible.Shield.IPRuleCache.merge_items/2","doc":"","ref":"Plausible.Shield.IPRuleCache.html#merge_items/2"},{"type":"function","title":"Plausible.Shield.IPRuleCache.ready?/1","doc":"Ensures the cache has non-zero size unless no items exist.\nUseful for orchestrating app startup to prevent the service\ngoing up asynchronously with an empty cache.","ref":"Plausible.Shield.IPRuleCache.html#ready?/1"},{"type":"function","title":"Plausible.Shield.IPRuleCache.refresh_all/1","doc":"","ref":"Plausible.Shield.IPRuleCache.html#refresh_all/1"},{"type":"function","title":"Plausible.Shield.IPRuleCache.refresh_updated_recently/1","doc":"","ref":"Plausible.Shield.IPRuleCache.html#refresh_updated_recently/1"},{"type":"function","title":"Plausible.Shield.IPRuleCache.size/1","doc":"","ref":"Plausible.Shield.IPRuleCache.html#size/1"},{"type":"function","title":"Plausible.Shield.IPRuleCache.telemetry_event_refresh/2","doc":"","ref":"Plausible.Shield.IPRuleCache.html#telemetry_event_refresh/2"},{"type":"module","title":"Plausible.Shield.PageRule","doc":"Schema for Pages block list","ref":"Plausible.Shield.PageRule.html"},{"type":"function","title":"Plausible.Shield.PageRule.changeset/2","doc":"","ref":"Plausible.Shield.PageRule.html#changeset/2"},{"type":"type","title":"Plausible.Shield.PageRule.t/0","doc":"","ref":"Plausible.Shield.PageRule.html#t:t/0"},{"type":"module","title":"Plausible.Shield.PageRuleCache","doc":"Allows retrieving Page Rules by domain","ref":"Plausible.Shield.PageRuleCache.html"},{"type":"function","title":"Plausible.Shield.PageRuleCache.child_spec/1","doc":"","ref":"Plausible.Shield.PageRuleCache.html#child_spec/1"},{"type":"function","title":"Plausible.Shield.PageRuleCache.get/2","doc":"","ref":"Plausible.Shield.PageRuleCache.html#get/2"},{"type":"function","title":"Plausible.Shield.PageRuleCache.get_or_store/3","doc":"","ref":"Plausible.Shield.PageRuleCache.html#get_or_store/3"},{"type":"function","title":"Plausible.Shield.PageRuleCache.hit_rate/1","doc":"","ref":"Plausible.Shield.PageRuleCache.html#hit_rate/1"},{"type":"function","title":"Plausible.Shield.PageRuleCache.merge_items/2","doc":"","ref":"Plausible.Shield.PageRuleCache.html#merge_items/2"},{"type":"function","title":"Plausible.Shield.PageRuleCache.ready?/1","doc":"Ensures the cache has non-zero size unless no items exist.\nUseful for orchestrating app startup to prevent the service\ngoing up asynchronously with an empty cache.","ref":"Plausible.Shield.PageRuleCache.html#ready?/1"},{"type":"function","title":"Plausible.Shield.PageRuleCache.refresh_all/1","doc":"","ref":"Plausible.Shield.PageRuleCache.html#refresh_all/1"},{"type":"function","title":"Plausible.Shield.PageRuleCache.refresh_updated_recently/1","doc":"","ref":"Plausible.Shield.PageRuleCache.html#refresh_updated_recently/1"},{"type":"function","title":"Plausible.Shield.PageRuleCache.size/1","doc":"","ref":"Plausible.Shield.PageRuleCache.html#size/1"},{"type":"function","title":"Plausible.Shield.PageRuleCache.telemetry_event_refresh/2","doc":"","ref":"Plausible.Shield.PageRuleCache.html#telemetry_event_refresh/2"},{"type":"module","title":"Plausible.Shields","doc":"Contextual interface for shields.","ref":"Plausible.Shields.html"},{"type":"function","title":"Plausible.Shields.add_country_rule/3","doc":"","ref":"Plausible.Shields.html#add_country_rule/3"},{"type":"function","title":"Plausible.Shields.add_hostname_rule/3","doc":"","ref":"Plausible.Shields.html#add_hostname_rule/3"},{"type":"function","title":"Plausible.Shields.add_ip_rule/3","doc":"","ref":"Plausible.Shields.html#add_ip_rule/3"},{"type":"function","title":"Plausible.Shields.add_page_rule/3","doc":"","ref":"Plausible.Shields.html#add_page_rule/3"},{"type":"function","title":"Plausible.Shields.allowed_hostname_patterns/1","doc":"","ref":"Plausible.Shields.html#allowed_hostname_patterns/1"},{"type":"function","title":"Plausible.Shields.count_country_rules/1","doc":"","ref":"Plausible.Shields.html#count_country_rules/1"},{"type":"function","title":"Plausible.Shields.count_hostname_rules/1","doc":"","ref":"Plausible.Shields.html#count_hostname_rules/1"},{"type":"function","title":"Plausible.Shields.count_ip_rules/1","doc":"","ref":"Plausible.Shields.html#count_ip_rules/1"},{"type":"function","title":"Plausible.Shields.count_page_rules/1","doc":"","ref":"Plausible.Shields.html#count_page_rules/1"},{"type":"function","title":"Plausible.Shields.country_blocked?/2","doc":"","ref":"Plausible.Shields.html#country_blocked?/2"},{"type":"function","title":"Plausible.Shields.hostname_allowed?/2","doc":"","ref":"Plausible.Shields.html#hostname_allowed?/2"},{"type":"function","title":"Plausible.Shields.ip_blocked?/2","doc":"","ref":"Plausible.Shields.html#ip_blocked?/2"},{"type":"function","title":"Plausible.Shields.list_country_rules/1","doc":"","ref":"Plausible.Shields.html#list_country_rules/1"},{"type":"function","title":"Plausible.Shields.list_hostname_rules/1","doc":"","ref":"Plausible.Shields.html#list_hostname_rules/1"},{"type":"function","title":"Plausible.Shields.list_ip_rules/1","doc":"","ref":"Plausible.Shields.html#list_ip_rules/1"},{"type":"function","title":"Plausible.Shields.list_page_rules/1","doc":"","ref":"Plausible.Shields.html#list_page_rules/1"},{"type":"function","title":"Plausible.Shields.maximum_country_rules/0","doc":"","ref":"Plausible.Shields.html#maximum_country_rules/0"},{"type":"function","title":"Plausible.Shields.maximum_hostname_rules/0","doc":"","ref":"Plausible.Shields.html#maximum_hostname_rules/0"},{"type":"function","title":"Plausible.Shields.maximum_ip_rules/0","doc":"","ref":"Plausible.Shields.html#maximum_ip_rules/0"},{"type":"function","title":"Plausible.Shields.maximum_page_rules/0","doc":"","ref":"Plausible.Shields.html#maximum_page_rules/0"},{"type":"function","title":"Plausible.Shields.page_blocked?/2","doc":"","ref":"Plausible.Shields.html#page_blocked?/2"},{"type":"function","title":"Plausible.Shields.remove_country_rule/2","doc":"","ref":"Plausible.Shields.html#remove_country_rule/2"},{"type":"function","title":"Plausible.Shields.remove_hostname_rule/2","doc":"","ref":"Plausible.Shields.html#remove_hostname_rule/2"},{"type":"function","title":"Plausible.Shields.remove_ip_rule/2","doc":"","ref":"Plausible.Shields.html#remove_ip_rule/2"},{"type":"function","title":"Plausible.Shields.remove_page_rule/2","doc":"","ref":"Plausible.Shields.html#remove_page_rule/2"},{"type":"module","title":"Plausible.Site","doc":"Site schema","ref":"Plausible.Site.html"},{"type":"function","title":"Plausible.Site.changeset/2","doc":"","ref":"Plausible.Site.html#changeset/2"},{"type":"function","title":"Plausible.Site.crm_changeset/2","doc":"","ref":"Plausible.Site.html#crm_changeset/2"},{"type":"function","title":"Plausible.Site.make_private/1","doc":"","ref":"Plausible.Site.html#make_private/1"},{"type":"function","title":"Plausible.Site.make_public/1","doc":"","ref":"Plausible.Site.html#make_public/1"},{"type":"function","title":"Plausible.Site.new/1","doc":"","ref":"Plausible.Site.html#new/1"},{"type":"function","title":"Plausible.Site.set_native_stats_start_at/2","doc":"","ref":"Plausible.Site.html#set_native_stats_start_at/2"},{"type":"function","title":"Plausible.Site.set_stats_start_date/2","doc":"","ref":"Plausible.Site.html#set_stats_start_date/2"},{"type":"function","title":"Plausible.Site.tz_offset/2","doc":"","ref":"Plausible.Site.html#tz_offset/2"},{"type":"function","title":"Plausible.Site.update_changeset/3","doc":"","ref":"Plausible.Site.html#update_changeset/3"},{"type":"type","title":"Plausible.Site.t/0","doc":"","ref":"Plausible.Site.html#t:t/0"},{"type":"module","title":"Plausible.Site.Cache","doc":"The cache allows lookups by both `domain` and `domain_changed_from`\nfields - this is to allow traffic from sites whose domains changed within a certain\ngrace period (see: `Plausible.Site.Transfer`).\n\nTo differentiate cached Site structs from those retrieved directly from the\ndatabase, a virtual schema field `from_cache?: true` is set.\nThis indicates the `Plausible.Site` struct is incomplete in comparison to its\ndatabase counterpart -- to spare bandwidth and query execution time,\nonly selected database columns are retrieved and cached.\n\nThe `@cached_schema_fields` attribute defines the list of DB columns\nqueried on each cache refresh.\n\nAlso see tests for more comprehensive examples.","ref":"Plausible.Site.Cache.html"},{"type":"function","title":"Plausible.Site.Cache.child_spec/1","doc":"","ref":"Plausible.Site.Cache.html#child_spec/1"},{"type":"function","title":"Plausible.Site.Cache.get/2","doc":"","ref":"Plausible.Site.Cache.html#get/2"},{"type":"function","title":"Plausible.Site.Cache.get_or_store/3","doc":"","ref":"Plausible.Site.Cache.html#get_or_store/3"},{"type":"function","title":"Plausible.Site.Cache.get_site_id/2","doc":"","ref":"Plausible.Site.Cache.html#get_site_id/2"},{"type":"function","title":"Plausible.Site.Cache.hit_rate/1","doc":"","ref":"Plausible.Site.Cache.html#hit_rate/1"},{"type":"function","title":"Plausible.Site.Cache.merge_items/2","doc":"","ref":"Plausible.Site.Cache.html#merge_items/2"},{"type":"function","title":"Plausible.Site.Cache.ready?/1","doc":"Ensures the cache has non-zero size unless no items exist.\nUseful for orchestrating app startup to prevent the service\ngoing up asynchronously with an empty cache.","ref":"Plausible.Site.Cache.html#ready?/1"},{"type":"function","title":"Plausible.Site.Cache.refresh_all/1","doc":"","ref":"Plausible.Site.Cache.html#refresh_all/1"},{"type":"function","title":"Plausible.Site.Cache.refresh_updated_recently/1","doc":"","ref":"Plausible.Site.Cache.html#refresh_updated_recently/1"},{"type":"function","title":"Plausible.Site.Cache.size/1","doc":"","ref":"Plausible.Site.Cache.html#size/1"},{"type":"function","title":"Plausible.Site.Cache.telemetry_event_refresh/2","doc":"","ref":"Plausible.Site.Cache.html#telemetry_event_refresh/2"},{"type":"function","title":"Plausible.Site.Cache.touch_site!/2","doc":"","ref":"Plausible.Site.Cache.html#touch_site!/2"},{"type":"module","title":"Plausible.Site.Domain","doc":"Basic interface for domain changes.\n\nOnce `Plausible.DataMigration.NumericIDs` schema migration is ready, \ndomain change operation will be enabled, accessible to the users.\n\nWe will set a transition period of 72 hours\nduring which, both old and new domains, will be accepted as traffic\nidentifiers to the same site. \n\nA periodic worker will call the `expire/0` function to end it where applicable.\nSee: `Plausible.Workers.ExpireDomainChangeTransitions`.\n\nThe underlying changeset for domain change (see: `Plausible.Site`) relies\non database trigger installed via `Plausible.Repo.Migrations.AllowDomainChange`\nPostgres migration. The trigger checks if either `domain` or `domain_changed_from`\nexist to ensure unicity.","ref":"Plausible.Site.Domain.html"},{"type":"function","title":"Plausible.Site.Domain.change/3","doc":"","ref":"Plausible.Site.Domain.html#change/3"},{"type":"function","title":"Plausible.Site.Domain.expire_change_transitions/1","doc":"","ref":"Plausible.Site.Domain.html#expire_change_transitions/1"},{"type":"module","title":"Plausible.Site.GateKeeper","doc":"Thin wrapper around `Plausible.RateLimit` for gate keeping domain-specific events\nduring the ingestion phase. When the site is allowed, gate keeping\ncheck returns `:allow`, otherwise a `:deny` tagged tuple is returned\nwith one of the following policy markers:\n * `:not_found` (indicates site not found in cache)\n * `:block` (indicates disabled sites)\n * `:throttle` (indicates rate limiting)\n\nRate Limiting buckets are configured per site (externally via the CRM).\nSee: `Plausible.Site`\n\nTo look up each site's configuration, the RateLimiter fetches\na Site by domain using `Plausible.Cache` interface.\n\nThe module defines two policies outside the regular bucket inspection:\n * when the site is not found in cache: not_found\n * when the underlying rate limiting mechanism returns\n an internal error: :allow","ref":"Plausible.Site.GateKeeper.html"},{"type":"function","title":"Plausible.Site.GateKeeper.check/2","doc":"","ref":"Plausible.Site.GateKeeper.html#check/2"},{"type":"function","title":"Plausible.Site.GateKeeper.key/1","doc":"","ref":"Plausible.Site.GateKeeper.html#key/1"},{"type":"type","title":"Plausible.Site.GateKeeper.policy/0","doc":"","ref":"Plausible.Site.GateKeeper.html#t:policy/0"},{"type":"type","title":"Plausible.Site.GateKeeper.t/0","doc":"","ref":"Plausible.Site.GateKeeper.html#t:t/0"},{"type":"module","title":"Plausible.Site.GoogleAuth","doc":"","ref":"Plausible.Site.GoogleAuth.html"},{"type":"function","title":"Plausible.Site.GoogleAuth.changeset/2","doc":"","ref":"Plausible.Site.GoogleAuth.html#changeset/2"},{"type":"function","title":"Plausible.Site.GoogleAuth.set_property/2","doc":"","ref":"Plausible.Site.GoogleAuth.html#set_property/2"},{"type":"module","title":"Plausible.Site.ImportedData","doc":"Embedded schema for analytics imports\n\nNOTE: needed by `SiteImports` data migration script","ref":"Plausible.Site.ImportedData.html"},{"type":"type","title":"Plausible.Site.ImportedData.t/0","doc":"","ref":"Plausible.Site.ImportedData.html#t:t/0"},{"type":"module","title":"Plausible.Site.Membership","doc":"","ref":"Plausible.Site.Membership.html"},{"type":"function","title":"Plausible.Site.Membership.new/2","doc":"","ref":"Plausible.Site.Membership.html#new/2"},{"type":"function","title":"Plausible.Site.Membership.set_role/2","doc":"","ref":"Plausible.Site.Membership.html#set_role/2"},{"type":"type","title":"Plausible.Site.Membership.role/0","doc":"","ref":"Plausible.Site.Membership.html#t:role/0"},{"type":"type","title":"Plausible.Site.Membership.t/0","doc":"","ref":"Plausible.Site.Membership.html#t:t/0"},{"type":"module","title":"Plausible.Site.Memberships","doc":"API for site memberships and invitations","ref":"Plausible.Site.Memberships.html"},{"type":"function","title":"Plausible.Site.Memberships.accept_invitation/2","doc":"","ref":"Plausible.Site.Memberships.html#accept_invitation/2"},{"type":"function","title":"Plausible.Site.Memberships.all_pending_ownerships/1","doc":"","ref":"Plausible.Site.Memberships.html#all_pending_ownerships/1"},{"type":"function","title":"Plausible.Site.Memberships.any?/1","doc":"","ref":"Plausible.Site.Memberships.html#any?/1"},{"type":"function","title":"Plausible.Site.Memberships.any_or_pending?/1","doc":"","ref":"Plausible.Site.Memberships.html#any_or_pending?/1"},{"type":"function","title":"Plausible.Site.Memberships.bulk_create_invitation/5","doc":"","ref":"Plausible.Site.Memberships.html#bulk_create_invitation/5"},{"type":"function","title":"Plausible.Site.Memberships.bulk_transfer_ownership_direct/2","doc":"","ref":"Plausible.Site.Memberships.html#bulk_transfer_ownership_direct/2"},{"type":"function","title":"Plausible.Site.Memberships.create_invitation/4","doc":"","ref":"Plausible.Site.Memberships.html#create_invitation/4"},{"type":"function","title":"Plausible.Site.Memberships.pending?/1","doc":"","ref":"Plausible.Site.Memberships.html#pending?/1"},{"type":"function","title":"Plausible.Site.Memberships.pending_ownerships?/1","doc":"","ref":"Plausible.Site.Memberships.html#pending_ownerships?/1"},{"type":"function","title":"Plausible.Site.Memberships.reject_invitation/2","doc":"","ref":"Plausible.Site.Memberships.html#reject_invitation/2"},{"type":"function","title":"Plausible.Site.Memberships.remove_invitation/2","doc":"","ref":"Plausible.Site.Memberships.html#remove_invitation/2"},{"type":"function","title":"Plausible.Site.Memberships.transfer_ownership/2","doc":"","ref":"Plausible.Site.Memberships.html#transfer_ownership/2"},{"type":"module","title":"Plausible.Site.Memberships.AcceptInvitation","doc":"Service for accepting invitations, including ownership transfers.\n\nAccepting invitation accounts for the fact that it's possible\nthat accepting user has an existing membership for the site and\nacts permissively to not unnecessarily disrupt the flow while\nalso maintaining integrity of site memberships. This also applies\nto cases where users update their email address between issuing\nthe invitation and accepting it.","ref":"Plausible.Site.Memberships.AcceptInvitation.html"},{"type":"function","title":"Plausible.Site.Memberships.AcceptInvitation.accept_invitation/2","doc":"","ref":"Plausible.Site.Memberships.AcceptInvitation.html#accept_invitation/2"},{"type":"function","title":"Plausible.Site.Memberships.AcceptInvitation.transfer_ownership/2","doc":"","ref":"Plausible.Site.Memberships.AcceptInvitation.html#transfer_ownership/2"},{"type":"module","title":"Plausible.Site.Memberships.CreateInvitation","doc":"Service for inviting new or existing users to a sites, including ownershhip\ntransfers.","ref":"Plausible.Site.Memberships.CreateInvitation.html"},{"type":"function","title":"Plausible.Site.Memberships.CreateInvitation.bulk_create_invitation/5","doc":"","ref":"Plausible.Site.Memberships.CreateInvitation.html#bulk_create_invitation/5"},{"type":"function","title":"Plausible.Site.Memberships.CreateInvitation.bulk_transfer_ownership_direct/2","doc":"","ref":"Plausible.Site.Memberships.CreateInvitation.html#bulk_transfer_ownership_direct/2"},{"type":"function","title":"Plausible.Site.Memberships.CreateInvitation.create_invitation/4","doc":"Invites a new team member to the given site. Returns a\n%Plausible.Auth.Invitation{} struct and sends the invitee an email to accept\nthis invitation.\n\nThe inviter must have enough permissions to invite the new team member,\notherwise this function returns `{:error, :forbidden}`.\n\nIf the new team member role is `:owner`, this function handles the invitation\nas an ownership transfer and requires the inviter to be the owner of the site.","ref":"Plausible.Site.Memberships.CreateInvitation.html#create_invitation/4"},{"type":"type","title":"Plausible.Site.Memberships.CreateInvitation.invite_error/0","doc":"","ref":"Plausible.Site.Memberships.CreateInvitation.html#t:invite_error/0"},{"type":"module","title":"Plausible.Site.Memberships.RejectInvitation","doc":"Service for rejecting invitations.","ref":"Plausible.Site.Memberships.RejectInvitation.html"},{"type":"function","title":"Plausible.Site.Memberships.RejectInvitation.reject_invitation/2","doc":"","ref":"Plausible.Site.Memberships.RejectInvitation.html#reject_invitation/2"},{"type":"module","title":"Plausible.Site.Memberships.RemoveInvitation","doc":"Service for removing invitations.","ref":"Plausible.Site.Memberships.RemoveInvitation.html"},{"type":"function","title":"Plausible.Site.Memberships.RemoveInvitation.remove_invitation/2","doc":"","ref":"Plausible.Site.Memberships.RemoveInvitation.html#remove_invitation/2"},{"type":"module","title":"Plausible.Site.MonthlyReport","doc":"","ref":"Plausible.Site.MonthlyReport.html"},{"type":"function","title":"Plausible.Site.MonthlyReport.add_recipient/2","doc":"","ref":"Plausible.Site.MonthlyReport.html#add_recipient/2"},{"type":"function","title":"Plausible.Site.MonthlyReport.changeset/2","doc":"","ref":"Plausible.Site.MonthlyReport.html#changeset/2"},{"type":"function","title":"Plausible.Site.MonthlyReport.remove_recipient/2","doc":"","ref":"Plausible.Site.MonthlyReport.html#remove_recipient/2"},{"type":"module","title":"Plausible.Site.Removal","doc":"A site deletion service stub.","ref":"Plausible.Site.Removal.html"},{"type":"function","title":"Plausible.Site.Removal.run/1","doc":"","ref":"Plausible.Site.Removal.html#run/1"},{"type":"module","title":"Plausible.Site.SharedLink","doc":"","ref":"Plausible.Site.SharedLink.html"},{"type":"function","title":"Plausible.Site.SharedLink.changeset/2","doc":"","ref":"Plausible.Site.SharedLink.html#changeset/2"},{"type":"type","title":"Plausible.Site.SharedLink.t/0","doc":"","ref":"Plausible.Site.SharedLink.html#t:t/0"},{"type":"module","title":"Plausible.Site.TrafficChangeNotification","doc":"Configuration schema for site-specific traffic change notifications.","ref":"Plausible.Site.TrafficChangeNotification.html"},{"type":"function","title":"Plausible.Site.TrafficChangeNotification.add_recipient/2","doc":"","ref":"Plausible.Site.TrafficChangeNotification.html#add_recipient/2"},{"type":"function","title":"Plausible.Site.TrafficChangeNotification.changeset/2","doc":"","ref":"Plausible.Site.TrafficChangeNotification.html#changeset/2"},{"type":"function","title":"Plausible.Site.TrafficChangeNotification.remove_recipient/2","doc":"","ref":"Plausible.Site.TrafficChangeNotification.html#remove_recipient/2"},{"type":"function","title":"Plausible.Site.TrafficChangeNotification.was_sent/1","doc":"","ref":"Plausible.Site.TrafficChangeNotification.html#was_sent/1"},{"type":"module","title":"Plausible.Site.UserPreference","doc":"User-specific site preferences schema","ref":"Plausible.Site.UserPreference.html"},{"type":"function","title":"Plausible.Site.UserPreference.changeset/3","doc":"","ref":"Plausible.Site.UserPreference.html#changeset/3"},{"type":"macro","title":"Plausible.Site.UserPreference.options/0","doc":"","ref":"Plausible.Site.UserPreference.html#options/0"},{"type":"type","title":"Plausible.Site.UserPreference.t/0","doc":"","ref":"Plausible.Site.UserPreference.html#t:t/0"},{"type":"module","title":"Plausible.Site.WeeklyReport","doc":"","ref":"Plausible.Site.WeeklyReport.html"},{"type":"function","title":"Plausible.Site.WeeklyReport.add_recipient/2","doc":"","ref":"Plausible.Site.WeeklyReport.html#add_recipient/2"},{"type":"function","title":"Plausible.Site.WeeklyReport.changeset/2","doc":"","ref":"Plausible.Site.WeeklyReport.html#changeset/2"},{"type":"function","title":"Plausible.Site.WeeklyReport.remove_recipient/2","doc":"","ref":"Plausible.Site.WeeklyReport.html#remove_recipient/2"},{"type":"module","title":"Plausible.SiteAdmin","doc":"","ref":"Plausible.SiteAdmin.html"},{"type":"function","title":"Plausible.SiteAdmin.before_update/2","doc":"","ref":"Plausible.SiteAdmin.html#before_update/2"},{"type":"function","title":"Plausible.SiteAdmin.create_changeset/2","doc":"","ref":"Plausible.SiteAdmin.html#create_changeset/2"},{"type":"function","title":"Plausible.SiteAdmin.custom_index_query/3","doc":"","ref":"Plausible.SiteAdmin.html#custom_index_query/3"},{"type":"function","title":"Plausible.SiteAdmin.form_fields/1","doc":"","ref":"Plausible.SiteAdmin.html#form_fields/1"},{"type":"function","title":"Plausible.SiteAdmin.get_struct_fields/1","doc":"","ref":"Plausible.SiteAdmin.html#get_struct_fields/1"},{"type":"function","title":"Plausible.SiteAdmin.index/1","doc":"","ref":"Plausible.SiteAdmin.html#index/1"},{"type":"function","title":"Plausible.SiteAdmin.list_actions/1","doc":"","ref":"Plausible.SiteAdmin.html#list_actions/1"},{"type":"function","title":"Plausible.SiteAdmin.ordering/1","doc":"","ref":"Plausible.SiteAdmin.html#ordering/1"},{"type":"function","title":"Plausible.SiteAdmin.search_fields/1","doc":"","ref":"Plausible.SiteAdmin.html#search_fields/1"},{"type":"function","title":"Plausible.SiteAdmin.update_changeset/2","doc":"","ref":"Plausible.SiteAdmin.html#update_changeset/2"},{"type":"module","title":"Plausible.Sites","doc":"Sites context functions.","ref":"Plausible.Sites.html"},{"type":"function","title":"Plausible.Sites.clear_stats_start_date!/1","doc":"","ref":"Plausible.Sites.html#clear_stats_start_date!/1"},{"type":"function","title":"Plausible.Sites.create/2","doc":"","ref":"Plausible.Sites.html#create/2"},{"type":"function","title":"Plausible.Sites.create_shared_link/3","doc":"","ref":"Plausible.Sites.html#create_shared_link/3"},{"type":"function","title":"Plausible.Sites.for_user_query/1","doc":"","ref":"Plausible.Sites.html#for_user_query/1"},{"type":"function","title":"Plausible.Sites.get_by_domain/1","doc":"","ref":"Plausible.Sites.html#get_by_domain/1"},{"type":"function","title":"Plausible.Sites.get_by_domain!/1","doc":"","ref":"Plausible.Sites.html#get_by_domain!/1"},{"type":"function","title":"Plausible.Sites.get_for_user/3","doc":"","ref":"Plausible.Sites.html#get_for_user/3"},{"type":"function","title":"Plausible.Sites.get_for_user!/3","doc":"","ref":"Plausible.Sites.html#get_for_user!/3"},{"type":"function","title":"Plausible.Sites.has_admin_access?/2","doc":"","ref":"Plausible.Sites.html#has_admin_access?/2"},{"type":"function","title":"Plausible.Sites.has_goals?/1","doc":"","ref":"Plausible.Sites.html#has_goals?/1"},{"type":"function","title":"Plausible.Sites.has_stats?/1","doc":"","ref":"Plausible.Sites.html#has_stats?/1"},{"type":"function","title":"Plausible.Sites.is_member?/2","doc":"","ref":"Plausible.Sites.html#is_member?/2"},{"type":"function","title":"Plausible.Sites.list/3","doc":"","ref":"Plausible.Sites.html#list/3"},{"type":"function","title":"Plausible.Sites.list_with_invitations/3","doc":"","ref":"Plausible.Sites.html#list_with_invitations/3"},{"type":"function","title":"Plausible.Sites.locked?/1","doc":"","ref":"Plausible.Sites.html#locked?/1"},{"type":"function","title":"Plausible.Sites.native_stats_start_date/1","doc":"","ref":"Plausible.Sites.html#native_stats_start_date/1"},{"type":"function","title":"Plausible.Sites.owned_site_ids/1","doc":"","ref":"Plausible.Sites.html#owned_site_ids/1"},{"type":"function","title":"Plausible.Sites.owned_sites_count/1","doc":"","ref":"Plausible.Sites.html#owned_sites_count/1"},{"type":"function","title":"Plausible.Sites.owned_sites_domains/1","doc":"","ref":"Plausible.Sites.html#owned_sites_domains/1"},{"type":"function","title":"Plausible.Sites.owned_sites_locked?/1","doc":"","ref":"Plausible.Sites.html#owned_sites_locked?/1"},{"type":"function","title":"Plausible.Sites.role/2","doc":"","ref":"Plausible.Sites.html#role/2"},{"type":"function","title":"Plausible.Sites.set_option/4","doc":"","ref":"Plausible.Sites.html#set_option/4"},{"type":"function","title":"Plausible.Sites.shared_link_url/2","doc":"","ref":"Plausible.Sites.html#shared_link_url/2"},{"type":"function","title":"Plausible.Sites.stats_start_date/1","doc":"Returns the date of the first event of the given site, or `nil` if the site\ndoes not have stats yet.\n\nIf this is the first time the function is called for the site, it queries\nimported stats and Clickhouse, choosing the earliest start date and saves\nit in the sites table.","ref":"Plausible.Sites.html#stats_start_date/1"},{"type":"function","title":"Plausible.Sites.toggle_pin/2","doc":"","ref":"Plausible.Sites.html#toggle_pin/2"},{"type":"type","title":"Plausible.Sites.list_opt/0","doc":"","ref":"Plausible.Sites.html#t:list_opt/0"},{"type":"module","title":"Plausible.Stats","doc":"","ref":"Plausible.Stats.html"},{"type":"function","title":"Plausible.Stats.aggregate/3","doc":"","ref":"Plausible.Stats.html#aggregate/3"},{"type":"function","title":"Plausible.Stats.breakdown/4","doc":"","ref":"Plausible.Stats.html#breakdown/4"},{"type":"function","title":"Plausible.Stats.current_visitors/2","doc":"","ref":"Plausible.Stats.html#current_visitors/2"},{"type":"function","title":"Plausible.Stats.filter_suggestions/4","doc":"","ref":"Plausible.Stats.html#filter_suggestions/4"},{"type":"function","title":"Plausible.Stats.funnel/3","doc":"","ref":"Plausible.Stats.html#funnel/3"},{"type":"function","title":"Plausible.Stats.query/2","doc":"","ref":"Plausible.Stats.html#query/2"},{"type":"function","title":"Plausible.Stats.timeseries/3","doc":"","ref":"Plausible.Stats.html#timeseries/3"},{"type":"module","title":"Plausible.Stats.Aggregate","doc":"Builds aggregate results for v1 of our stats API and dashboards.\n\nAvoid adding new logic here - update QueryBuilder etc instead.","ref":"Plausible.Stats.Aggregate.html"},{"type":"function","title":"Plausible.Stats.Aggregate.aggregate/3","doc":"","ref":"Plausible.Stats.Aggregate.html#aggregate/3"},{"type":"module","title":"Plausible.Stats.Base","doc":"","ref":"Plausible.Stats.Base.html"},{"type":"function","title":"Plausible.Stats.Base.base_event_query/2","doc":"","ref":"Plausible.Stats.Base.html#base_event_query/2"},{"type":"function","title":"Plausible.Stats.Base.query_sessions/2","doc":"","ref":"Plausible.Stats.Base.html#query_sessions/2"},{"type":"module","title":"Plausible.Stats.Breakdown","doc":"Builds breakdown results for v1 of our stats API and dashboards.\n\nAvoid adding new logic here - update QueryBuilder etc instead.","ref":"Plausible.Stats.Breakdown.html"},{"type":"function","title":"Plausible.Stats.Breakdown.breakdown/5","doc":"","ref":"Plausible.Stats.Breakdown.html#breakdown/5"},{"type":"function","title":"Plausible.Stats.Breakdown.transform_dimensions/1","doc":"","ref":"Plausible.Stats.Breakdown.html#transform_dimensions/1"},{"type":"module","title":"Plausible.Stats.Clickhouse","doc":"","ref":"Plausible.Stats.Clickhouse.html"},{"type":"function","title":"Plausible.Stats.Clickhouse.current_visitors/1","doc":"","ref":"Plausible.Stats.Clickhouse.html#current_visitors/1"},{"type":"function","title":"Plausible.Stats.Clickhouse.current_visitors_12h/1","doc":"","ref":"Plausible.Stats.Clickhouse.html#current_visitors_12h/1"},{"type":"function","title":"Plausible.Stats.Clickhouse.empty_24h_visitors_hourly_intervals/2","doc":"","ref":"Plausible.Stats.Clickhouse.html#empty_24h_visitors_hourly_intervals/2"},{"type":"function","title":"Plausible.Stats.Clickhouse.has_pageviews?/1","doc":"","ref":"Plausible.Stats.Clickhouse.html#has_pageviews?/1"},{"type":"function","title":"Plausible.Stats.Clickhouse.imported_pageview_count/1","doc":"","ref":"Plausible.Stats.Clickhouse.html#imported_pageview_count/1"},{"type":"function","title":"Plausible.Stats.Clickhouse.imported_pageview_counts/1","doc":"","ref":"Plausible.Stats.Clickhouse.html#imported_pageview_counts/1"},{"type":"function","title":"Plausible.Stats.Clickhouse.last_24h_visitors_hourly_intervals/2","doc":"","ref":"Plausible.Stats.Clickhouse.html#last_24h_visitors_hourly_intervals/2"},{"type":"function","title":"Plausible.Stats.Clickhouse.pageview_start_date_local/1","doc":"","ref":"Plausible.Stats.Clickhouse.html#pageview_start_date_local/1"},{"type":"function","title":"Plausible.Stats.Clickhouse.top_sources_for_spike/4","doc":"","ref":"Plausible.Stats.Clickhouse.html#top_sources_for_spike/4"},{"type":"function","title":"Plausible.Stats.Clickhouse.usage_breakdown/2","doc":"","ref":"Plausible.Stats.Clickhouse.html#usage_breakdown/2"},{"type":"module","title":"Plausible.Stats.Compare","doc":"","ref":"Plausible.Stats.Compare.html"},{"type":"function","title":"Plausible.Stats.Compare.calculate_change/3","doc":"","ref":"Plausible.Stats.Compare.html#calculate_change/3"},{"type":"function","title":"Plausible.Stats.Compare.percent_change/2","doc":"","ref":"Plausible.Stats.Compare.html#percent_change/2"},{"type":"module","title":"Plausible.Stats.Comparisons","doc":"This module provides functions for comparing query periods.\n\nIt allows you to compare a given period with a previous period or with the\nsame period from the previous year. For example, you can compare this month's\nmain graph with last month or with the same month from last year.","ref":"Plausible.Stats.Comparisons.html"},{"type":"function","title":"Plausible.Stats.Comparisons.compare/4","doc":"Generates a comparison query based on the source query and comparison mode.\n\nThe mode parameter specifies the type of comparison and can be one of the\nfollowing:\n\n * `\"previous_period\"` - shifts back the query by the same number of days the\n source query has.\n\n * `\"year_over_year\"` - shifts back the query by 1 year.\n\n * `\"custom\"` - compares the query using a custom date range. See options for\n more details.\n\nThe comparison query returned by the function has its end date restricted to\nthe current day. This can be overridden by the `now` option, described below.","ref":"Plausible.Stats.Comparisons.html#compare/4"},{"type":"function","title":"Options - Plausible.Stats.Comparisons.compare/4","doc":"* `:now` - a `NaiveDateTime` struct with the current date and time. This is\n optional and used for testing purposes.\n\n * `:from` - a ISO-8601 date string used when mode is `\"custom\"`.\n\n * `:to` - a ISO-8601 date string used when mode is `\"custom\"`. Must be\n after `from`.\n\n * `:match_day_of_week?` - determines whether the comparison query should be\n adjusted to match the day of the week of the source query. When this option\n is set to true, the comparison query is shifted to start on the same day of\n the week as the source query, rather than on the exact same date. For\n example, if the source query starts on Sunday, January 1st, 2023 and the\n `year_over_year` comparison query is configured to `match_day_of_week?`,\n it will be shifted to start on Sunday, January 2nd, 2022 instead of\n January 1st. Defaults to false.","ref":"Plausible.Stats.Comparisons.html#compare/4-options"},{"type":"type","title":"Plausible.Stats.Comparisons.mode/0","doc":"","ref":"Plausible.Stats.Comparisons.html#t:mode/0"},{"type":"module","title":"Plausible.Stats.CurrentVisitors","doc":"","ref":"Plausible.Stats.CurrentVisitors.html"},{"type":"function","title":"Plausible.Stats.CurrentVisitors.current_visitors/2","doc":"","ref":"Plausible.Stats.CurrentVisitors.html#current_visitors/2"},{"type":"module","title":"Plausible.Stats.CustomProps","doc":"Module for querying user defined 'custom properties'.","ref":"Plausible.Stats.CustomProps.html"},{"type":"function","title":"Plausible.Stats.CustomProps.fetch_prop_names/2","doc":"","ref":"Plausible.Stats.CustomProps.html#fetch_prop_names/2"},{"type":"function","title":"Plausible.Stats.CustomProps.maybe_allowed_props_only/2","doc":"","ref":"Plausible.Stats.CustomProps.html#maybe_allowed_props_only/2"},{"type":"module","title":"Plausible.Stats.EmailReport","doc":"This module exposes a `get/2` function that returns a map\nof stats needed for email reports. These stats include:\n\n* Total pageviews\n* Unique visitors\n* Bounce rate\n* A list of Top 5 sources (excluding \"Direct / None\")\n* A list of Top 5 pages\n\nwhere total pageviews, unique visitors, and bounce rate\nalso include the change compared to previous period.","ref":"Plausible.Stats.EmailReport.html"},{"type":"function","title":"Plausible.Stats.EmailReport.get/2","doc":"","ref":"Plausible.Stats.EmailReport.html#get/2"},{"type":"module","title":"Plausible.Stats.FilterSuggestions","doc":"","ref":"Plausible.Stats.FilterSuggestions.html"},{"type":"function","title":"Plausible.Stats.FilterSuggestions.filter_suggestions/4","doc":"","ref":"Plausible.Stats.FilterSuggestions.html#filter_suggestions/4"},{"type":"module","title":"Plausible.Stats.Filters","doc":"A module for parsing filters used in stat queries.","ref":"Plausible.Stats.Filters.html"},{"type":"function","title":"Plausible.Stats.Filters.event_props/0","doc":"","ref":"Plausible.Stats.Filters.html#event_props/0"},{"type":"function","title":"Plausible.Stats.Filters.event_table_visit_props/0","doc":"","ref":"Plausible.Stats.Filters.html#event_table_visit_props/0"},{"type":"function","title":"Plausible.Stats.Filters.parse/1","doc":"Parses different filter formats.\n\nDepending on the format and type of the `filters` argument, returns:\n\n * a decoded list, when `filters` is encoded JSON\n * a parsed filter list, when `filters` is a filter expression string\n * the same list, when `filters` is a map\n\nReturns an empty list when argument type is unexpected (e.g. `nil`).\n\n#","ref":"Plausible.Stats.Filters.html#parse/1"},{"type":"function","title":"Examples: - Plausible.Stats.Filters.parse/1","doc":"iex> Filters.parse(\"{\\\"page\\\":\\\"/blog/**\\\"}\")\n [[:matches, \"event:page\", [\"/blog/**\"]]]\n\n iex> Filters.parse(\"visit:browser!=Chrome\")\n [[:is_not, \"visit:browser\", [\"Chrome\"]]]\n\n iex> Filters.parse(nil)\n []","ref":"Plausible.Stats.Filters.html#parse/1-examples"},{"type":"function","title":"Plausible.Stats.Filters.visit_props/0","doc":"","ref":"Plausible.Stats.Filters.html#visit_props/0"},{"type":"function","title":"Plausible.Stats.Filters.without_prefix/1","doc":"","ref":"Plausible.Stats.Filters.html#without_prefix/1"},{"type":"module","title":"Plausible.Stats.Filters.Utils","doc":"Contains utility functions shared between `LegacyDashboardFilterParser`\nand `StatsAPIFilterParser`.","ref":"Plausible.Stats.Filters.Utils.html"},{"type":"function","title":"Plausible.Stats.Filters.Utils.list_expression?/1","doc":"","ref":"Plausible.Stats.Filters.Utils.html#list_expression?/1"},{"type":"function","title":"Plausible.Stats.Filters.Utils.page_regex/1","doc":"","ref":"Plausible.Stats.Filters.Utils.html#page_regex/1"},{"type":"function","title":"Plausible.Stats.Filters.Utils.parse_member_list/1","doc":"","ref":"Plausible.Stats.Filters.Utils.html#parse_member_list/1"},{"type":"function","title":"Plausible.Stats.Filters.Utils.remove_escape_chars/1","doc":"","ref":"Plausible.Stats.Filters.Utils.html#remove_escape_chars/1"},{"type":"function","title":"Plausible.Stats.Filters.Utils.split_goals/1","doc":"","ref":"Plausible.Stats.Filters.Utils.html#split_goals/1"},{"type":"function","title":"Plausible.Stats.Filters.Utils.split_goals_query_expressions/1","doc":"","ref":"Plausible.Stats.Filters.Utils.html#split_goals_query_expressions/1"},{"type":"function","title":"Plausible.Stats.Filters.Utils.wildcard_expression?/1","doc":"","ref":"Plausible.Stats.Filters.Utils.html#wildcard_expression?/1"},{"type":"module","title":"Plausible.Stats.Funnel","doc":"Module responsible for funnel evaluation, i.e. building and executing\nClickHouse funnel query based on `Plausible.Funnel` definition.","ref":"Plausible.Stats.Funnel.html"},{"type":"function","title":"Plausible.Stats.Funnel.funnel/3","doc":"","ref":"Plausible.Stats.Funnel.html#funnel/3"},{"type":"module","title":"Plausible.Stats.Goal.Revenue","doc":"Revenue specific functions for the stats scope","ref":"Plausible.Stats.Goal.Revenue.html"},{"type":"function","title":"Plausible.Stats.Goal.Revenue.cast_revenue_metrics_to_money/2","doc":"","ref":"Plausible.Stats.Goal.Revenue.html#cast_revenue_metrics_to_money/2"},{"type":"function","title":"Plausible.Stats.Goal.Revenue.get_revenue_tracking_currency/3","doc":"Returns the common currency for the goal filters in a query. If there are no\ngoal filters, multiple currencies or the site owner does not have access to\nrevenue goals, `nil` is returned and revenue metrics are dropped.\n\nAggregating revenue data works only for same currency goals. If the query is\nfiltered by goals with different currencies, for example, one USD and other\nEUR, revenue metrics are dropped.","ref":"Plausible.Stats.Goal.Revenue.html#get_revenue_tracking_currency/3"},{"type":"function","title":"Plausible.Stats.Goal.Revenue.revenue_metrics/0","doc":"","ref":"Plausible.Stats.Goal.Revenue.html#revenue_metrics/0"},{"type":"module","title":"Plausible.Stats.Imported","doc":"","ref":"Plausible.Stats.Imported.html"},{"type":"function","title":"Plausible.Stats.Imported.goals_with_path/0","doc":"","ref":"Plausible.Stats.Imported.html#goals_with_path/0"},{"type":"function","title":"Plausible.Stats.Imported.goals_with_url/0","doc":"","ref":"Plausible.Stats.Imported.html#goals_with_url/0"},{"type":"function","title":"Plausible.Stats.Imported.merge_imported/4","doc":"","ref":"Plausible.Stats.Imported.html#merge_imported/4"},{"type":"function","title":"Plausible.Stats.Imported.merge_imported_city_suggestions/3","doc":"","ref":"Plausible.Stats.Imported.html#merge_imported_city_suggestions/3"},{"type":"function","title":"Plausible.Stats.Imported.merge_imported_country_suggestions/3","doc":"","ref":"Plausible.Stats.Imported.html#merge_imported_country_suggestions/3"},{"type":"function","title":"Plausible.Stats.Imported.merge_imported_filter_suggestions/5","doc":"","ref":"Plausible.Stats.Imported.html#merge_imported_filter_suggestions/5"},{"type":"function","title":"Plausible.Stats.Imported.merge_imported_region_suggestions/3","doc":"","ref":"Plausible.Stats.Imported.html#merge_imported_region_suggestions/3"},{"type":"function","title":"Plausible.Stats.Imported.schema_supports_query?/1","doc":"Returns a boolean indicating whether the combination of filters and\nbreakdown property is possible to query from the imported tables.\n\nUsually, when no filters are used, the imported schema supports the\nquery. There is one exception though - breakdown by a custom property.\nWe are currently importing only two custom properties - `url` and `path.\nBoth these properties can only be used with their special goal filter\n(see `@goals_with_url` and `@goals_with_path`).","ref":"Plausible.Stats.Imported.html#schema_supports_query?/1"},{"type":"function","title":"Plausible.Stats.Imported.total_imported_visitors/2","doc":"","ref":"Plausible.Stats.Imported.html#total_imported_visitors/2"},{"type":"module","title":"Plausible.Stats.Imported.Base","doc":"A module for building the base of an imported stats query","ref":"Plausible.Stats.Imported.Base.html"},{"type":"function","title":"Plausible.Stats.Imported.Base.decide_tables/1","doc":"","ref":"Plausible.Stats.Imported.Base.html#decide_tables/1"},{"type":"function","title":"Plausible.Stats.Imported.Base.property_to_table_mappings/0","doc":"","ref":"Plausible.Stats.Imported.Base.html#property_to_table_mappings/0"},{"type":"function","title":"Plausible.Stats.Imported.Base.query_imported/2","doc":"","ref":"Plausible.Stats.Imported.Base.html#query_imported/2"},{"type":"function","title":"Plausible.Stats.Imported.Base.query_imported/3","doc":"","ref":"Plausible.Stats.Imported.Base.html#query_imported/3"},{"type":"function","title":"Plausible.Stats.Imported.Base.special_goals_for/1","doc":"","ref":"Plausible.Stats.Imported.Base.html#special_goals_for/1"},{"type":"module","title":"Plausible.Stats.Imported.SQL.Builder","doc":"This module is responsible for generating SQL/Ecto expressions\nfor dimensions, filters and metrics used in import table queries","ref":"Plausible.Stats.Imported.SQL.Builder.html"},{"type":"function","title":"Plausible.Stats.Imported.SQL.Builder.group_imported_by/2","doc":"","ref":"Plausible.Stats.Imported.SQL.Builder.html#group_imported_by/2"},{"type":"function","title":"Plausible.Stats.Imported.SQL.Builder.naive_dimension_join/3","doc":"","ref":"Plausible.Stats.Imported.SQL.Builder.html#naive_dimension_join/3"},{"type":"function","title":"Plausible.Stats.Imported.SQL.Builder.select_imported_metrics/2","doc":"","ref":"Plausible.Stats.Imported.SQL.Builder.html#select_imported_metrics/2"},{"type":"function","title":"Plausible.Stats.Imported.SQL.Builder.select_joined_dimensions/2","doc":"","ref":"Plausible.Stats.Imported.SQL.Builder.html#select_joined_dimensions/2"},{"type":"function","title":"Plausible.Stats.Imported.SQL.Builder.select_joined_metrics/2","doc":"","ref":"Plausible.Stats.Imported.SQL.Builder.html#select_joined_metrics/2"},{"type":"module","title":"Plausible.Stats.Interval","doc":"Collection of functions to work with intervals.\n\nThe interval of a query defines the granularity of the data. You can think of\nit as a `GROUP BY` clause. Possible values are `minute`, `hour`, `day`,\n`week`, and `month`.","ref":"Plausible.Stats.Interval.html"},{"type":"function","title":"Plausible.Stats.Interval.default_for_date_range/1","doc":"Returns the suggested interval for the given `Date.Range` struct.","ref":"Plausible.Stats.Interval.html#default_for_date_range/1"},{"type":"function","title":"Plausible.Stats.Interval.default_for_period/1","doc":"Returns the suggested interval for the given time period.","ref":"Plausible.Stats.Interval.html#default_for_period/1"},{"type":"function","title":"Plausible.Stats.Interval.list/0","doc":"","ref":"Plausible.Stats.Interval.html#list/0"},{"type":"function","title":"Plausible.Stats.Interval.valid?/1","doc":"","ref":"Plausible.Stats.Interval.html#valid?/1"},{"type":"function","title":"Plausible.Stats.Interval.valid_by_period/1","doc":"","ref":"Plausible.Stats.Interval.html#valid_by_period/1"},{"type":"function","title":"Plausible.Stats.Interval.valid_for_period?/3","doc":"Returns whether the given interval is valid for a time period.\n\nIntervals longer than periods are not supported, e.g. current month stats with\na month interval, or today stats with a week interval.\n\nThere are two dynamic states:\n* `custom` period is only applicable with `month` or `week` intervals,\n if the `opts[:from]` and `opts[:to]` range difference exceeds 12 months\n* `all` period's interval options depend on particular site's `stats_start_date`\n - daily interval is excluded if the all-time range exceeds 12 months","ref":"Plausible.Stats.Interval.html#valid_for_period?/3"},{"type":"type","title":"Plausible.Stats.Interval.opt/0","doc":"","ref":"Plausible.Stats.Interval.html#t:opt/0"},{"type":"type","title":"Plausible.Stats.Interval.opts/0","doc":"","ref":"Plausible.Stats.Interval.html#t:opts/0"},{"type":"type","title":"Plausible.Stats.Interval.t/0","doc":"","ref":"Plausible.Stats.Interval.html#t:t/0"},{"type":"module","title":"Plausible.Stats.JSONSchema","doc":"Module for validating query parameters against JSON schema.\n\nNote that `internal` queries expose some metrics, filter types and other features not\navailable on the public API.","ref":"Plausible.Stats.JSONSchema.html"},{"type":"function","title":"Plausible.Stats.JSONSchema.raw_public_schema/0","doc":"","ref":"Plausible.Stats.JSONSchema.html#raw_public_schema/0"},{"type":"function","title":"Plausible.Stats.JSONSchema.validate/2","doc":"","ref":"Plausible.Stats.JSONSchema.html#validate/2"},{"type":"module","title":"Plausible.Stats.Legacy.Dimensions","doc":"Deprecated module. See QueryParser for list of valid dimensions","ref":"Plausible.Stats.Legacy.Dimensions.html"},{"type":"function","title":"Plausible.Stats.Legacy.Dimensions.valid?/1","doc":"","ref":"Plausible.Stats.Legacy.Dimensions.html#valid?/1"},{"type":"module","title":"Plausible.Stats.Metrics","doc":"A module listing all available metrics in Plausible.\n\nUseful for an explicit string to atom conversion.","ref":"Plausible.Stats.Metrics.html"},{"type":"function","title":"Plausible.Stats.Metrics.from_string/1","doc":"","ref":"Plausible.Stats.Metrics.html#from_string/1"},{"type":"function","title":"Plausible.Stats.Metrics.from_string!/1","doc":"","ref":"Plausible.Stats.Metrics.html#from_string!/1"},{"type":"function","title":"Plausible.Stats.Metrics.metric?/1","doc":"","ref":"Plausible.Stats.Metrics.html#metric?/1"},{"type":"module","title":"Plausible.Stats.Query","doc":"","ref":"Plausible.Stats.Query.html"},{"type":"function","title":"Plausible.Stats.Query.add_filter/2","doc":"","ref":"Plausible.Stats.Query.html#add_filter/2"},{"type":"function","title":"Plausible.Stats.Query.build/4","doc":"","ref":"Plausible.Stats.Query.html#build/4"},{"type":"function","title":"Plausible.Stats.Query.ensure_include_imported/2","doc":"","ref":"Plausible.Stats.Query.html#ensure_include_imported/2"},{"type":"function","title":"Plausible.Stats.Query.from/3","doc":"Builds query from old-style params. New code should prefer Query.build","ref":"Plausible.Stats.Query.html#from/3"},{"type":"function","title":"Plausible.Stats.Query.get_filter/2","doc":"","ref":"Plausible.Stats.Query.html#get_filter/2"},{"type":"function","title":"Plausible.Stats.Query.get_filter_by_prefix/2","doc":"","ref":"Plausible.Stats.Query.html#get_filter_by_prefix/2"},{"type":"function","title":"Plausible.Stats.Query.has_event_filters?/1","doc":"","ref":"Plausible.Stats.Query.html#has_event_filters?/1"},{"type":"function","title":"Plausible.Stats.Query.put_experimental_reduced_joins/3","doc":"","ref":"Plausible.Stats.Query.html#put_experimental_reduced_joins/3"},{"type":"function","title":"Plausible.Stats.Query.put_imported_opts/3","doc":"","ref":"Plausible.Stats.Query.html#put_imported_opts/3"},{"type":"function","title":"Plausible.Stats.Query.remove_filters/2","doc":"","ref":"Plausible.Stats.Query.html#remove_filters/2"},{"type":"function","title":"Plausible.Stats.Query.set/2","doc":"","ref":"Plausible.Stats.Query.html#set/2"},{"type":"function","title":"Plausible.Stats.Query.trace/2","doc":"","ref":"Plausible.Stats.Query.html#trace/2"},{"type":"type","title":"Plausible.Stats.Query.t/0","doc":"","ref":"Plausible.Stats.Query.html#t:t/0"},{"type":"module","title":"Plausible.Stats.QueryOptimizer","doc":"Methods to manipulate Query for business logic reasons before building an ecto query.","ref":"Plausible.Stats.QueryOptimizer.html"},{"type":"function","title":"Plausible.Stats.QueryOptimizer.optimize/1","doc":"This module manipulates an existing query, updating it according to business logic.\n\n For example, it:\n 1. Figures out what the right granularity to group by time is\n 2. Adds a missing order_by clause to a query\n 3. Updating \"time\" dimension in order_by to the right granularity","ref":"Plausible.Stats.QueryOptimizer.html#optimize/1"},{"type":"function","title":"Plausible.Stats.QueryOptimizer.split/1","doc":"Splits a query into event and sessions subcomponents as not all metrics can be\nqueried from a single table.\n\nevent:page dimension is treated in a special way, doing a breakdown of visit:entry_page\nfor sessions.","ref":"Plausible.Stats.QueryOptimizer.html#split/1"},{"type":"module","title":"Plausible.Stats.QueryResult","doc":"This struct contains the (JSON-encodable) response for a query and\nis responsible for building it from database query results.\n\nFor the convenience of API docs and consumers, the JSON result\nproduced by Jason.encode(query_result) is ordered.","ref":"Plausible.Stats.QueryResult.html"},{"type":"function","title":"Plausible.Stats.QueryResult.from/3","doc":"","ref":"Plausible.Stats.QueryResult.html#from/3"},{"type":"module","title":"Plausible.Stats.SQL.Expression","doc":"This module is responsible for generating SQL/Ecto expressions\nfor dimensions and metrics used in query SELECT statement.\n\nEach dimension and metric is tagged with with selected_as for easier\nusage down the line.","ref":"Plausible.Stats.SQL.Expression.html"},{"type":"macro","title":"Plausible.Stats.SQL.Expression.event_goal_join/2","doc":"","ref":"Plausible.Stats.SQL.Expression.html#event_goal_join/2"},{"type":"function","title":"Plausible.Stats.SQL.Expression.event_metric/1","doc":"","ref":"Plausible.Stats.SQL.Expression.html#event_metric/1"},{"type":"function","title":"Plausible.Stats.SQL.Expression.select_dimension/5","doc":"","ref":"Plausible.Stats.SQL.Expression.html#select_dimension/5"},{"type":"function","title":"Plausible.Stats.SQL.Expression.session_metric/2","doc":"","ref":"Plausible.Stats.SQL.Expression.html#session_metric/2"},{"type":"module","title":"Plausible.Stats.SQL.Fragments","doc":"Various macros and common SQL fragments used in Stats code.","ref":"Plausible.Stats.SQL.Fragments.html"},{"type":"macro","title":"Plausible.Stats.SQL.Fragments.bounce_rate/0","doc":"","ref":"Plausible.Stats.SQL.Fragments.html#bounce_rate/0"},{"type":"macro","title":"Plausible.Stats.SQL.Fragments.coalesce_string/2","doc":"","ref":"Plausible.Stats.SQL.Fragments.html#coalesce_string/2"},{"type":"macro","title":"Plausible.Stats.SQL.Fragments.get_by_key/3","doc":"Returns value of a key (usually property) under `meta.value` array or similar.\n\nThis macro is used for operating on custom properties.\nCallsites should also check whether key exists first in SQL via `has_key` macro.","ref":"Plausible.Stats.SQL.Fragments.html#get_by_key/3"},{"type":"macro","title":"Examples - Plausible.Stats.SQL.Fragments.get_by_key/3","doc":"`get_by_key(e, :meta, \"some_property_name\")` expands to SQL `meta.value[indexOf(meta.key, \"some_property\")]`","ref":"Plausible.Stats.SQL.Fragments.html#get_by_key/3-examples"},{"type":"macro","title":"Plausible.Stats.SQL.Fragments.has_key/3","doc":"Returns whether a key (usually property) exists under `meta.key` array or similar.\n\nThis macro is used for operating on custom properties.","ref":"Plausible.Stats.SQL.Fragments.html#has_key/3"},{"type":"macro","title":"Examples - Plausible.Stats.SQL.Fragments.has_key/3","doc":"`has_key(e, :meta, \"some_property_name\")` expands to SQL `has(meta.key, \"some_property_name\")`","ref":"Plausible.Stats.SQL.Fragments.html#has_key/3-examples"},{"type":"function","title":"Plausible.Stats.SQL.Fragments.meta_key_column/1","doc":"","ref":"Plausible.Stats.SQL.Fragments.html#meta_key_column/1"},{"type":"function","title":"Plausible.Stats.SQL.Fragments.meta_value_column/1","doc":"","ref":"Plausible.Stats.SQL.Fragments.html#meta_value_column/1"},{"type":"macro","title":"Plausible.Stats.SQL.Fragments.sample_percent/0","doc":"","ref":"Plausible.Stats.SQL.Fragments.html#sample_percent/0"},{"type":"macro","title":"Plausible.Stats.SQL.Fragments.select_join_fields/4","doc":"Macro that helps join two Ecto queries by selecting fields from either one","ref":"Plausible.Stats.SQL.Fragments.html#select_join_fields/4"},{"type":"macro","title":"Plausible.Stats.SQL.Fragments.select_merge_as/3","doc":"Convenience Ecto macro for wrapping select_merge where each value gets in turn passed to selected_as.\n\n#","ref":"Plausible.Stats.SQL.Fragments.html#select_merge_as/3"},{"type":"macro","title":"Examples - Plausible.Stats.SQL.Fragments.select_merge_as/3","doc":"iex> select_merge_as(q, [t], %{ foo: t.column }) |> expand_macro_once\n \"select_merge(q, [], ^wrap_alias([t], %{foo: t.column}))\"","ref":"Plausible.Stats.SQL.Fragments.html#select_merge_as/3-examples"},{"type":"macro","title":"Plausible.Stats.SQL.Fragments.to_timezone/2","doc":"Converts time or date and time to the specified timezone.\n\nReference: https://clickhouse.com/docs/en/sql-reference/functions/date-time-functions/#totimezone","ref":"Plausible.Stats.SQL.Fragments.html#to_timezone/2"},{"type":"macro","title":"Plausible.Stats.SQL.Fragments.total/0","doc":"","ref":"Plausible.Stats.SQL.Fragments.html#total/0"},{"type":"macro","title":"Plausible.Stats.SQL.Fragments.uniq/1","doc":"","ref":"Plausible.Stats.SQL.Fragments.html#uniq/1"},{"type":"macro","title":"Plausible.Stats.SQL.Fragments.visit_duration/0","doc":"","ref":"Plausible.Stats.SQL.Fragments.html#visit_duration/0"},{"type":"macro","title":"Plausible.Stats.SQL.Fragments.weekstart_not_before/2","doc":"Returns the weekstart for `date`. If the weekstart is before the `not_before`\nboundary, `not_before` is returned.","ref":"Plausible.Stats.SQL.Fragments.html#weekstart_not_before/2"},{"type":"macro","title":"Examples - Plausible.Stats.SQL.Fragments.weekstart_not_before/2","doc":"In this pseudo-code example, the fragment returns the weekstart. The\n`not_before` boundary is set to the past Saturday, which is before the\nweekstart, therefore the cap does not apply.\n\n ```\n > this_wednesday = ~D[2022-11-09]\n > past_saturday = ~D[2022-11-05]\n > weekstart_not_before(this_wednesday, past_saturday)\n ~D[2022-11-07]\n ```\n\nIn this other example, the fragment returns Tuesday and not the weekstart.\nThe `not_before` boundary is set to Tuesday, which is past the weekstart,\ntherefore the cap applies.\n\n ```\n > this_wednesday = ~D[2022-11-09]\n > this_tuesday = ~D[2022-11-08]\n > weekstart_not_before(this_wednesday, this_tuesday)\n ~D[2022-11-08]\n ```","ref":"Plausible.Stats.SQL.Fragments.html#weekstart_not_before/2-examples"},{"type":"macro","title":"Plausible.Stats.SQL.Fragments.wrap_alias/2","doc":"Convenience Ecto macro for wrapping a map passed to select_merge_as such that each\nexpression gets wrapped in dynamic and set as selected_as.\n\n#","ref":"Plausible.Stats.SQL.Fragments.html#wrap_alias/2"},{"type":"macro","title":"Examples - Plausible.Stats.SQL.Fragments.wrap_alias/2","doc":"iex> wrap_alias([t], %{ foo: t.column }) |> expand_macro_once\n \"%{foo: dynamic([t], selected_as(t.column, :foo))}\"","ref":"Plausible.Stats.SQL.Fragments.html#wrap_alias/2-examples"},{"type":"module","title":"Plausible.Stats.SQL.SpecialMetrics","doc":"This module defines how special metrics like `conversion_rate` and\n`percentage` are calculated.","ref":"Plausible.Stats.SQL.SpecialMetrics.html"},{"type":"function","title":"Plausible.Stats.SQL.SpecialMetrics.add/3","doc":"","ref":"Plausible.Stats.SQL.SpecialMetrics.html#add/3"},{"type":"function","title":"Plausible.Stats.SQL.SpecialMetrics.maybe_add_global_conversion_rate/3","doc":"","ref":"Plausible.Stats.SQL.SpecialMetrics.html#maybe_add_global_conversion_rate/3"},{"type":"function","title":"Plausible.Stats.SQL.SpecialMetrics.maybe_add_group_conversion_rate/3","doc":"","ref":"Plausible.Stats.SQL.SpecialMetrics.html#maybe_add_group_conversion_rate/3"},{"type":"module","title":"Plausible.Stats.SQL.WhereBuilder","doc":"A module for building am ecto where clause of a query out of a query.","ref":"Plausible.Stats.SQL.WhereBuilder.html"},{"type":"function","title":"Plausible.Stats.SQL.WhereBuilder.build/3","doc":"Builds WHERE clause for a given Query against sessions or events table","ref":"Plausible.Stats.SQL.WhereBuilder.html#build/3"},{"type":"function","title":"Plausible.Stats.SQL.WhereBuilder.build_condition/2","doc":"Builds WHERE clause condition based off of a filter and a custom column name\nUsed for special business logic cases\n\nAccepts nil as the `filter` parameter, in which case the condition is a no-op (WHERE TRUE).","ref":"Plausible.Stats.SQL.WhereBuilder.html#build_condition/2"},{"type":"module","title":"Plausible.Stats.Sampling","doc":"Sampling related functions","ref":"Plausible.Stats.Sampling.html"},{"type":"function","title":"Plausible.Stats.Sampling.add_query_hint/1","doc":"","ref":"Plausible.Stats.Sampling.html#add_query_hint/1"},{"type":"function","title":"Plausible.Stats.Sampling.add_query_hint/2","doc":"","ref":"Plausible.Stats.Sampling.html#add_query_hint/2"},{"type":"function","title":"Plausible.Stats.Sampling.put_threshold/2","doc":"","ref":"Plausible.Stats.Sampling.html#put_threshold/2"},{"type":"module","title":"Plausible.Stats.TableDecider","doc":"This module contains logic for deciding which tables need to be queried given a query\nand metrics, with the purpose of reducing the number of queries and JOINs needed to perform.","ref":"Plausible.Stats.TableDecider.html"},{"type":"function","title":"Plausible.Stats.TableDecider.events_join_sessions?/1","doc":"","ref":"Plausible.Stats.TableDecider.html#events_join_sessions?/1"},{"type":"function","title":"Plausible.Stats.TableDecider.partition_metrics/2","doc":"","ref":"Plausible.Stats.TableDecider.html#partition_metrics/2"},{"type":"module","title":"Plausible.Stats.Time","doc":"Collection of functions to work with time in queries.","ref":"Plausible.Stats.Time.html"},{"type":"function","title":"Plausible.Stats.Time.format_datetime/1","doc":"","ref":"Plausible.Stats.Time.html#format_datetime/1"},{"type":"function","title":"Plausible.Stats.Time.time_dimension/1","doc":"Returns list of time bucket labels for the given query.","ref":"Plausible.Stats.Time.html#time_dimension/1"},{"type":"function","title":"Plausible.Stats.Time.time_labels/1","doc":"","ref":"Plausible.Stats.Time.html#time_labels/1"},{"type":"function","title":"Plausible.Stats.Time.utc_boundaries/2","doc":"","ref":"Plausible.Stats.Time.html#utc_boundaries/2"},{"type":"module","title":"Plausible.Stats.Timeseries","doc":"Builds timeseries results for v1 of our stats API and dashboards.\n\nAvoid adding new logic here - update QueryBuilder etc instead.","ref":"Plausible.Stats.Timeseries.html"},{"type":"function","title":"Plausible.Stats.Timeseries.timeseries/3","doc":"","ref":"Plausible.Stats.Timeseries.html#timeseries/3"},{"type":"module","title":"Plausible.Stats.Util","doc":"Utilities for modifying stat results","ref":"Plausible.Stats.Util.html"},{"type":"function","title":"Plausible.Stats.Util.keep_requested_metrics/2","doc":"Sometimes we need to manually add metrics in order to calculate the value for\nother metrics. E.g:\n\n* `__internal_visits` is fetched when querying bounce rate, visit duration,\n or views_per_visit, as it is needed to calculate these from imported data.\n\n* `visitors` metric might be added manually via `maybe_add_visitors_metric/1`,\n in order to be able to calculate conversion rate.\n\nThis function can be used for stripping those metrics from a breakdown (list),\nor an aggregate (map) result. We do not want to return metrics that we're not\nrequested.","ref":"Plausible.Stats.Util.html#keep_requested_metrics/2"},{"type":"function","title":"Plausible.Stats.Util.maybe_add_visitors_metric/1","doc":"This function adds the `visitors` metric into the list of\ngiven metrics if it's not already there and if it is needed\nfor any of the other metrics to be calculated.","ref":"Plausible.Stats.Util.html#maybe_add_visitors_metric/1"},{"type":"function","title":"Plausible.Stats.Util.shortname/2","doc":"","ref":"Plausible.Stats.Util.html#shortname/2"},{"type":"module","title":"Plausible.Test.Support.HTML","doc":"Floki wrappers to help make assertions about HTML/DOM structures","ref":"Plausible.Test.Support.HTML.html"},{"type":"function","title":"Plausible.Test.Support.HTML.class_of_element/2","doc":"","ref":"Plausible.Test.Support.HTML.html#class_of_element/2"},{"type":"function","title":"Plausible.Test.Support.HTML.element_exists?/2","doc":"","ref":"Plausible.Test.Support.HTML.html#element_exists?/2"},{"type":"function","title":"Plausible.Test.Support.HTML.find/2","doc":"","ref":"Plausible.Test.Support.HTML.html#find/2"},{"type":"function","title":"Plausible.Test.Support.HTML.form_exists?/2","doc":"","ref":"Plausible.Test.Support.HTML.html#form_exists?/2"},{"type":"function","title":"Plausible.Test.Support.HTML.name_of/1","doc":"","ref":"Plausible.Test.Support.HTML.html#name_of/1"},{"type":"function","title":"Plausible.Test.Support.HTML.submit_button/2","doc":"","ref":"Plausible.Test.Support.HTML.html#submit_button/2"},{"type":"function","title":"Plausible.Test.Support.HTML.text/1","doc":"","ref":"Plausible.Test.Support.HTML.html#text/1"},{"type":"function","title":"Plausible.Test.Support.HTML.text_of_attr/2","doc":"","ref":"Plausible.Test.Support.HTML.html#text_of_attr/2"},{"type":"function","title":"Plausible.Test.Support.HTML.text_of_attr/3","doc":"","ref":"Plausible.Test.Support.HTML.html#text_of_attr/3"},{"type":"function","title":"Plausible.Test.Support.HTML.text_of_element/2","doc":"","ref":"Plausible.Test.Support.HTML.html#text_of_element/2"},{"type":"module","title":"Plausible.Test.Support.HTTPMocker","doc":"Currently only supports post request, it's a drop-in replacement\nfor our exvcr usage that wasn't ever needed (e.g. we had no way to\nre-record the cassettes anyway).","ref":"Plausible.Test.Support.HTTPMocker.html"},{"type":"module","title":"Plausible.TestUtils","doc":"","ref":"Plausible.TestUtils.html"},{"type":"function","title":"Plausible.TestUtils.await_clickhouse_count/2","doc":"","ref":"Plausible.TestUtils.html#await_clickhouse_count/2"},{"type":"function","title":"Plausible.TestUtils.create_api_key/1","doc":"","ref":"Plausible.TestUtils.html#create_api_key/1"},{"type":"function","title":"Plausible.TestUtils.create_legacy_site_import/1","doc":"","ref":"Plausible.TestUtils.html#create_legacy_site_import/1"},{"type":"function","title":"Plausible.TestUtils.create_new_site/1","doc":"","ref":"Plausible.TestUtils.html#create_new_site/1"},{"type":"function","title":"Plausible.TestUtils.create_pageviews/1","doc":"","ref":"Plausible.TestUtils.html#create_pageviews/1"},{"type":"function","title":"Plausible.TestUtils.create_site/1","doc":"","ref":"Plausible.TestUtils.html#create_site/1"},{"type":"function","title":"Plausible.TestUtils.create_site_import/1","doc":"","ref":"Plausible.TestUtils.html#create_site_import/1"},{"type":"function","title":"Plausible.TestUtils.create_user/1","doc":"","ref":"Plausible.TestUtils.html#create_user/1"},{"type":"function","title":"Plausible.TestUtils.ensure_minio/0","doc":"","ref":"Plausible.TestUtils.html#ensure_minio/0"},{"type":"function","title":"Plausible.TestUtils.eventually/3","doc":"","ref":"Plausible.TestUtils.html#eventually/3"},{"type":"function","title":"Plausible.TestUtils.generate_usage_for/3","doc":"","ref":"Plausible.TestUtils.html#generate_usage_for/3"},{"type":"function","title":"Plausible.TestUtils.init_session/1","doc":"","ref":"Plausible.TestUtils.html#init_session/1"},{"type":"function","title":"Plausible.TestUtils.log_in/1","doc":"","ref":"Plausible.TestUtils.html#log_in/1"},{"type":"function","title":"Plausible.TestUtils.maybe_fake_minio/1","doc":"","ref":"Plausible.TestUtils.html#maybe_fake_minio/1"},{"type":"function","title":"Plausible.TestUtils.minio_running?/0","doc":"","ref":"Plausible.TestUtils.html#minio_running?/0"},{"type":"macro","title":"Plausible.TestUtils.patch_env/2","doc":"","ref":"Plausible.TestUtils.html#patch_env/2"},{"type":"function","title":"Plausible.TestUtils.populate_stats/1","doc":"","ref":"Plausible.TestUtils.html#populate_stats/1"},{"type":"function","title":"Plausible.TestUtils.populate_stats/2","doc":"","ref":"Plausible.TestUtils.html#populate_stats/2"},{"type":"function","title":"Plausible.TestUtils.populate_stats/3","doc":"","ref":"Plausible.TestUtils.html#populate_stats/3"},{"type":"function","title":"Plausible.TestUtils.random_ip/0","doc":"","ref":"Plausible.TestUtils.html#random_ip/0"},{"type":"function","title":"Plausible.TestUtils.relative_time/1","doc":"","ref":"Plausible.TestUtils.html#relative_time/1"},{"type":"macro","title":"Plausible.TestUtils.setup_patch_env/2","doc":"","ref":"Plausible.TestUtils.html#setup_patch_env/2"},{"type":"function","title":"Plausible.TestUtils.to_naive_truncate/1","doc":"","ref":"Plausible.TestUtils.html#to_naive_truncate/1"},{"type":"function","title":"Plausible.TestUtils.use_api_key/1","doc":"","ref":"Plausible.TestUtils.html#use_api_key/1"},{"type":"module","title":"Plausible.Themes","doc":"","ref":"Plausible.Themes.html"},{"type":"function","title":"Plausible.Themes.options/0","doc":"","ref":"Plausible.Themes.html#options/0"},{"type":"module","title":"Plausible.Timezones","doc":"","ref":"Plausible.Timezones.html"},{"type":"function","title":"Plausible.Timezones.options/1","doc":"","ref":"Plausible.Timezones.html#options/1"},{"type":"function","title":"Plausible.Timezones.to_date_in_timezone/2","doc":"","ref":"Plausible.Timezones.html#to_date_in_timezone/2"},{"type":"function","title":"Plausible.Timezones.to_datetime_in_timezone/2","doc":"","ref":"Plausible.Timezones.html#to_datetime_in_timezone/2"},{"type":"function","title":"Plausible.Timezones.to_utc_datetime/2","doc":"","ref":"Plausible.Timezones.html#to_utc_datetime/2"},{"type":"module","title":"Plausible.Users","doc":"User context","ref":"Plausible.Users.html"},{"type":"function","title":"Plausible.Users.accept_traffic_until/1","doc":"","ref":"Plausible.Users.html#accept_traffic_until/1"},{"type":"function","title":"Plausible.Users.allow_next_upgrade_override/1","doc":"","ref":"Plausible.Users.html#allow_next_upgrade_override/1"},{"type":"function","title":"Plausible.Users.has_email_code?/1","doc":"","ref":"Plausible.Users.html#has_email_code?/1"},{"type":"function","title":"Plausible.Users.maybe_reset_next_upgrade_override/1","doc":"","ref":"Plausible.Users.html#maybe_reset_next_upgrade_override/1"},{"type":"function","title":"Plausible.Users.on_trial?/1","doc":"","ref":"Plausible.Users.html#on_trial?/1"},{"type":"function","title":"Plausible.Users.trial_days_left/1","doc":"","ref":"Plausible.Users.html#trial_days_left/1"},{"type":"function","title":"Plausible.Users.update_accept_traffic_until/1","doc":"","ref":"Plausible.Users.html#update_accept_traffic_until/1"},{"type":"function","title":"Plausible.Users.with_subscription/1","doc":"","ref":"Plausible.Users.html#with_subscription/1"},{"type":"module","title":"Plausible.Verification","doc":"Module defining the user-agent used for site verification.","ref":"Plausible.Verification.html"},{"type":"function","title":"Plausible.Verification.enabled?/0","doc":"","ref":"Plausible.Verification.html#enabled?/0"},{"type":"function","title":"Plausible.Verification.user_agent/0","doc":"","ref":"Plausible.Verification.html#user_agent/0"},{"type":"behaviour","title":"Plausible.Verification.Check","doc":"Behaviour to be implemented by specific site verification checks.\n`report_progress_as()` doesn't necessarily reflect the actual check description,\nit serves as a user-facing message grouping mechanism, to prevent frequent message flashing when checks rotate often.\nEach check operates on `state()` and is expected to return it, optionally modified, by all means.\n`perform_safe/1` is used to guarantee no exceptions are thrown by faulty implementations, not to interrupt LiveView.","ref":"Plausible.Verification.Check.html"},{"type":"callback","title":"Plausible.Verification.Check.perform/1","doc":"","ref":"Plausible.Verification.Check.html#c:perform/1"},{"type":"callback","title":"Plausible.Verification.Check.report_progress_as/0","doc":"","ref":"Plausible.Verification.Check.html#c:report_progress_as/0"},{"type":"type","title":"Plausible.Verification.Check.state/0","doc":"","ref":"Plausible.Verification.Check.html#t:state/0"},{"type":"module","title":"Plausible.Verification.Checks","doc":"Checks that are performed during site verification.\nEach module defined in `@checks` implements the `Plausible.Verification.Check` behaviour.\nChecks are normally run asynchronously, except when synchronous execution is optionally required\nfor tests. Slowdowns can be optionally added, the user doesn't benefit from running the checks too quickly.\n\nIn async execution, each check notifies the caller by sending a message to it.","ref":"Plausible.Verification.Checks.html"},{"type":"function","title":"Plausible.Verification.Checks.interpret_diagnostics/1","doc":"","ref":"Plausible.Verification.Checks.html#interpret_diagnostics/1"},{"type":"function","title":"Plausible.Verification.Checks.run/3","doc":"","ref":"Plausible.Verification.Checks.html#run/3"},{"type":"module","title":"Plausible.Verification.Checks.CSP","doc":"Scans the Content Security Policy header to ensure that the Plausible domain is allowed.\nSee `Plausible.Verification.Checks` for the execution sequence.","ref":"Plausible.Verification.Checks.CSP.html"},{"type":"function","title":"Plausible.Verification.Checks.CSP.perform_safe/1","doc":"","ref":"Plausible.Verification.Checks.CSP.html#perform_safe/1"},{"type":"module","title":"Plausible.Verification.Checks.FetchBody","doc":"Fetches the body of the site and extracts the HTML document, if available, for\nfurther processing.\nSee `Plausible.Verification.Checks` for the execution sequence.","ref":"Plausible.Verification.Checks.FetchBody.html"},{"type":"function","title":"Plausible.Verification.Checks.FetchBody.perform_safe/1","doc":"","ref":"Plausible.Verification.Checks.FetchBody.html#perform_safe/1"},{"type":"module","title":"Plausible.Verification.Checks.Installation","doc":"Calls the browserless.io service (local instance can be spawned with `make browserless`)\nand runs verification/verify_plausible_installed.js via the [function API](https://docs.browserless.io/HTTP-APIs/function).\n\nThe successful execution assumes the following JSON payload:\n - `data.plausibleInstalled` - boolean indicating whether the `plausible()` window function was found\n - `data.callbackStatus` - integer. 202 indicates that the server acknowledged the test event.\n\nThe test event ingestion is discarded based on user-agent, see: `Plausible.Verification.user_agent/0`","ref":"Plausible.Verification.Checks.Installation.html"},{"type":"function","title":"Plausible.Verification.Checks.Installation.perform_safe/1","doc":"","ref":"Plausible.Verification.Checks.Installation.html#perform_safe/1"},{"type":"module","title":"Plausible.Verification.Checks.ScanBody","doc":"Naive way of detecting GTM and WordPress powered sites.","ref":"Plausible.Verification.Checks.ScanBody.html"},{"type":"function","title":"Plausible.Verification.Checks.ScanBody.perform_safe/1","doc":"","ref":"Plausible.Verification.Checks.ScanBody.html#perform_safe/1"},{"type":"module","title":"Plausible.Verification.Checks.Snippet","doc":"The check looks for Plausible snippets and tries to address the common\nintegration issues, such as bad placement, data-domain typos, unknown \nattributes frequently added by performance optimization plugins, etc.","ref":"Plausible.Verification.Checks.Snippet.html"},{"type":"function","title":"Plausible.Verification.Checks.Snippet.perform_safe/1","doc":"","ref":"Plausible.Verification.Checks.Snippet.html#perform_safe/1"},{"type":"module","title":"Plausible.Verification.Checks.SnippetCacheBust","doc":"A naive way of trying to figure out whether the latest site contents \nis wrapped with some CDN/caching layer.\nIn case no snippets were found, we'll try to bust the cache by appending a random query parameter\nand re-run `Plausible.Verification.Checks.FetchBody` and `Plausible.Verification.Checks.Snippet` checks.\nIf the result is different this time, we'll assume cache likely.","ref":"Plausible.Verification.Checks.SnippetCacheBust.html"},{"type":"function","title":"Plausible.Verification.Checks.SnippetCacheBust.perform_safe/1","doc":"","ref":"Plausible.Verification.Checks.SnippetCacheBust.html#perform_safe/1"},{"type":"module","title":"Plausible.Verification.Diagnostics","doc":"Module responsible for translating diagnostics to user-friendly errors and recommendations.","ref":"Plausible.Verification.Diagnostics.html"},{"type":"function","title":"Plausible.Verification.Diagnostics.interpret/2","doc":"","ref":"Plausible.Verification.Diagnostics.html#interpret/2"},{"type":"type","title":"Plausible.Verification.Diagnostics.t/0","doc":"","ref":"Plausible.Verification.Diagnostics.html#t:t/0"},{"type":"module","title":"Plausible.Verification.Diagnostics.Result","doc":"Diagnostics interpretation result.","ref":"Plausible.Verification.Diagnostics.Result.html"},{"type":"type","title":"Plausible.Verification.Diagnostics.Result.t/0","doc":"","ref":"Plausible.Verification.Diagnostics.Result.html#t:t/0"},{"type":"module","title":"Plausible.Verification.Errors","doc":"A go-to definition of all verification errors","ref":"Plausible.Verification.Errors.html"},{"type":"function","title":"Plausible.Verification.Errors.all/0","doc":"","ref":"Plausible.Verification.Errors.html#all/0"},{"type":"module","title":"Plausible.Verification.State","doc":"The struct and interface describing the state of the site verification process.\nAssigns are meant to be used to communicate between checks, while diagnostics\nare later on interpreted (translated into user-friendly messages and recommendations)\nvia `Plausible.Verification.Diagnostics` module.","ref":"Plausible.Verification.State.html"},{"type":"function","title":"Plausible.Verification.State.assign/2","doc":"","ref":"Plausible.Verification.State.html#assign/2"},{"type":"function","title":"Plausible.Verification.State.put_diagnostics/2","doc":"","ref":"Plausible.Verification.State.html#put_diagnostics/2"},{"type":"type","title":"Plausible.Verification.State.t/0","doc":"","ref":"Plausible.Verification.State.html#t:t/0"},{"type":"module","title":"Plausible.Verification.URL","doc":"Busting some caches by appending ?plausible_verification=12345 to it.","ref":"Plausible.Verification.URL.html"},{"type":"function","title":"Plausible.Verification.URL.bust_url/1","doc":"","ref":"Plausible.Verification.URL.html#bust_url/1"},{"type":"module","title":"Plausible.Workers.AcceptTrafficUntil","doc":"A worker meant to be run once a day that sends out e-mail notifications to site\nowners assuming:\n - their sites still receive traffic (i.e. have stats for yesterday)\n - `site.accept_traffic_until` is approaching either tomorrow or exactly in 7 days\n\nUsers having no sites or sites that receive no traffic, won't be notified.\nWe make a tiny effort here to make sure we send the same notification at most once a day.","ref":"Plausible.Workers.AcceptTrafficUntil.html"},{"type":"function","title":"Plausible.Workers.AcceptTrafficUntil.dry_run/1","doc":"","ref":"Plausible.Workers.AcceptTrafficUntil.html#dry_run/1"},{"type":"module","title":"Plausible.Workers.CheckUsage","doc":"","ref":"Plausible.Workers.CheckUsage.html"},{"type":"function","title":"Plausible.Workers.CheckUsage.check_enterprise_subscriber/2","doc":"","ref":"Plausible.Workers.CheckUsage.html#check_enterprise_subscriber/2"},{"type":"macro","title":"Plausible.Workers.CheckUsage.day_of_month/1","doc":"","ref":"Plausible.Workers.CheckUsage.html#day_of_month/1"},{"type":"macro","title":"Plausible.Workers.CheckUsage.last_day_of_month/1","doc":"","ref":"Plausible.Workers.CheckUsage.html#last_day_of_month/1"},{"type":"macro","title":"Plausible.Workers.CheckUsage.least/2","doc":"","ref":"Plausible.Workers.CheckUsage.html#least/2"},{"type":"function","title":"Plausible.Workers.CheckUsage.maybe_remove_grace_period/2","doc":"","ref":"Plausible.Workers.CheckUsage.html#maybe_remove_grace_period/2"},{"type":"macro","title":"Plausible.Workers.CheckUsage.yesterday/0","doc":"","ref":"Plausible.Workers.CheckUsage.html#yesterday/0"},{"type":"module","title":"Plausible.Workers.CleanInvitations","doc":"","ref":"Plausible.Workers.CleanInvitations.html"},{"type":"module","title":"Plausible.Workers.ClickhouseCleanSites","doc":"Cleans deleted site data from ClickHouse asynchronously.\n\nWe batch up data deletions from ClickHouse as deleting a single site is\njust as expensive as deleting many.","ref":"Plausible.Workers.ClickhouseCleanSites.html"},{"type":"function","title":"Plausible.Workers.ClickhouseCleanSites.get_deleted_sites_with_clickhouse_data/0","doc":"","ref":"Plausible.Workers.ClickhouseCleanSites.html#get_deleted_sites_with_clickhouse_data/0"},{"type":"function","title":"Plausible.Workers.ClickhouseCleanSites.perform/1","doc":"","ref":"Plausible.Workers.ClickhouseCleanSites.html#perform/1"},{"type":"module","title":"Plausible.Workers.ExpireDomainChangeTransitions","doc":"Periodic worker that expires domain change transition period.\nOld domains are frozen for a given time, so users can still access them\nbefore redeploying their scripts and integrations.","ref":"Plausible.Workers.ExpireDomainChangeTransitions.html"},{"type":"module","title":"Plausible.Workers.ExportAnalytics","doc":"Worker for running CSV export jobs. Supports S3 and local storage.\nTo avoid blocking the queue, a timeout of 15 minutes is enforced.","ref":"Plausible.Workers.ExportAnalytics.html"},{"type":"function","title":"Plausible.Workers.ExportAnalytics.base_query/1","doc":"This base query filters export jobs for a site","ref":"Plausible.Workers.ExportAnalytics.html#base_query/1"},{"type":"module","title":"Plausible.Workers.ImportAnalytics","doc":"Worker for running analytics import jobs.","ref":"Plausible.Workers.ImportAnalytics.html"},{"type":"function","title":"Plausible.Workers.ImportAnalytics.import_complete/1","doc":"","ref":"Plausible.Workers.ImportAnalytics.html#import_complete/1"},{"type":"function","title":"Plausible.Workers.ImportAnalytics.import_fail/2","doc":"","ref":"Plausible.Workers.ImportAnalytics.html#import_fail/2"},{"type":"function","title":"Plausible.Workers.ImportAnalytics.import_fail_transient/1","doc":"","ref":"Plausible.Workers.ImportAnalytics.html#import_fail_transient/1"},{"type":"module","title":"Plausible.Workers.LocalImportAnalyticsCleaner","doc":"Worker for cleaning local files left after analytics import jobs.","ref":"Plausible.Workers.LocalImportAnalyticsCleaner.html"},{"type":"module","title":"Plausible.Workers.LockSites","doc":"","ref":"Plausible.Workers.LockSites.html"},{"type":"module","title":"Plausible.Workers.NotifyAnnualRenewal","doc":"","ref":"Plausible.Workers.NotifyAnnualRenewal.html"},{"type":"function","title":"Plausible.Workers.NotifyAnnualRenewal.perform/1","doc":"Sends a notification at most 7 days and at least 1 day before the renewal of an annual subscription","ref":"Plausible.Workers.NotifyAnnualRenewal.html#perform/1"},{"type":"module","title":"Plausible.Workers.NotifyExportedAnalytics","doc":"This worker delivers emails for successful and failed exports","ref":"Plausible.Workers.NotifyExportedAnalytics.html"},{"type":"module","title":"Plausible.Workers.RotateSalts","doc":"","ref":"Plausible.Workers.RotateSalts.html"},{"type":"module","title":"Plausible.Workers.ScheduleEmailReports","doc":"","ref":"Plausible.Workers.ScheduleEmailReports.html"},{"type":"function","title":"Plausible.Workers.ScheduleEmailReports.first_of_month_9am/1","doc":"","ref":"Plausible.Workers.ScheduleEmailReports.html#first_of_month_9am/1"},{"type":"function","title":"Plausible.Workers.ScheduleEmailReports.monday_9am/1","doc":"","ref":"Plausible.Workers.ScheduleEmailReports.html#monday_9am/1"},{"type":"function","title":"Plausible.Workers.ScheduleEmailReports.perform/1","doc":"Email reports should be sent on Monday at 9am according to the timezone\nof a site. This job runs every day at midnight to ensure that all sites\nhave a scheduled job for email reports.","ref":"Plausible.Workers.ScheduleEmailReports.html#perform/1"},{"type":"module","title":"Plausible.Workers.SendCheckStatsEmails","doc":"","ref":"Plausible.Workers.SendCheckStatsEmails.html"},{"type":"module","title":"Plausible.Workers.SendEmailReport","doc":"","ref":"Plausible.Workers.SendEmailReport.html"},{"type":"module","title":"Plausible.Workers.SendSiteSetupEmails","doc":"","ref":"Plausible.Workers.SendSiteSetupEmails.html"},{"type":"module","title":"Plausible.Workers.SendTrialNotifications","doc":"","ref":"Plausible.Workers.SendTrialNotifications.html"},{"type":"module","title":"Plausible.Workers.TrafficChangeNotifier","doc":"Oban service sending out traffic drop/spike notifications","ref":"Plausible.Workers.TrafficChangeNotifier.html"},{"type":"module","title":"PlausibleWeb","doc":"","ref":"PlausibleWeb.html"},{"type":"macro","title":"PlausibleWeb.__using__/1","doc":"When used, dispatch to the appropriate controller/view/etc.","ref":"PlausibleWeb.html#__using__/1"},{"type":"function","title":"PlausibleWeb.channel/0","doc":"","ref":"PlausibleWeb.html#channel/0"},{"type":"function","title":"PlausibleWeb.controller/0","doc":"","ref":"PlausibleWeb.html#controller/0"},{"type":"function","title":"PlausibleWeb.live_view/1","doc":"","ref":"PlausibleWeb.html#live_view/1"},{"type":"function","title":"PlausibleWeb.open_api_schema/0","doc":"","ref":"PlausibleWeb.html#open_api_schema/0"},{"type":"function","title":"PlausibleWeb.plugins_api_controller/0","doc":"","ref":"PlausibleWeb.html#plugins_api_controller/0"},{"type":"function","title":"PlausibleWeb.plugins_api_view/0","doc":"","ref":"PlausibleWeb.html#plugins_api_view/0"},{"type":"function","title":"PlausibleWeb.router/0","doc":"","ref":"PlausibleWeb.html#router/0"},{"type":"function","title":"PlausibleWeb.view/0","doc":"","ref":"PlausibleWeb.html#view/0"},{"type":"module","title":"PlausibleWeb.AdminController","doc":"","ref":"PlausibleWeb.AdminController.html"},{"type":"function","title":"PlausibleWeb.AdminController.current_plan/2","doc":"","ref":"PlausibleWeb.AdminController.html#current_plan/2"},{"type":"function","title":"PlausibleWeb.AdminController.usage/2","doc":"","ref":"PlausibleWeb.AdminController.html#usage/2"},{"type":"module","title":"PlausibleWeb.Api.ExternalController","doc":"","ref":"PlausibleWeb.Api.ExternalController.html"},{"type":"function","title":"PlausibleWeb.Api.ExternalController.error/2","doc":"","ref":"PlausibleWeb.Api.ExternalController.html#error/2"},{"type":"function","title":"PlausibleWeb.Api.ExternalController.event/2","doc":"","ref":"PlausibleWeb.Api.ExternalController.html#event/2"},{"type":"function","title":"PlausibleWeb.Api.ExternalController.health/2","doc":"","ref":"PlausibleWeb.Api.ExternalController.html#health/2"},{"type":"function","title":"PlausibleWeb.Api.ExternalController.info/2","doc":"","ref":"PlausibleWeb.Api.ExternalController.html#info/2"},{"type":"module","title":"PlausibleWeb.Api.ExternalSitesController","doc":"","ref":"PlausibleWeb.Api.ExternalSitesController.html"},{"type":"function","title":"PlausibleWeb.Api.ExternalSitesController.create_site/2","doc":"","ref":"PlausibleWeb.Api.ExternalSitesController.html#create_site/2"},{"type":"function","title":"PlausibleWeb.Api.ExternalSitesController.delete_goal/2","doc":"","ref":"PlausibleWeb.Api.ExternalSitesController.html#delete_goal/2"},{"type":"function","title":"PlausibleWeb.Api.ExternalSitesController.delete_site/2","doc":"","ref":"PlausibleWeb.Api.ExternalSitesController.html#delete_site/2"},{"type":"function","title":"PlausibleWeb.Api.ExternalSitesController.find_or_create_goal/2","doc":"","ref":"PlausibleWeb.Api.ExternalSitesController.html#find_or_create_goal/2"},{"type":"function","title":"PlausibleWeb.Api.ExternalSitesController.find_or_create_shared_link/2","doc":"","ref":"PlausibleWeb.Api.ExternalSitesController.html#find_or_create_shared_link/2"},{"type":"function","title":"PlausibleWeb.Api.ExternalSitesController.get_site/2","doc":"","ref":"PlausibleWeb.Api.ExternalSitesController.html#get_site/2"},{"type":"function","title":"PlausibleWeb.Api.ExternalSitesController.goals_index/2","doc":"","ref":"PlausibleWeb.Api.ExternalSitesController.html#goals_index/2"},{"type":"function","title":"PlausibleWeb.Api.ExternalSitesController.index/2","doc":"","ref":"PlausibleWeb.Api.ExternalSitesController.html#index/2"},{"type":"function","title":"PlausibleWeb.Api.ExternalSitesController.update_site/2","doc":"","ref":"PlausibleWeb.Api.ExternalSitesController.html#update_site/2"},{"type":"module","title":"PlausibleWeb.Api.ExternalStatsController","doc":"","ref":"PlausibleWeb.Api.ExternalStatsController.html"},{"type":"function","title":"PlausibleWeb.Api.ExternalStatsController.aggregate/2","doc":"","ref":"PlausibleWeb.Api.ExternalStatsController.html#aggregate/2"},{"type":"function","title":"PlausibleWeb.Api.ExternalStatsController.breakdown/2","doc":"","ref":"PlausibleWeb.Api.ExternalStatsController.html#breakdown/2"},{"type":"function","title":"PlausibleWeb.Api.ExternalStatsController.realtime_visitors/2","doc":"","ref":"PlausibleWeb.Api.ExternalStatsController.html#realtime_visitors/2"},{"type":"function","title":"PlausibleWeb.Api.ExternalStatsController.timeseries/2","doc":"","ref":"PlausibleWeb.Api.ExternalStatsController.html#timeseries/2"},{"type":"module","title":"PlausibleWeb.Api.Helpers","doc":"","ref":"PlausibleWeb.Api.Helpers.html"},{"type":"function","title":"PlausibleWeb.Api.Helpers.bad_request/2","doc":"","ref":"PlausibleWeb.Api.Helpers.html#bad_request/2"},{"type":"function","title":"PlausibleWeb.Api.Helpers.not_found/2","doc":"","ref":"PlausibleWeb.Api.Helpers.html#not_found/2"},{"type":"function","title":"PlausibleWeb.Api.Helpers.payment_required/2","doc":"","ref":"PlausibleWeb.Api.Helpers.html#payment_required/2"},{"type":"function","title":"PlausibleWeb.Api.Helpers.too_many_requests/2","doc":"","ref":"PlausibleWeb.Api.Helpers.html#too_many_requests/2"},{"type":"function","title":"PlausibleWeb.Api.Helpers.unauthorized/2","doc":"","ref":"PlausibleWeb.Api.Helpers.html#unauthorized/2"},{"type":"module","title":"PlausibleWeb.Api.InternalController","doc":"","ref":"PlausibleWeb.Api.InternalController.html"},{"type":"function","title":"PlausibleWeb.Api.InternalController.disable_feature/2","doc":"","ref":"PlausibleWeb.Api.InternalController.html#disable_feature/2"},{"type":"function","title":"PlausibleWeb.Api.InternalController.domain_status/2","doc":"","ref":"PlausibleWeb.Api.InternalController.html#domain_status/2"},{"type":"function","title":"PlausibleWeb.Api.InternalController.sites/2","doc":"","ref":"PlausibleWeb.Api.InternalController.html#sites/2"},{"type":"module","title":"PlausibleWeb.Api.PaddleController","doc":"","ref":"PlausibleWeb.Api.PaddleController.html"},{"type":"function","title":"PlausibleWeb.Api.PaddleController.currency/2","doc":"","ref":"PlausibleWeb.Api.PaddleController.html#currency/2"},{"type":"function","title":"PlausibleWeb.Api.PaddleController.verify_signature/2","doc":"","ref":"PlausibleWeb.Api.PaddleController.html#verify_signature/2"},{"type":"function","title":"PlausibleWeb.Api.PaddleController.webhook/2","doc":"","ref":"PlausibleWeb.Api.PaddleController.html#webhook/2"},{"type":"module","title":"PlausibleWeb.Api.StatsController","doc":"","ref":"PlausibleWeb.Api.StatsController.html"},{"type":"function","title":"PlausibleWeb.Api.StatsController.all_custom_prop_values/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#all_custom_prop_values/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.browser_versions/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#browser_versions/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.browsers/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#browsers/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.build_intervals/4","doc":"","ref":"PlausibleWeb.Api.StatsController.html#build_intervals/4"},{"type":"function","title":"PlausibleWeb.Api.StatsController.cities/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#cities/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.conversions/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#conversions/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.countries/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#countries/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.current_visitors/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#current_visitors/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.custom_prop_values/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#custom_prop_values/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.entry_pages/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#entry_pages/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.exit_pages/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#exit_pages/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.filter_suggestions/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#filter_suggestions/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.format_money/1","doc":"","ref":"PlausibleWeb.Api.StatsController.html#format_money/1"},{"type":"function","title":"PlausibleWeb.Api.StatsController.format_revenue_metric/1","doc":"","ref":"PlausibleWeb.Api.StatsController.html#format_revenue_metric/1"},{"type":"function","title":"PlausibleWeb.Api.StatsController.funnel/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#funnel/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.main_graph/2","doc":"Returns a time-series based on given parameters.","ref":"PlausibleWeb.Api.StatsController.html#main_graph/2"},{"type":"function","title":"Parameters - PlausibleWeb.Api.StatsController.main_graph/2","doc":"This API accepts the following parameters:\n\n * `period` - x-axis of the graph, e.g. `12mo`, `day`, `custom`.\n\n * `metric` - y-axis of the graph, e.g. `visits`, `visitors`, `pageviews`.\n See the Stats API [\"Metrics\"](https://plausible.io/docs/stats-api#metrics)\n section for more details. Defaults to `visitors`.\n\n * `interval` - granularity of the time-series data. You can think of it as\n a `GROUP BY` clause. Possible values are `minute`, `hour`, `date`, `week`,\n and `month`. The default depends on the `period` parameter. Check\n `Plausible.Query.from/2` for each default.\n\n * `filters` - optional filters to drill down data. See the Stats API\n [\"Filtering\"](https://plausible.io/docs/stats-api#filtering) section for\n more details.\n\n * `with_imported` - boolean indicating whether to include Google Analytics\n imported data or not. Defaults to `false`.\n\nFull example:\n```elixir\n%{\n \"from\" => \"2021-09-06\",\n \"interval\" => \"month\",\n \"metric\" => \"visitors\",\n \"period\" => \"custom\",\n \"to\" => \"2021-12-13\"\n}\n```","ref":"PlausibleWeb.Api.StatsController.html#main_graph/2-parameters"},{"type":"function","title":"Response - PlausibleWeb.Api.StatsController.main_graph/2","doc":"Returns a map with the following keys:\n\n * `plot` - list of values for the requested metric representing the y-axis\n of the graph.\n\n * `labels` - list of date times representing the x-axis of the graph.\n\n * `present_index` - index of the element representing the current date in\n `labels` and `plot` lists.\n\n * `interval` - the interval used for querying.\n\n * `includes_imported` - boolean indicating whether imported data\n was queried or not.\n\n * `imports_exist` - boolean indicating whether there are any completed\n imports for a given site or not.\n\n * `full_intervals` - map of dates indicating whether the interval has been\n cut off by the requested date range or not. For example, if looking at a\n month week-by-week, some weeks may be cut off by the month boundaries.\n It's useful to adjust the graph display slightly in case the interval is\n not 'full' so that the user understands why the numbers might be lower for\n those partial periods.\n\nFull example:\n```elixir\n%{\n \"full_intervals\" => %{\n \"2021-09-01\" => false,\n \"2021-10-01\" => true,\n \"2021-11-01\" => true,\n \"2021-12-01\" => false\n },\n \"imports_exist\" => false,\n \"interval\" => \"month\",\n \"labels\" => [\"2021-09-01\", \"2021-10-01\", \"2021-11-01\", \"2021-12-01\"],\n \"plot\" => [0, 0, 0, 0],\n \"present_index\" => nil,\n \"includes_imported\" => false\n}\n```","ref":"PlausibleWeb.Api.StatsController.html#main_graph/2-response"},{"type":"function","title":"PlausibleWeb.Api.StatsController.operating_system_versions/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#operating_system_versions/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.operating_systems/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#operating_systems/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.pages/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#pages/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.put_combined_name_with_version/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#put_combined_name_with_version/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.referrer_drilldown/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#referrer_drilldown/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.referrers/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#referrers/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.regions/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#regions/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.screen_sizes/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#screen_sizes/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.sources/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#sources/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.top_stats/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#top_stats/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.utm_campaigns/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#utm_campaigns/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.utm_contents/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#utm_contents/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.utm_mediums/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#utm_mediums/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.utm_sources/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#utm_sources/2"},{"type":"function","title":"PlausibleWeb.Api.StatsController.utm_terms/2","doc":"","ref":"PlausibleWeb.Api.StatsController.html#utm_terms/2"},{"type":"module","title":"PlausibleWeb.AuthController","doc":"","ref":"PlausibleWeb.AuthController.html"},{"type":"function","title":"PlausibleWeb.AuthController.activate/2","doc":"","ref":"PlausibleWeb.AuthController.html#activate/2"},{"type":"function","title":"PlausibleWeb.AuthController.activate_form/2","doc":"","ref":"PlausibleWeb.AuthController.html#activate_form/2"},{"type":"function","title":"PlausibleWeb.AuthController.cancel_update_email/2","doc":"","ref":"PlausibleWeb.AuthController.html#cancel_update_email/2"},{"type":"function","title":"PlausibleWeb.AuthController.create_api_key/2","doc":"","ref":"PlausibleWeb.AuthController.html#create_api_key/2"},{"type":"function","title":"PlausibleWeb.AuthController.delete_api_key/2","doc":"","ref":"PlausibleWeb.AuthController.html#delete_api_key/2"},{"type":"function","title":"PlausibleWeb.AuthController.delete_me/2","doc":"","ref":"PlausibleWeb.AuthController.html#delete_me/2"},{"type":"function","title":"PlausibleWeb.AuthController.disable_2fa/2","doc":"","ref":"PlausibleWeb.AuthController.html#disable_2fa/2"},{"type":"function","title":"PlausibleWeb.AuthController.generate_2fa_recovery_codes/2","doc":"","ref":"PlausibleWeb.AuthController.html#generate_2fa_recovery_codes/2"},{"type":"function","title":"PlausibleWeb.AuthController.google_auth_callback/2","doc":"","ref":"PlausibleWeb.AuthController.html#google_auth_callback/2"},{"type":"function","title":"PlausibleWeb.AuthController.initiate_2fa_setup/2","doc":"","ref":"PlausibleWeb.AuthController.html#initiate_2fa_setup/2"},{"type":"function","title":"PlausibleWeb.AuthController.login/2","doc":"","ref":"PlausibleWeb.AuthController.html#login/2"},{"type":"function","title":"PlausibleWeb.AuthController.login_form/2","doc":"","ref":"PlausibleWeb.AuthController.html#login_form/2"},{"type":"function","title":"PlausibleWeb.AuthController.logout/2","doc":"","ref":"PlausibleWeb.AuthController.html#logout/2"},{"type":"function","title":"PlausibleWeb.AuthController.new_api_key/2","doc":"","ref":"PlausibleWeb.AuthController.html#new_api_key/2"},{"type":"function","title":"PlausibleWeb.AuthController.password_reset/2","doc":"","ref":"PlausibleWeb.AuthController.html#password_reset/2"},{"type":"function","title":"PlausibleWeb.AuthController.password_reset_form/2","doc":"","ref":"PlausibleWeb.AuthController.html#password_reset_form/2"},{"type":"function","title":"PlausibleWeb.AuthController.password_reset_request/2","doc":"","ref":"PlausibleWeb.AuthController.html#password_reset_request/2"},{"type":"function","title":"PlausibleWeb.AuthController.password_reset_request_form/2","doc":"","ref":"PlausibleWeb.AuthController.html#password_reset_request_form/2"},{"type":"function","title":"PlausibleWeb.AuthController.request_activation_code/2","doc":"","ref":"PlausibleWeb.AuthController.html#request_activation_code/2"},{"type":"function","title":"PlausibleWeb.AuthController.save_settings/2","doc":"","ref":"PlausibleWeb.AuthController.html#save_settings/2"},{"type":"function","title":"PlausibleWeb.AuthController.update_email/2","doc":"","ref":"PlausibleWeb.AuthController.html#update_email/2"},{"type":"function","title":"PlausibleWeb.AuthController.user_settings/2","doc":"","ref":"PlausibleWeb.AuthController.html#user_settings/2"},{"type":"function","title":"PlausibleWeb.AuthController.verify_2fa/2","doc":"","ref":"PlausibleWeb.AuthController.html#verify_2fa/2"},{"type":"function","title":"PlausibleWeb.AuthController.verify_2fa_form/2","doc":"","ref":"PlausibleWeb.AuthController.html#verify_2fa_form/2"},{"type":"function","title":"PlausibleWeb.AuthController.verify_2fa_recovery_code/2","doc":"","ref":"PlausibleWeb.AuthController.html#verify_2fa_recovery_code/2"},{"type":"function","title":"PlausibleWeb.AuthController.verify_2fa_recovery_code_form/2","doc":"","ref":"PlausibleWeb.AuthController.html#verify_2fa_recovery_code_form/2"},{"type":"function","title":"PlausibleWeb.AuthController.verify_2fa_setup/2","doc":"","ref":"PlausibleWeb.AuthController.html#verify_2fa_setup/2"},{"type":"function","title":"PlausibleWeb.AuthController.verify_2fa_setup_form/2","doc":"","ref":"PlausibleWeb.AuthController.html#verify_2fa_setup_form/2"},{"type":"module","title":"PlausibleWeb.AuthPlug","doc":"Plug for populating conn assigns with user data\non the basis of authenticated session token.\n\nMust be kept in sync with `PlausibleWeb.Live.AuthContext`.","ref":"PlausibleWeb.AuthPlug.html"},{"type":"function","title":"PlausibleWeb.AuthPlug.call/2","doc":"","ref":"PlausibleWeb.AuthPlug.html#call/2"},{"type":"function","title":"PlausibleWeb.AuthPlug.init/1","doc":"","ref":"PlausibleWeb.AuthPlug.html#init/1"},{"type":"module","title":"PlausibleWeb.AuthView","doc":"","ref":"PlausibleWeb.AuthView.html"},{"type":"function","title":"PlausibleWeb.AuthView.__resource__/0","doc":"The resource name, as an atom, for this view","ref":"PlausibleWeb.AuthView.html#__resource__/0"},{"type":"function","title":"PlausibleWeb.AuthView.activate.html/1","doc":"","ref":"PlausibleWeb.AuthView.html#activate.html/1"},{"type":"function","title":"PlausibleWeb.AuthView.delimit_integer/1","doc":"","ref":"PlausibleWeb.AuthView.html#delimit_integer/1"},{"type":"function","title":"PlausibleWeb.AuthView.format_invoices/1","doc":"","ref":"PlausibleWeb.AuthView.html#format_invoices/1"},{"type":"function","title":"PlausibleWeb.AuthView.generate_2fa_recovery_codes.html/1","doc":"","ref":"PlausibleWeb.AuthView.html#generate_2fa_recovery_codes.html/1"},{"type":"function","title":"PlausibleWeb.AuthView.initiate_2fa_setup.html/1","doc":"","ref":"PlausibleWeb.AuthView.html#initiate_2fa_setup.html/1"},{"type":"function","title":"PlausibleWeb.AuthView.login_form.html/1","doc":"","ref":"PlausibleWeb.AuthView.html#login_form.html/1"},{"type":"function","title":"PlausibleWeb.AuthView.new_api_key.html/1","doc":"","ref":"PlausibleWeb.AuthView.html#new_api_key.html/1"},{"type":"function","title":"PlausibleWeb.AuthView.password_reset_form.html/1","doc":"","ref":"PlausibleWeb.AuthView.html#password_reset_form.html/1"},{"type":"function","title":"PlausibleWeb.AuthView.password_reset_request_form.html/1","doc":"","ref":"PlausibleWeb.AuthView.html#password_reset_request_form.html/1"},{"type":"function","title":"PlausibleWeb.AuthView.password_reset_request_success.html/1","doc":"","ref":"PlausibleWeb.AuthView.html#password_reset_request_success.html/1"},{"type":"function","title":"PlausibleWeb.AuthView.present_subscription_status/1","doc":"","ref":"PlausibleWeb.AuthView.html#present_subscription_status/1"},{"type":"function","title":"PlausibleWeb.AuthView.render/2","doc":"Renders the given template locally.","ref":"PlausibleWeb.AuthView.html#render/2"},{"type":"function","title":"PlausibleWeb.AuthView.subscription_colors/1","doc":"","ref":"PlausibleWeb.AuthView.html#subscription_colors/1"},{"type":"function","title":"PlausibleWeb.AuthView.subscription_interval/1","doc":"","ref":"PlausibleWeb.AuthView.html#subscription_interval/1"},{"type":"function","title":"PlausibleWeb.AuthView.subscription_quota/2","doc":"","ref":"PlausibleWeb.AuthView.html#subscription_quota/2"},{"type":"function","title":"PlausibleWeb.AuthView.template_not_found/2","doc":"Callback invoked when no template is found.\nBy default it raises but can be customized\nto render a particular template.","ref":"PlausibleWeb.AuthView.html#template_not_found/2"},{"type":"function","title":"PlausibleWeb.AuthView.user_settings.html/1","doc":"","ref":"PlausibleWeb.AuthView.html#user_settings.html/1"},{"type":"function","title":"PlausibleWeb.AuthView.verify_2fa.html/1","doc":"","ref":"PlausibleWeb.AuthView.html#verify_2fa.html/1"},{"type":"function","title":"PlausibleWeb.AuthView.verify_2fa_recovery_code.html/1","doc":"","ref":"PlausibleWeb.AuthView.html#verify_2fa_recovery_code.html/1"},{"type":"function","title":"PlausibleWeb.AuthView.verify_2fa_setup.html/1","doc":"","ref":"PlausibleWeb.AuthView.html#verify_2fa_setup.html/1"},{"type":"module","title":"PlausibleWeb.AuthorizeSiteAccess","doc":"","ref":"PlausibleWeb.AuthorizeSiteAccess.html"},{"type":"function","title":"PlausibleWeb.AuthorizeSiteAccess.call/2","doc":"","ref":"PlausibleWeb.AuthorizeSiteAccess.html#call/2"},{"type":"function","title":"PlausibleWeb.AuthorizeSiteAccess.init/1","doc":"","ref":"PlausibleWeb.AuthorizeSiteAccess.html#init/1"},{"type":"module","title":"PlausibleWeb.AvatarController","doc":"This module proxies requests to BASE_URL/avatar/:hash to www.gravatar.com/avatar/:hash.\n\nThe purpose is to make use of Gravatar's convenient avatar service without exposing information\nthat could be used for tracking the Plausible user. Compared to requesting the Gravatar directly\nfrom the browser, this proxy module protects the Plausible user from disclosing to Gravatar:\n1. The client IP address\n2. User-Agent\n3. Referer header which can be used to track which site the user is visiting (i.e. plausible.io or self-hosted URL)\n\nThe downside is the added latency from the request having to go through the Plausible server, rather than contacting the\nlocal CDN server operated by Gravatar's service.","ref":"PlausibleWeb.AvatarController.html"},{"type":"function","title":"PlausibleWeb.AvatarController.avatar/2","doc":"","ref":"PlausibleWeb.AvatarController.html#avatar/2"},{"type":"module","title":"PlausibleWeb.BillingController","doc":"","ref":"PlausibleWeb.BillingController.html"},{"type":"function","title":"PlausibleWeb.BillingController.change_plan/2","doc":"","ref":"PlausibleWeb.BillingController.html#change_plan/2"},{"type":"function","title":"PlausibleWeb.BillingController.change_plan_preview/2","doc":"","ref":"PlausibleWeb.BillingController.html#change_plan_preview/2"},{"type":"function","title":"PlausibleWeb.BillingController.choose_plan/2","doc":"","ref":"PlausibleWeb.BillingController.html#choose_plan/2"},{"type":"function","title":"PlausibleWeb.BillingController.ping_subscription/2","doc":"","ref":"PlausibleWeb.BillingController.html#ping_subscription/2"},{"type":"function","title":"PlausibleWeb.BillingController.upgrade_success/2","doc":"","ref":"PlausibleWeb.BillingController.html#upgrade_success/2"},{"type":"function","title":"PlausibleWeb.BillingController.upgrade_to_enterprise_plan/2","doc":"","ref":"PlausibleWeb.BillingController.html#upgrade_to_enterprise_plan/2"},{"type":"module","title":"PlausibleWeb.BillingView","doc":"","ref":"PlausibleWeb.BillingView.html"},{"type":"function","title":"PlausibleWeb.BillingView.__resource__/0","doc":"The resource name, as an atom, for this view","ref":"PlausibleWeb.BillingView.html#__resource__/0"},{"type":"function","title":"PlausibleWeb.BillingView.change_enterprise_plan_contact_us.html/1","doc":"","ref":"PlausibleWeb.BillingView.html#change_enterprise_plan_contact_us.html/1"},{"type":"function","title":"PlausibleWeb.BillingView.change_plan_preview.html/1","doc":"","ref":"PlausibleWeb.BillingView.html#change_plan_preview.html/1"},{"type":"function","title":"PlausibleWeb.BillingView.choose_plan.html/1","doc":"","ref":"PlausibleWeb.BillingView.html#choose_plan.html/1"},{"type":"function","title":"PlausibleWeb.BillingView.present_currency/1","doc":"","ref":"PlausibleWeb.BillingView.html#present_currency/1"},{"type":"function","title":"PlausibleWeb.BillingView.present_date/1","doc":"","ref":"PlausibleWeb.BillingView.html#present_date/1"},{"type":"function","title":"PlausibleWeb.BillingView.render/2","doc":"Renders the given template locally.","ref":"PlausibleWeb.BillingView.html#render/2"},{"type":"function","title":"PlausibleWeb.BillingView.template_not_found/2","doc":"Callback invoked when no template is found.\nBy default it raises but can be customized\nto render a particular template.","ref":"PlausibleWeb.BillingView.html#template_not_found/2"},{"type":"function","title":"PlausibleWeb.BillingView.upgrade_success.html/1","doc":"","ref":"PlausibleWeb.BillingView.html#upgrade_success.html/1"},{"type":"function","title":"PlausibleWeb.BillingView.upgrade_to_enterprise_plan.html/1","doc":"","ref":"PlausibleWeb.BillingView.html#upgrade_to_enterprise_plan.html/1"},{"type":"module","title":"PlausibleWeb.Captcha","doc":"","ref":"PlausibleWeb.Captcha.html"},{"type":"function","title":"PlausibleWeb.Captcha.enabled?/0","doc":"","ref":"PlausibleWeb.Captcha.html#enabled?/0"},{"type":"function","title":"PlausibleWeb.Captcha.sitekey/0","doc":"","ref":"PlausibleWeb.Captcha.html#sitekey/0"},{"type":"function","title":"PlausibleWeb.Captcha.verify/1","doc":"","ref":"PlausibleWeb.Captcha.html#verify/1"},{"type":"module","title":"PlausibleWeb.Components.Billing.PlanBenefits","doc":"This module exposes functions for rendering and returning plan\nbenefits for Growth, Business, and Enterprise plans.","ref":"PlausibleWeb.Components.Billing.PlanBenefits.html"},{"type":"function","title":"PlausibleWeb.Components.Billing.PlanBenefits.for_business/2","doc":"Returns Business benefits for the given Business plan.\n\nA second argument is also required - list of Growth benefits. This\nis because we don't want to list the same benefits in both Growth\nand Business. Everything in Growth is also included in Business.","ref":"PlausibleWeb.Components.Billing.PlanBenefits.html#for_business/2"},{"type":"function","title":"PlausibleWeb.Components.Billing.PlanBenefits.for_enterprise/1","doc":"This function only takes a list of business benefits. Since all\nlimits and features of enterprise plans are configurable, we can\nsay on the upgrade page that enterprise plans include everything\nin Business.","ref":"PlausibleWeb.Components.Billing.PlanBenefits.html#for_enterprise/1"},{"type":"function","title":"PlausibleWeb.Components.Billing.PlanBenefits.for_growth/1","doc":"This function takes a growth plan and returns a list representing\nthe different benefits a user gets when subscribing to this plan.","ref":"PlausibleWeb.Components.Billing.PlanBenefits.html#for_growth/1"},{"type":"function","title":"PlausibleWeb.Components.Billing.PlanBenefits.render/1","doc":"This function takes a list of benefits returned by either one of:\n\n* `for_growth/1`\n* `for_business/2`\n* `for_enterprise/1`.\n\nand renders them as HTML.\n\nThe benefits in the given list can be either strings or functions\nreturning a Phoenix component. This allows, for example, to render\nlinks within the plan benefit text.","ref":"PlausibleWeb.Components.Billing.PlanBenefits.html#render/1"},{"type":"function","title":"Attributes - PlausibleWeb.Components.Billing.PlanBenefits.render/1","doc":"* `benefits` (`:list`) (required)\n* `class` (`:string`) - Defaults to `nil`.","ref":"PlausibleWeb.Components.Billing.PlanBenefits.html#render/1-attributes"},{"type":"module","title":"PlausibleWeb.Components.FirstDashboardLaunchBanner","doc":"A banner that appears on the first dashboard launch","ref":"PlausibleWeb.Components.FirstDashboardLaunchBanner.html"},{"type":"function","title":"PlausibleWeb.Components.FirstDashboardLaunchBanner.render/1","doc":"","ref":"PlausibleWeb.Components.FirstDashboardLaunchBanner.html#render/1"},{"type":"function","title":"Attributes - PlausibleWeb.Components.FirstDashboardLaunchBanner.render/1","doc":"* `site` (`Plausible.Site`) (required)","ref":"PlausibleWeb.Components.FirstDashboardLaunchBanner.html#render/1-attributes"},{"type":"function","title":"PlausibleWeb.Components.FirstDashboardLaunchBanner.set/1","doc":"","ref":"PlausibleWeb.Components.FirstDashboardLaunchBanner.html#set/1"},{"type":"function","title":"Attributes - PlausibleWeb.Components.FirstDashboardLaunchBanner.set/1","doc":"* `site` (`Plausible.Site`) (required)","ref":"PlausibleWeb.Components.FirstDashboardLaunchBanner.html#set/1-attributes"},{"type":"module","title":"PlausibleWeb.Components.FlowProgress","doc":"Component for provisioning/registration flows displaying\nprogress status.","ref":"PlausibleWeb.Components.FlowProgress.html"},{"type":"function","title":"PlausibleWeb.Components.FlowProgress.flows/0","doc":"","ref":"PlausibleWeb.Components.FlowProgress.html#flows/0"},{"type":"function","title":"PlausibleWeb.Components.FlowProgress.render/1","doc":"","ref":"PlausibleWeb.Components.FlowProgress.html#render/1"},{"type":"function","title":"Attributes - PlausibleWeb.Components.FlowProgress.render/1","doc":"* `flow` (`:string`) (required)\n* `current_step` (`:string`) (required) - Must be one of `\"Register\"`, `\"Activate account\"`, `\"Add site info\"`, `\"Install snippet\"`, or `\"Verify snippet\"`.","ref":"PlausibleWeb.Components.FlowProgress.html#render/1-attributes"},{"type":"module","title":"PlausibleWeb.Components.Generic","doc":"Generic reusable components","ref":"PlausibleWeb.Components.Generic.html"},{"type":"function","title":"PlausibleWeb.Components.Generic.button/1","doc":"","ref":"PlausibleWeb.Components.Generic.html#button/1"},{"type":"function","title":"Attributes - PlausibleWeb.Components.Generic.button/1","doc":"* `type` (`:string`) - Defaults to `\"button\"`.\n* `theme` (`:string`) - Defaults to `\"primary\"`.\n* `class` (`:string`) - Defaults to `\"\"`.\n* `disabled` (`:boolean`) - Defaults to `false`.\n* Global attributes are accepted.","ref":"PlausibleWeb.Components.Generic.html#button/1-attributes"},{"type":"function","title":"Slots - PlausibleWeb.Components.Generic.button/1","doc":"* `inner_block`","ref":"PlausibleWeb.Components.Generic.html#button/1-slots"},{"type":"function","title":"PlausibleWeb.Components.Generic.button_link/1","doc":"","ref":"PlausibleWeb.Components.Generic.html#button_link/1"},{"type":"function","title":"Attributes - PlausibleWeb.Components.Generic.button_link/1","doc":"* `href` (`:string`) (required)\n* `class` (`:string`) - Defaults to `\"\"`.\n* `theme` (`:string`) - Defaults to `\"primary\"`.\n* `disabled` (`:boolean`) - Defaults to `false`.\n* Global attributes are accepted.","ref":"PlausibleWeb.Components.Generic.html#button_link/1-attributes"},{"type":"function","title":"Slots - PlausibleWeb.Components.Generic.button_link/1","doc":"* `inner_block`","ref":"PlausibleWeb.Components.Generic.html#button_link/1-slots"},{"type":"function","title":"PlausibleWeb.Components.Generic.docs_info/1","doc":"","ref":"PlausibleWeb.Components.Generic.html#docs_info/1"},{"type":"function","title":"Attributes - PlausibleWeb.Components.Generic.docs_info/1","doc":"* `slug` (`:string`) (required)","ref":"PlausibleWeb.Components.Generic.html#docs_info/1-attributes"},{"type":"function","title":"PlausibleWeb.Components.Generic.dropdown/1","doc":"","ref":"PlausibleWeb.Components.Generic.html#dropdown/1"},{"type":"function","title":"Slots - PlausibleWeb.Components.Generic.dropdown/1","doc":"* `button` (required) - Accepts attributes:\n\n * `class` (`:string`)\n* `panel` (required) - Accepts attributes:\n\n * `class` (`:string`)","ref":"PlausibleWeb.Components.Generic.html#dropdown/1-slots"},{"type":"function","title":"PlausibleWeb.Components.Generic.dropdown_link/1","doc":"","ref":"PlausibleWeb.Components.Generic.html#dropdown_link/1"},{"type":"function","title":"Attributes - PlausibleWeb.Components.Generic.dropdown_link/1","doc":"* `href` (`:string`) (required)\n* `new_tab` (`:boolean`) - Defaults to `false`.\n* Global attributes are accepted.","ref":"PlausibleWeb.Components.Generic.html#dropdown_link/1-attributes"},{"type":"function","title":"Slots - PlausibleWeb.Components.Generic.dropdown_link/1","doc":"* `inner_block` (required)","ref":"PlausibleWeb.Components.Generic.html#dropdown_link/1-slots"},{"type":"function","title":"PlausibleWeb.Components.Generic.dynamic_icon/1","doc":"","ref":"PlausibleWeb.Components.Generic.html#dynamic_icon/1"},{"type":"function","title":"Attributes - PlausibleWeb.Components.Generic.dynamic_icon/1","doc":"* `name` (`:atom`) (required)\n* `outline` (`:boolean`) - Defaults to `true`.\n* `solid` (`:boolean`) - Defaults to `false`.\n* `mini` (`:boolean`) - Defaults to `false`.\n* Global attributes are accepted. Supports all globals plus: `[\"fill\", \"stroke\", \"stroke-width\"]`.","ref":"PlausibleWeb.Components.Generic.html#dynamic_icon/1-attributes"},{"type":"function","title":"PlausibleWeb.Components.Generic.focus_box/1","doc":"","ref":"PlausibleWeb.Components.Generic.html#focus_box/1"},{"type":"function","title":"Attributes - PlausibleWeb.Components.Generic.focus_box/1","doc":"* `outer_markup` (`:boolean`) - Defaults to `true`.","ref":"PlausibleWeb.Components.Generic.html#focus_box/1-attributes"},{"type":"function","title":"Slots - PlausibleWeb.Components.Generic.focus_box/1","doc":"* `title`\n* `subtitle`\n* `inner_block` (required)\n* `footer`","ref":"PlausibleWeb.Components.Generic.html#focus_box/1-slots"},{"type":"function","title":"PlausibleWeb.Components.Generic.notice/1","doc":"","ref":"PlausibleWeb.Components.Generic.html#notice/1"},{"type":"function","title":"Attributes - PlausibleWeb.Components.Generic.notice/1","doc":"* `title` (`:any`) - Defaults to `nil`.\n* `size` (`:atom`) - Defaults to `:sm`.\n* `theme` (`:atom`) - Defaults to `:yellow`.\n* `dismissable_id` (`:any`) - Defaults to `nil`.\n* `class` (`:string`) - Defaults to `\"\"`.\n* Global attributes are accepted.","ref":"PlausibleWeb.Components.Generic.html#notice/1-attributes"},{"type":"function","title":"Slots - PlausibleWeb.Components.Generic.notice/1","doc":"* `inner_block`","ref":"PlausibleWeb.Components.Generic.html#notice/1-slots"},{"type":"function","title":"PlausibleWeb.Components.Generic.spinner/1","doc":"","ref":"PlausibleWeb.Components.Generic.html#spinner/1"},{"type":"function","title":"Attributes - PlausibleWeb.Components.Generic.spinner/1","doc":"* `class` (`:any`) - Defaults to `\"\"`.\n* Global attributes are accepted.","ref":"PlausibleWeb.Components.Generic.html#spinner/1-attributes"},{"type":"function","title":"PlausibleWeb.Components.Generic.styled_link/1","doc":"","ref":"PlausibleWeb.Components.Generic.html#styled_link/1"},{"type":"function","title":"Attributes - PlausibleWeb.Components.Generic.styled_link/1","doc":"* `id` (`:any`) - Defaults to `nil`.\n* `href` (`:string`) - Defaults to `\"#\"`.\n* `new_tab` (`:boolean`) - Defaults to `false`.\n* `class` (`:string`) - Defaults to `\"\"`.\n* Global attributes are accepted.","ref":"PlausibleWeb.Components.Generic.html#styled_link/1-attributes"},{"type":"function","title":"Slots - PlausibleWeb.Components.Generic.styled_link/1","doc":"* `inner_block`","ref":"PlausibleWeb.Components.Generic.html#styled_link/1-slots"},{"type":"function","title":"PlausibleWeb.Components.Generic.tooltip/1","doc":"","ref":"PlausibleWeb.Components.Generic.html#tooltip/1"},{"type":"function","title":"Attributes - PlausibleWeb.Components.Generic.tooltip/1","doc":"* `wrapper_class` (`:any`) - Defaults to `\"\"`.\n* `class` (`:any`) - Defaults to `\"\"`.","ref":"PlausibleWeb.Components.Generic.html#tooltip/1-attributes"},{"type":"function","title":"Slots - PlausibleWeb.Components.Generic.tooltip/1","doc":"* `inner_block` (required)\n* `tooltip_content` (required)","ref":"PlausibleWeb.Components.Generic.html#tooltip/1-slots"},{"type":"function","title":"PlausibleWeb.Components.Generic.unstyled_link/1","doc":"","ref":"PlausibleWeb.Components.Generic.html#unstyled_link/1"},{"type":"function","title":"Attributes - PlausibleWeb.Components.Generic.unstyled_link/1","doc":"* `href` (`:string`) (required)\n* `new_tab` (`:boolean`) - Defaults to `false`.\n* `class` (`:string`) - Defaults to `\"\"`.\n* `id` (`:any`) - Defaults to `nil`.\n* Global attributes are accepted.","ref":"PlausibleWeb.Components.Generic.html#unstyled_link/1-attributes"},{"type":"function","title":"Slots - PlausibleWeb.Components.Generic.unstyled_link/1","doc":"* `inner_block`","ref":"PlausibleWeb.Components.Generic.html#unstyled_link/1-slots"},{"type":"module","title":"PlausibleWeb.Components.Google","doc":"Google-related components","ref":"PlausibleWeb.Components.Google.html"},{"type":"function","title":"PlausibleWeb.Components.Google.button/1","doc":"","ref":"PlausibleWeb.Components.Google.html#button/1"},{"type":"function","title":"Attributes - PlausibleWeb.Components.Google.button/1","doc":"* `to` (`:string`) (required)\n* `id` (`:string`) (required)","ref":"PlausibleWeb.Components.Google.html#button/1-attributes"},{"type":"function","title":"PlausibleWeb.Components.Google.logo/1","doc":"","ref":"PlausibleWeb.Components.Google.html#logo/1"},{"type":"module","title":"PlausibleWeb.Components.Settings","doc":"An umbrella module for the Integrations settings section","ref":"PlausibleWeb.Components.Settings.html"},{"type":"function","title":"PlausibleWeb.Components.Settings.settings_search_console/1","doc":"","ref":"PlausibleWeb.Components.Settings.html#settings_search_console/1"},{"type":"module","title":"PlausibleWeb.Components.Site.Feature","doc":"Phoenix Component for rendering a user-facing feature toggle\ncapable of flipping booleans in `Plausible.Site` via the `toggle_feature` controller action.","ref":"PlausibleWeb.Components.Site.Feature.html"},{"type":"function","title":"PlausibleWeb.Components.Site.Feature.__resource__/0","doc":"The resource name, as an atom, for this view","ref":"PlausibleWeb.Components.Site.Feature.html#__resource__/0"},{"type":"function","title":"PlausibleWeb.Components.Site.Feature.render/2","doc":"Renders the given template locally.","ref":"PlausibleWeb.Components.Site.Feature.html#render/2"},{"type":"function","title":"PlausibleWeb.Components.Site.Feature.target/4","doc":"","ref":"PlausibleWeb.Components.Site.Feature.html#target/4"},{"type":"function","title":"PlausibleWeb.Components.Site.Feature.template_not_found/2","doc":"Callback invoked when no template is found.\nBy default it raises but can be customized\nto render a particular template.","ref":"PlausibleWeb.Components.Site.Feature.html#template_not_found/2"},{"type":"function","title":"PlausibleWeb.Components.Site.Feature.toggle/1","doc":"","ref":"PlausibleWeb.Components.Site.Feature.html#toggle/1"},{"type":"function","title":"Attributes - PlausibleWeb.Components.Site.Feature.toggle/1","doc":"* `site` (`Plausible.Site`) (required)\n* `feature_mod` (`:atom`) (required) - Must be one of `Plausible.Billing.Feature.Goals`, `Plausible.Billing.Feature.StatsAPI`, `Plausible.Billing.Feature.Props`, `Plausible.Billing.Feature.Funnels`, or `Plausible.Billing.Feature.RevenueGoals`.\n* `conn` (`Plug.Conn`) (required)","ref":"PlausibleWeb.Components.Site.Feature.html#toggle/1-attributes"},{"type":"function","title":"Slots - PlausibleWeb.Components.Site.Feature.toggle/1","doc":"* `inner_block`","ref":"PlausibleWeb.Components.Site.Feature.html#toggle/1-slots"},{"type":"module","title":"PlausibleWeb.Components.TwoFactor","doc":"Reusable components specific to 2FA","ref":"PlausibleWeb.Components.TwoFactor.html"},{"type":"function","title":"PlausibleWeb.Components.TwoFactor.modal/1","doc":"","ref":"PlausibleWeb.Components.TwoFactor.html#modal/1"},{"type":"function","title":"Attributes - PlausibleWeb.Components.TwoFactor.modal/1","doc":"* `id` (`:string`) (required)\n* `state_param` (`:string`) (required)\n* `form_data` (`:any`) (required)\n* `form_target` (`:string`) (required)\n* `onsubmit` (`:string`) - Defaults to `nil`.\n* `title` (`:string`) (required)","ref":"PlausibleWeb.Components.TwoFactor.html#modal/1-attributes"},{"type":"function","title":"Slots - PlausibleWeb.Components.TwoFactor.modal/1","doc":"* `icon` (required)\n* `inner_block` (required)\n* `buttons` (required)","ref":"PlausibleWeb.Components.TwoFactor.html#modal/1-slots"},{"type":"function","title":"PlausibleWeb.Components.TwoFactor.qr_code/1","doc":"","ref":"PlausibleWeb.Components.TwoFactor.html#qr_code/1"},{"type":"function","title":"Attributes - PlausibleWeb.Components.TwoFactor.qr_code/1","doc":"* `text` (`:string`) (required)\n* `scale` (`:integer`) - Defaults to `4`.","ref":"PlausibleWeb.Components.TwoFactor.html#qr_code/1-attributes"},{"type":"function","title":"PlausibleWeb.Components.TwoFactor.verify_2fa_input/1","doc":"","ref":"PlausibleWeb.Components.TwoFactor.html#verify_2fa_input/1"},{"type":"function","title":"Attributes - PlausibleWeb.Components.TwoFactor.verify_2fa_input/1","doc":"* `id` (`:string`) - Defaults to `\"verify-button\"`.\n* `form` (`:any`) (required)\n* `field` (`:any`) (required)\n* `class` (`:string`) - Defaults to `\"\"`.","ref":"PlausibleWeb.Components.TwoFactor.html#verify_2fa_input/1-attributes"},{"type":"module","title":"PlausibleWeb.ConnCase","doc":"This module defines the test case to be used by\ntests that require setting up a connection.\n\nSuch tests rely on `Phoenix.ConnTest` and also\nimport other functionality to make it easier\nto build common data structures and query the data layer.\n\nFinally, if the test case interacts with the database,\nit cannot be async. For this reason, every test runs\ninside a transaction which is reset at the beginning\nof the test unless the test case is marked as async.","ref":"PlausibleWeb.ConnCase.html"},{"type":"module","title":"PlausibleWeb.ControllerHelpers","doc":"","ref":"PlausibleWeb.ControllerHelpers.html"},{"type":"function","title":"PlausibleWeb.ControllerHelpers.debug_metadata/1","doc":"","ref":"PlausibleWeb.ControllerHelpers.html#debug_metadata/1"},{"type":"function","title":"PlausibleWeb.ControllerHelpers.render_error/2","doc":"","ref":"PlausibleWeb.ControllerHelpers.html#render_error/2"},{"type":"function","title":"PlausibleWeb.ControllerHelpers.render_error/3","doc":"","ref":"PlausibleWeb.ControllerHelpers.html#render_error/3"},{"type":"module","title":"PlausibleWeb.Controllers.API.Revenue","doc":"Revenue specific functions for the API scope","ref":"PlausibleWeb.Controllers.API.Revenue.html"},{"type":"function","title":"PlausibleWeb.Controllers.API.Revenue.format_money/1","doc":"","ref":"PlausibleWeb.Controllers.API.Revenue.html#format_money/1"},{"type":"function","title":"PlausibleWeb.Controllers.API.Revenue.format_revenue_metric/1","doc":"","ref":"PlausibleWeb.Controllers.API.Revenue.html#format_revenue_metric/1"},{"type":"module","title":"PlausibleWeb.DebugController","doc":"","ref":"PlausibleWeb.DebugController.html"},{"type":"function","title":"PlausibleWeb.DebugController.clickhouse/2","doc":"","ref":"PlausibleWeb.DebugController.html#clickhouse/2"},{"type":"module","title":"PlausibleWeb.DebugView","doc":"","ref":"PlausibleWeb.DebugView.html"},{"type":"function","title":"PlausibleWeb.DebugView.__resource__/0","doc":"The resource name, as an atom, for this view","ref":"PlausibleWeb.DebugView.html#__resource__/0"},{"type":"function","title":"PlausibleWeb.DebugView.clickhouse.html/1","doc":"","ref":"PlausibleWeb.DebugView.html#clickhouse.html/1"},{"type":"function","title":"PlausibleWeb.DebugView.controller_name/1","doc":"","ref":"PlausibleWeb.DebugView.html#controller_name/1"},{"type":"function","title":"PlausibleWeb.DebugView.render/2","doc":"Renders the given template locally.","ref":"PlausibleWeb.DebugView.html#render/2"},{"type":"function","title":"PlausibleWeb.DebugView.template_not_found/2","doc":"Callback invoked when no template is found.\nBy default it raises but can be customized\nto render a particular template.","ref":"PlausibleWeb.DebugView.html#template_not_found/2"},{"type":"module","title":"PlausibleWeb.Dogfood","doc":"Plausible tracking itself functions","ref":"PlausibleWeb.Dogfood.html"},{"type":"function","title":"PlausibleWeb.Dogfood.api_destination/0","doc":"Temporary override to do more testing of the new ingest.plausible.io endpoint for accepting events. In staging and locally\nwill fall back to staging.plausible.io/api/event and localhost:8000/api/event respectively.","ref":"PlausibleWeb.Dogfood.html#api_destination/0"},{"type":"function","title":"PlausibleWeb.Dogfood.domain/1","doc":"","ref":"PlausibleWeb.Dogfood.html#domain/1"},{"type":"function","title":"PlausibleWeb.Dogfood.script_url/0","doc":"","ref":"PlausibleWeb.Dogfood.html#script_url/0"},{"type":"module","title":"PlausibleWeb.Email","doc":"","ref":"PlausibleWeb.Email.html"},{"type":"function","title":"PlausibleWeb.Email.activation_email/2","doc":"","ref":"PlausibleWeb.Email.html#activation_email/2"},{"type":"function","title":"PlausibleWeb.Email.approaching_accept_traffic_until/1","doc":"","ref":"PlausibleWeb.Email.html#approaching_accept_traffic_until/1"},{"type":"function","title":"PlausibleWeb.Email.approaching_accept_traffic_until_tomorrow/1","doc":"","ref":"PlausibleWeb.Email.html#approaching_accept_traffic_until_tomorrow/1"},{"type":"function","title":"PlausibleWeb.Email.base_email/0","doc":"","ref":"PlausibleWeb.Email.html#base_email/0"},{"type":"function","title":"PlausibleWeb.Email.base_email/1","doc":"","ref":"PlausibleWeb.Email.html#base_email/1"},{"type":"function","title":"PlausibleWeb.Email.cancellation_email/1","doc":"","ref":"PlausibleWeb.Email.html#cancellation_email/1"},{"type":"function","title":"PlausibleWeb.Email.check_stats_email/1","doc":"","ref":"PlausibleWeb.Email.html#check_stats_email/1"},{"type":"function","title":"PlausibleWeb.Email.create_site_email/1","doc":"","ref":"PlausibleWeb.Email.html#create_site_email/1"},{"type":"function","title":"PlausibleWeb.Email.dashboard_locked/3","doc":"","ref":"PlausibleWeb.Email.html#dashboard_locked/3"},{"type":"function","title":"PlausibleWeb.Email.drop_notification/5","doc":"","ref":"PlausibleWeb.Email.html#drop_notification/5"},{"type":"function","title":"PlausibleWeb.Email.enterprise_over_limit_internal_email/4","doc":"","ref":"PlausibleWeb.Email.html#enterprise_over_limit_internal_email/4"},{"type":"function","title":"PlausibleWeb.Email.error_report/3","doc":"","ref":"PlausibleWeb.Email.html#error_report/3"},{"type":"function","title":"PlausibleWeb.Email.existing_user_invitation/1","doc":"","ref":"PlausibleWeb.Email.html#existing_user_invitation/1"},{"type":"function","title":"PlausibleWeb.Email.export_failure/2","doc":"","ref":"PlausibleWeb.Email.html#export_failure/2"},{"type":"function","title":"PlausibleWeb.Email.export_success/3","doc":"","ref":"PlausibleWeb.Email.html#export_success/3"},{"type":"function","title":"PlausibleWeb.Email.import_failure/2","doc":"","ref":"PlausibleWeb.Email.html#import_failure/2"},{"type":"function","title":"PlausibleWeb.Email.import_success/2","doc":"","ref":"PlausibleWeb.Email.html#import_success/2"},{"type":"function","title":"PlausibleWeb.Email.invitation_accepted/1","doc":"","ref":"PlausibleWeb.Email.html#invitation_accepted/1"},{"type":"function","title":"PlausibleWeb.Email.invitation_rejected/1","doc":"","ref":"PlausibleWeb.Email.html#invitation_rejected/1"},{"type":"function","title":"PlausibleWeb.Email.mailer_email_from/0","doc":"","ref":"PlausibleWeb.Email.html#mailer_email_from/0"},{"type":"function","title":"PlausibleWeb.Email.new_user_invitation/1","doc":"","ref":"PlausibleWeb.Email.html#new_user_invitation/1"},{"type":"function","title":"PlausibleWeb.Email.over_limit_email/3","doc":"","ref":"PlausibleWeb.Email.html#over_limit_email/3"},{"type":"function","title":"PlausibleWeb.Email.ownership_transfer_accepted/1","doc":"","ref":"PlausibleWeb.Email.html#ownership_transfer_accepted/1"},{"type":"function","title":"PlausibleWeb.Email.ownership_transfer_rejected/1","doc":"","ref":"PlausibleWeb.Email.html#ownership_transfer_rejected/1"},{"type":"function","title":"PlausibleWeb.Email.ownership_transfer_request/2","doc":"","ref":"PlausibleWeb.Email.html#ownership_transfer_request/2"},{"type":"function","title":"PlausibleWeb.Email.password_reset_email/2","doc":"","ref":"PlausibleWeb.Email.html#password_reset_email/2"},{"type":"function","title":"PlausibleWeb.Email.priority_email/0","doc":"Unlike the default 'base' emails, priority emails cannot be unsubscribed from. This is achieved\n by sending them through a dedicated 'priority' message stream in Postmark.","ref":"PlausibleWeb.Email.html#priority_email/0"},{"type":"function","title":"PlausibleWeb.Email.priority_email/1","doc":"","ref":"PlausibleWeb.Email.html#priority_email/1"},{"type":"function","title":"PlausibleWeb.Email.render/3","doc":"Render an Phoenix template and set the body on the email.\n\nPass an atom as the template name (:welcome_email) to render HTML *and* plain\ntext emails. Use a string if you only want to render one type, e.g.\n\"welcome_email.text\" or \"welcome_email.html\". Scroll to the top for more examples.","ref":"PlausibleWeb.Email.html#render/3"},{"type":"function","title":"PlausibleWeb.Email.site_member_removed/1","doc":"","ref":"PlausibleWeb.Email.html#site_member_removed/1"},{"type":"function","title":"PlausibleWeb.Email.site_setup_help/2","doc":"","ref":"PlausibleWeb.Email.html#site_setup_help/2"},{"type":"function","title":"PlausibleWeb.Email.site_setup_success/2","doc":"","ref":"PlausibleWeb.Email.html#site_setup_success/2"},{"type":"function","title":"PlausibleWeb.Email.spike_notification/5","doc":"","ref":"PlausibleWeb.Email.html#spike_notification/5"},{"type":"function","title":"PlausibleWeb.Email.stats_report/2","doc":"","ref":"PlausibleWeb.Email.html#stats_report/2"},{"type":"function","title":"PlausibleWeb.Email.trial_one_week_reminder/1","doc":"","ref":"PlausibleWeb.Email.html#trial_one_week_reminder/1"},{"type":"function","title":"PlausibleWeb.Email.trial_over_email/1","doc":"","ref":"PlausibleWeb.Email.html#trial_over_email/1"},{"type":"function","title":"PlausibleWeb.Email.trial_upgrade_email/3","doc":"","ref":"PlausibleWeb.Email.html#trial_upgrade_email/3"},{"type":"function","title":"PlausibleWeb.Email.two_factor_disabled_email/1","doc":"","ref":"PlausibleWeb.Email.html#two_factor_disabled_email/1"},{"type":"function","title":"PlausibleWeb.Email.two_factor_enabled_email/1","doc":"","ref":"PlausibleWeb.Email.html#two_factor_enabled_email/1"},{"type":"function","title":"PlausibleWeb.Email.welcome_email/1","doc":"","ref":"PlausibleWeb.Email.html#welcome_email/1"},{"type":"function","title":"PlausibleWeb.Email.yearly_expiration_notification/1","doc":"","ref":"PlausibleWeb.Email.html#yearly_expiration_notification/1"},{"type":"function","title":"PlausibleWeb.Email.yearly_renewal_notification/1","doc":"","ref":"PlausibleWeb.Email.html#yearly_renewal_notification/1"},{"type":"module","title":"PlausibleWeb.EmailView","doc":"","ref":"PlausibleWeb.EmailView.html"},{"type":"function","title":"PlausibleWeb.EmailView.__resource__/0","doc":"The resource name, as an atom, for this view","ref":"PlausibleWeb.EmailView.html#__resource__/0"},{"type":"function","title":"PlausibleWeb.EmailView.activation_email.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#activation_email.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.approaching_accept_traffic_until.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#approaching_accept_traffic_until.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.cancellation_email.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#cancellation_email.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.check_stats_email.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#check_stats_email.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.create_site_email.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#create_site_email.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.csv_import.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#csv_import.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.dashboard_locked.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#dashboard_locked.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.date_format/1","doc":"","ref":"PlausibleWeb.EmailView.html#date_format/1"},{"type":"function","title":"PlausibleWeb.EmailView.drop_notification.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#drop_notification.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.enterprise_over_limit_internal.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#enterprise_over_limit_internal.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.error_report_email.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#error_report_email.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.existing_user_invitation.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#existing_user_invitation.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.export_failure.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#export_failure.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.export_success.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#export_success.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.google_analytics_import.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#google_analytics_import.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.greet_recipient/1","doc":"","ref":"PlausibleWeb.EmailView.html#greet_recipient/1"},{"type":"function","title":"PlausibleWeb.EmailView.invitation_accepted.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#invitation_accepted.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.invitation_rejected.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#invitation_rejected.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.new_user_invitation.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#new_user_invitation.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.over_limit.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#over_limit.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.ownership_transfer_accepted.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#ownership_transfer_accepted.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.ownership_transfer_rejected.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#ownership_transfer_rejected.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.ownership_transfer_request.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#ownership_transfer_request.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.password_reset_email.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#password_reset_email.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.plausible_url/0","doc":"","ref":"PlausibleWeb.EmailView.html#plausible_url/0"},{"type":"function","title":"PlausibleWeb.EmailView.render/2","doc":"Renders the given template locally.","ref":"PlausibleWeb.EmailView.html#render/2"},{"type":"function","title":"PlausibleWeb.EmailView.sentry_link/2","doc":"","ref":"PlausibleWeb.EmailView.html#sentry_link/2"},{"type":"function","title":"PlausibleWeb.EmailView.site_member_removed.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#site_member_removed.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.site_setup_help_email.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#site_setup_help_email.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.site_setup_success_email.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#site_setup_success_email.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.spike_notification.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#spike_notification.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.template_not_found/2","doc":"Callback invoked when no template is found.\nBy default it raises but can be customized\nto render a particular template.","ref":"PlausibleWeb.EmailView.html#template_not_found/2"},{"type":"function","title":"PlausibleWeb.EmailView.trial_one_week_reminder.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#trial_one_week_reminder.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.trial_over_email.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#trial_over_email.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.trial_upgrade_email.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#trial_upgrade_email.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.two_factor_disabled_email.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#two_factor_disabled_email.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.two_factor_enabled_email.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#two_factor_enabled_email.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.welcome_email.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#welcome_email.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.yearly_expiration_notification.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#yearly_expiration_notification.html/1"},{"type":"function","title":"PlausibleWeb.EmailView.yearly_renewal_notification.html/1","doc":"","ref":"PlausibleWeb.EmailView.html#yearly_renewal_notification.html/1"},{"type":"module","title":"PlausibleWeb.Endpoint","doc":"","ref":"PlausibleWeb.Endpoint.html"},{"type":"function","title":"PlausibleWeb.Endpoint.broadcast/3","doc":"","ref":"PlausibleWeb.Endpoint.html#broadcast/3"},{"type":"function","title":"PlausibleWeb.Endpoint.broadcast!/3","doc":"","ref":"PlausibleWeb.Endpoint.html#broadcast!/3"},{"type":"function","title":"PlausibleWeb.Endpoint.broadcast_from/4","doc":"","ref":"PlausibleWeb.Endpoint.html#broadcast_from/4"},{"type":"function","title":"PlausibleWeb.Endpoint.broadcast_from!/4","doc":"","ref":"PlausibleWeb.Endpoint.html#broadcast_from!/4"},{"type":"function","title":"PlausibleWeb.Endpoint.call/2","doc":"","ref":"PlausibleWeb.Endpoint.html#call/2"},{"type":"function","title":"PlausibleWeb.Endpoint.child_spec/1","doc":"Returns the child specification to start the endpoint\nunder a supervision tree.","ref":"PlausibleWeb.Endpoint.html#child_spec/1"},{"type":"function","title":"PlausibleWeb.Endpoint.config/2","doc":"Returns the endpoint configuration for `key`\n\nReturns `default` if the key does not exist.","ref":"PlausibleWeb.Endpoint.html#config/2"},{"type":"function","title":"PlausibleWeb.Endpoint.config_change/2","doc":"Reloads the configuration given the application environment changes.","ref":"PlausibleWeb.Endpoint.html#config_change/2"},{"type":"function","title":"PlausibleWeb.Endpoint.host/0","doc":"Returns the host for the given endpoint.","ref":"PlausibleWeb.Endpoint.html#host/0"},{"type":"function","title":"PlausibleWeb.Endpoint.init/1","doc":"","ref":"PlausibleWeb.Endpoint.html#init/1"},{"type":"function","title":"PlausibleWeb.Endpoint.local_broadcast/3","doc":"","ref":"PlausibleWeb.Endpoint.html#local_broadcast/3"},{"type":"function","title":"PlausibleWeb.Endpoint.local_broadcast_from/4","doc":"","ref":"PlausibleWeb.Endpoint.html#local_broadcast_from/4"},{"type":"function","title":"PlausibleWeb.Endpoint.path/1","doc":"Generates the path information when routing to this endpoint.","ref":"PlausibleWeb.Endpoint.html#path/1"},{"type":"function","title":"PlausibleWeb.Endpoint.runtime_session/2","doc":"","ref":"PlausibleWeb.Endpoint.html#runtime_session/2"},{"type":"function","title":"PlausibleWeb.Endpoint.runtime_session_opts/0","doc":"","ref":"PlausibleWeb.Endpoint.html#runtime_session_opts/0"},{"type":"function","title":"PlausibleWeb.Endpoint.script_name/0","doc":"Generates the script name.","ref":"PlausibleWeb.Endpoint.html#script_name/0"},{"type":"function","title":"PlausibleWeb.Endpoint.secure_cookie?/0","doc":"","ref":"PlausibleWeb.Endpoint.html#secure_cookie?/0"},{"type":"function","title":"PlausibleWeb.Endpoint.server_info/1","doc":"Returns the address and port that the server is running on","ref":"PlausibleWeb.Endpoint.html#server_info/1"},{"type":"function","title":"PlausibleWeb.Endpoint.start_link/1","doc":"Starts the endpoint supervision tree.\n\nAll other options are merged into the endpoint configuration.","ref":"PlausibleWeb.Endpoint.html#start_link/1"},{"type":"function","title":"PlausibleWeb.Endpoint.static_integrity/1","doc":"Generates a base64-encoded cryptographic hash (sha512) to a static file\nin `priv/static`. Meant to be used for Subresource Integrity with CDNs.","ref":"PlausibleWeb.Endpoint.html#static_integrity/1"},{"type":"function","title":"PlausibleWeb.Endpoint.static_lookup/1","doc":"Returns a two item tuple with the first item being the `static_path`\nand the second item being the `static_integrity`.","ref":"PlausibleWeb.Endpoint.html#static_lookup/1"},{"type":"function","title":"PlausibleWeb.Endpoint.static_path/1","doc":"Generates a route to a static file in `priv/static`.","ref":"PlausibleWeb.Endpoint.html#static_path/1"},{"type":"function","title":"PlausibleWeb.Endpoint.static_url/0","doc":"Generates the static URL without any path information.\n\nIt uses the configuration under `:static_url` to generate\nsuch. It falls back to `:url` if `:static_url` is not set.","ref":"PlausibleWeb.Endpoint.html#static_url/0"},{"type":"function","title":"PlausibleWeb.Endpoint.struct_url/0","doc":"Generates the endpoint base URL but as a `URI` struct.\n\nIt uses the configuration under `:url` to generate such.\nUseful for manipulating the URL data and passing it to\nURL helpers.","ref":"PlausibleWeb.Endpoint.html#struct_url/0"},{"type":"function","title":"PlausibleWeb.Endpoint.subscribe/2","doc":"","ref":"PlausibleWeb.Endpoint.html#subscribe/2"},{"type":"function","title":"PlausibleWeb.Endpoint.unsubscribe/1","doc":"","ref":"PlausibleWeb.Endpoint.html#unsubscribe/1"},{"type":"function","title":"PlausibleWeb.Endpoint.url/0","doc":"Generates the endpoint base URL without any path information.\n\nIt uses the configuration under `:url` to generate such.","ref":"PlausibleWeb.Endpoint.html#url/0"},{"type":"function","title":"PlausibleWeb.Endpoint.websocket_url/0","doc":"","ref":"PlausibleWeb.Endpoint.html#websocket_url/0"},{"type":"module","title":"PlausibleWeb.ErrorHelpers","doc":"","ref":"PlausibleWeb.ErrorHelpers.html"},{"type":"function","title":"PlausibleWeb.ErrorHelpers.error_tag/2","doc":"","ref":"PlausibleWeb.ErrorHelpers.html#error_tag/2"},{"type":"function","title":"PlausibleWeb.ErrorHelpers.translate_error/1","doc":"","ref":"PlausibleWeb.ErrorHelpers.html#translate_error/1"},{"type":"module","title":"PlausibleWeb.ErrorReportController","doc":"","ref":"PlausibleWeb.ErrorReportController.html"},{"type":"function","title":"PlausibleWeb.ErrorReportController.submit_error_report/2","doc":"","ref":"PlausibleWeb.ErrorReportController.html#submit_error_report/2"},{"type":"module","title":"PlausibleWeb.ErrorView","doc":"","ref":"PlausibleWeb.ErrorView.html"},{"type":"function","title":"PlausibleWeb.ErrorView.404_error.html/1","doc":"","ref":"PlausibleWeb.ErrorView.html#404_error.html/1"},{"type":"function","title":"PlausibleWeb.ErrorView.__resource__/0","doc":"The resource name, as an atom, for this view","ref":"PlausibleWeb.ErrorView.html#__resource__/0"},{"type":"function","title":"PlausibleWeb.ErrorView.generic_error.html/1","doc":"","ref":"PlausibleWeb.ErrorView.html#generic_error.html/1"},{"type":"function","title":"PlausibleWeb.ErrorView.render/2","doc":"Renders the given template locally.","ref":"PlausibleWeb.ErrorView.html#render/2"},{"type":"function","title":"PlausibleWeb.ErrorView.server_error.html/1","doc":"","ref":"PlausibleWeb.ErrorView.html#server_error.html/1"},{"type":"function","title":"PlausibleWeb.ErrorView.server_error_report_thanks.html/1","doc":"","ref":"PlausibleWeb.ErrorView.html#server_error_report_thanks.html/1"},{"type":"function","title":"PlausibleWeb.ErrorView.template_not_found/2","doc":"Callback invoked when no template is found.\nBy default it raises but can be customized\nto render a particular template.","ref":"PlausibleWeb.ErrorView.html#template_not_found/2"},{"type":"module","title":"PlausibleWeb.Favicon","doc":"A Plug that fetches favicon images from DuckDuckGo and returns them\nto the Plausible frontend.\n\nThe proxying is there so we can reduce the number of third-party domains that\nthe browser clients need to connect to. Our goal is to have 0 third-party domain\nconnections on the website for privacy reasons.\n\nThis module also maps between categorized sources and their respective URLs for favicons.\nWhat does that mean exactly? During ingestion we use `PlausibleWeb.RefInspector.parse/1` to\ncategorize our referrer sources like so:\n\ngoogle.com -> Google\ngoogle.co.uk -> Google\ngoogle.com.au -> Google\n\nSo when we show Google as a source in the dashboard, the request to this plug will come as:\nhttps://plausible/io/favicon/sources/Google\n\nNow, when we want to show a favicon for Google, we need to convert Google -> google.com or\nsome other hostname owned by Google:\nhttps://icons.duckduckgo.com/ip3/google.com.ico\n\nThe mapping from source category -> source hostname is stored in \"priv/referer_favicon_domains.json\" and\nmanaged by `Mix.Tasks.GenerateReferrerFavicons.run/1`","ref":"PlausibleWeb.Favicon.html"},{"type":"function","title":"PlausibleWeb.Favicon.call/2","doc":"Proxies HTTP request to DuckDuckGo favicon service. Swallows hop-by-hop HTTP\nheaders that should not be forwarded as defined in [RFC 2616](https://www.rfc-editor.org/rfc/rfc2616#section-13.5.1)","ref":"PlausibleWeb.Favicon.html#call/2"},{"type":"function","title":"Placeholder - PlausibleWeb.Favicon.call/2","doc":"Cases where we show a placeholder icon instead:\n\n1. In case of network error to DuckDuckGo\n2. In case of non-2xx status code from DuckDuckGo\n3. In case of broken image response body from DuckDuckGo\n\nI'm not sure why DDG sometimes returns a broken PNG image in their response\nbut we filter that out. When the icon request fails, we show a placeholder\nfavicon instead. The placeholder is an emoji from\n[https://favicon.io/emoji-favicons/](https://favicon.io/emoji-favicons/)\n\nDuckDuckGo favicon service has some issues with [SVG favicons](https://css-tricks.com/svg-favicons-and-all-the-fun-things-we-can-do-with-them/).\nFor some reason, they return them with `content-type=image/x-icon` whereas SVG\nicons should be returned with `content-type=image/svg+xml`. This Plug detects\nwhen the response body starts with `<svg` and will override the `Content-Type`\nto correct it.","ref":"PlausibleWeb.Favicon.html#call/2-placeholder"},{"type":"function","title":"Preventing XSS vulnerabilities - PlausibleWeb.Favicon.call/2","doc":"SVGs may contain ` ` tags, and as these SVGs come from external\nsources, we need to prevent untrusted code from running on the browser.\n\n- This Plug sets a strict `Content-Security-Policy` header telling the browser\n not to run scripts.\n\n- This Plug sets `Content-Disposition=attachment` to prevent the SVG from\n rendering when navigating to `/favicon/sources/:domain` directly.\n\n- Browsers do not execute scripts from ` ` tags, therefore it is safe to\n use ` `","ref":"PlausibleWeb.Favicon.html#call/2-preventing-xss-vulnerabilities"},{"type":"function","title":"PlausibleWeb.Favicon.init/1","doc":"","ref":"PlausibleWeb.Favicon.html#init/1"},{"type":"module","title":"PlausibleWeb.FirstLaunchPlug","doc":"Redirects first-launch users to registration page.","ref":"PlausibleWeb.FirstLaunchPlug.html"},{"type":"module","title":"PlausibleWeb.FirstLaunchPlug.Test","doc":"Test helper for setup blocks allowing to skip the plug processing","ref":"PlausibleWeb.FirstLaunchPlug.Test.html"},{"type":"function","title":"PlausibleWeb.FirstLaunchPlug.Test.skip/1","doc":"","ref":"PlausibleWeb.FirstLaunchPlug.Test.html#skip/1"},{"type":"module","title":"PlausibleWeb.FormHelpers","doc":"","ref":"PlausibleWeb.FormHelpers.html"},{"type":"function","title":"PlausibleWeb.FormHelpers.styled_error/1","doc":"","ref":"PlausibleWeb.FormHelpers.html#styled_error/1"},{"type":"function","title":"PlausibleWeb.FormHelpers.styled_label/4","doc":"","ref":"PlausibleWeb.FormHelpers.html#styled_label/4"},{"type":"function","title":"PlausibleWeb.FormHelpers.styled_select/4","doc":"","ref":"PlausibleWeb.FormHelpers.html#styled_select/4"},{"type":"function","title":"PlausibleWeb.FormHelpers.styled_text_input/3","doc":"","ref":"PlausibleWeb.FormHelpers.html#styled_text_input/3"},{"type":"module","title":"PlausibleWeb.GoogleAnalyticsController","doc":"","ref":"PlausibleWeb.GoogleAnalyticsController.html"},{"type":"function","title":"PlausibleWeb.GoogleAnalyticsController.confirm/2","doc":"","ref":"PlausibleWeb.GoogleAnalyticsController.html#confirm/2"},{"type":"function","title":"PlausibleWeb.GoogleAnalyticsController.import/2","doc":"","ref":"PlausibleWeb.GoogleAnalyticsController.html#import/2"},{"type":"function","title":"PlausibleWeb.GoogleAnalyticsController.property/2","doc":"","ref":"PlausibleWeb.GoogleAnalyticsController.html#property/2"},{"type":"function","title":"PlausibleWeb.GoogleAnalyticsController.property_form/2","doc":"","ref":"PlausibleWeb.GoogleAnalyticsController.html#property_form/2"},{"type":"module","title":"PlausibleWeb.GoogleAnalyticsView","doc":"","ref":"PlausibleWeb.GoogleAnalyticsView.html"},{"type":"function","title":"PlausibleWeb.GoogleAnalyticsView.__resource__/0","doc":"The resource name, as an atom, for this view","ref":"PlausibleWeb.GoogleAnalyticsView.html#__resource__/0"},{"type":"function","title":"PlausibleWeb.GoogleAnalyticsView.confirm.html/1","doc":"","ref":"PlausibleWeb.GoogleAnalyticsView.html#confirm.html/1"},{"type":"function","title":"PlausibleWeb.GoogleAnalyticsView.property_form.html/1","doc":"","ref":"PlausibleWeb.GoogleAnalyticsView.html#property_form.html/1"},{"type":"function","title":"PlausibleWeb.GoogleAnalyticsView.render/2","doc":"Renders the given template locally.","ref":"PlausibleWeb.GoogleAnalyticsView.html#render/2"},{"type":"function","title":"PlausibleWeb.GoogleAnalyticsView.template_not_found/2","doc":"Callback invoked when no template is found.\nBy default it raises but can be customized\nto render a particular template.","ref":"PlausibleWeb.GoogleAnalyticsView.html#template_not_found/2"},{"type":"module","title":"PlausibleWeb.HelpScoutController","doc":"","ref":"PlausibleWeb.HelpScoutController.html"},{"type":"function","title":"PlausibleWeb.HelpScoutController.callback/2","doc":"","ref":"PlausibleWeb.HelpScoutController.html#callback/2"},{"type":"function","title":"PlausibleWeb.HelpScoutController.search/2","doc":"","ref":"PlausibleWeb.HelpScoutController.html#search/2"},{"type":"function","title":"PlausibleWeb.HelpScoutController.show/2","doc":"","ref":"PlausibleWeb.HelpScoutController.html#show/2"},{"type":"module","title":"PlausibleWeb.HelpScoutView","doc":"","ref":"PlausibleWeb.HelpScoutView.html"},{"type":"function","title":"PlausibleWeb.HelpScoutView.__resource__/0","doc":"The resource name, as an atom, for this view","ref":"PlausibleWeb.HelpScoutView.html#__resource__/0"},{"type":"function","title":"PlausibleWeb.HelpScoutView.render/2","doc":"Renders the given template locally.","ref":"PlausibleWeb.HelpScoutView.html#render/2"},{"type":"function","title":"PlausibleWeb.HelpScoutView.template_not_found/2","doc":"Callback invoked when no template is found.\nBy default it raises but can be customized\nto render a particular template.","ref":"PlausibleWeb.HelpScoutView.html#template_not_found/2"},{"type":"module","title":"PlausibleWeb.InvitationController","doc":"","ref":"PlausibleWeb.InvitationController.html"},{"type":"function","title":"PlausibleWeb.InvitationController.accept_invitation/2","doc":"","ref":"PlausibleWeb.InvitationController.html#accept_invitation/2"},{"type":"function","title":"PlausibleWeb.InvitationController.reject_invitation/2","doc":"","ref":"PlausibleWeb.InvitationController.html#reject_invitation/2"},{"type":"function","title":"PlausibleWeb.InvitationController.remove_invitation/2","doc":"","ref":"PlausibleWeb.InvitationController.html#remove_invitation/2"},{"type":"module","title":"PlausibleWeb.LastSeenPlug","doc":"","ref":"PlausibleWeb.LastSeenPlug.html"},{"type":"function","title":"PlausibleWeb.LastSeenPlug.call/2","doc":"","ref":"PlausibleWeb.LastSeenPlug.html#call/2"},{"type":"function","title":"PlausibleWeb.LastSeenPlug.init/1","doc":"","ref":"PlausibleWeb.LastSeenPlug.html#init/1"},{"type":"module","title":"PlausibleWeb.LayoutView","doc":"","ref":"PlausibleWeb.LayoutView.html"},{"type":"function","title":"PlausibleWeb.LayoutView.__resource__/0","doc":"The resource name, as an atom, for this view","ref":"PlausibleWeb.LayoutView.html#__resource__/0"},{"type":"function","title":"PlausibleWeb.LayoutView.app.html/1","doc":"","ref":"PlausibleWeb.LayoutView.html#app.html/1"},{"type":"function","title":"PlausibleWeb.LayoutView.base_email.html/1","doc":"","ref":"PlausibleWeb.LayoutView.html#base_email.html/1"},{"type":"function","title":"PlausibleWeb.LayoutView.base_error.html/1","doc":"","ref":"PlausibleWeb.LayoutView.html#base_error.html/1"},{"type":"function","title":"PlausibleWeb.LayoutView.embedded.html/1","doc":"","ref":"PlausibleWeb.LayoutView.html#embedded.html/1"},{"type":"function","title":"PlausibleWeb.LayoutView.feedback_link/1","doc":"","ref":"PlausibleWeb.LayoutView.html#feedback_link/1"},{"type":"function","title":"PlausibleWeb.LayoutView.flat_settings_options/1","doc":"","ref":"PlausibleWeb.LayoutView.html#flat_settings_options/1"},{"type":"function","title":"PlausibleWeb.LayoutView.focus.html/1","doc":"","ref":"PlausibleWeb.LayoutView.html#focus.html/1"},{"type":"function","title":"PlausibleWeb.LayoutView.grace_period_end/1","doc":"","ref":"PlausibleWeb.LayoutView.html#grace_period_end/1"},{"type":"function","title":"PlausibleWeb.LayoutView.home_dest/1","doc":"","ref":"PlausibleWeb.LayoutView.html#home_dest/1"},{"type":"function","title":"PlausibleWeb.LayoutView.is_current_tab/2","doc":"","ref":"PlausibleWeb.LayoutView.html#is_current_tab/2"},{"type":"function","title":"PlausibleWeb.LayoutView.logo_path/1","doc":"","ref":"PlausibleWeb.LayoutView.html#logo_path/1"},{"type":"function","title":"PlausibleWeb.LayoutView.plausible_url/0","doc":"","ref":"PlausibleWeb.LayoutView.html#plausible_url/0"},{"type":"function","title":"PlausibleWeb.LayoutView.priority_email.html/1","doc":"","ref":"PlausibleWeb.LayoutView.html#priority_email.html/1"},{"type":"function","title":"PlausibleWeb.LayoutView.render/2","doc":"Renders the given template locally.","ref":"PlausibleWeb.LayoutView.html#render/2"},{"type":"function","title":"PlausibleWeb.LayoutView.render_layout/3","doc":"http://blog.plataformatec.com.br/2018/05/nested-layouts-with-phoenix/","ref":"PlausibleWeb.LayoutView.html#render_layout/3"},{"type":"function","title":"PlausibleWeb.LayoutView.settings_tabs/1","doc":"","ref":"PlausibleWeb.LayoutView.html#settings_tabs/1"},{"type":"function","title":"PlausibleWeb.LayoutView.site_settings.html/1","doc":"","ref":"PlausibleWeb.LayoutView.html#site_settings.html/1"},{"type":"function","title":"PlausibleWeb.LayoutView.template_not_found/2","doc":"Callback invoked when no template is found.\nBy default it raises but can be customized\nto render a particular template.","ref":"PlausibleWeb.LayoutView.html#template_not_found/2"},{"type":"function","title":"PlausibleWeb.LayoutView.trial_notificaton/1","doc":"","ref":"PlausibleWeb.LayoutView.html#trial_notificaton/1"},{"type":"function","title":"PlausibleWeb.LayoutView.websocket_url/0","doc":"","ref":"PlausibleWeb.LayoutView.html#websocket_url/0"},{"type":"module","title":"PlausibleWeb.LayoutView.JWT","doc":"","ref":"PlausibleWeb.LayoutView.JWT.html"},{"type":"function","title":"PlausibleWeb.LayoutView.JWT.generate_and_sign/2","doc":"Combines `generate_claims/1` and `encode_and_sign/2`","ref":"PlausibleWeb.LayoutView.JWT.html#generate_and_sign/2"},{"type":"function","title":"PlausibleWeb.LayoutView.JWT.generate_and_sign!/2","doc":"Same as `generate_and_sign/2` but raises if error","ref":"PlausibleWeb.LayoutView.JWT.html#generate_and_sign!/2"},{"type":"function","title":"PlausibleWeb.LayoutView.JWT.verify_and_validate/3","doc":"Combines `verify/2` and `validate/2`","ref":"PlausibleWeb.LayoutView.JWT.html#verify_and_validate/3"},{"type":"function","title":"PlausibleWeb.LayoutView.JWT.verify_and_validate!/3","doc":"Same as `verify_and_validate/2` but raises if error","ref":"PlausibleWeb.LayoutView.JWT.html#verify_and_validate!/3"},{"type":"module","title":"PlausibleWeb.Live.AuthContext","doc":"This module supplies LiveViews with currently logged in user data _if_ session\ndata contains a valid token.\n\nMust be kept in sync with `PlausibleWeb.AuthPlug`.","ref":"PlausibleWeb.Live.AuthContext.html"},{"type":"function","title":"PlausibleWeb.Live.AuthContext.on_mount/4","doc":"","ref":"PlausibleWeb.Live.AuthContext.html#on_mount/4"},{"type":"module","title":"PlausibleWeb.Live.CSVExport","doc":"LiveView allowing scheduling, watching, downloading, and deleting S3 and local exports.","ref":"PlausibleWeb.Live.CSVExport.html"},{"type":"module","title":"PlausibleWeb.Live.CSVImport","doc":"LiveView allowing uploading CSVs for imported tables to S3 or local storage","ref":"PlausibleWeb.Live.CSVImport.html"},{"type":"module","title":"PlausibleWeb.Live.ChoosePlan","doc":"LiveView for upgrading to a plan, or changing an existing plan.","ref":"PlausibleWeb.Live.ChoosePlan.html"},{"type":"function","title":"PlausibleWeb.Live.ChoosePlan.handle_event/3","doc":"","ref":"PlausibleWeb.Live.ChoosePlan.html#handle_event/3"},{"type":"function","title":"PlausibleWeb.Live.ChoosePlan.handle_info/2","doc":"","ref":"PlausibleWeb.Live.ChoosePlan.html#handle_info/2"},{"type":"function","title":"PlausibleWeb.Live.ChoosePlan.mount/3","doc":"","ref":"PlausibleWeb.Live.ChoosePlan.html#mount/3"},{"type":"function","title":"PlausibleWeb.Live.ChoosePlan.render/1","doc":"","ref":"PlausibleWeb.Live.ChoosePlan.html#render/1"},{"type":"function","title":"PlausibleWeb.Live.ChoosePlan.two_months_free/1","doc":"","ref":"PlausibleWeb.Live.ChoosePlan.html#two_months_free/1"},{"type":"module","title":"PlausibleWeb.Live.Components.ComboBox","doc":"Phoenix LiveComponent for a combobox UI element with search and selection\nfunctionality.\n\nThe component allows users to select an option from a list of options,\nwhich can be searched by typing in the input field.\n\nThe component renders an input field with a dropdown anchor and a\nhidden input field for submitting the selected value.\n\nThe number of options displayed in the dropdown is limited to 15\nby default but can be customized. When a user types into the input\nfield, the component searches the available options and provides\nsuggestions based on the input.\n\nAny function can be supplied via `suggest_fun` attribute\n- see the provided `ComboBox.StaticSearch`.\n\nIn most cases the `suggest_fun` runs an operation that could be deferred,\nso by default, the `async={true}` attr calls it in a background Task\nand updates the suggestions asynchronously. This way, you can render\nthe component without having to wait for suggestions to load.\n\nIf you explicitly need to make the operation synchronous, you may\npass `async={false}` option.\n\nIf your initial `options` are not provided up-front at initial render,\nlack of `options` attr value combined with `async=true` calls the\n`suggest_fun.(\"\", [])` asynchronously - that special clause can be used\nto provide the initial set of suggestions updated right after the initial render.\n\nTo simplify integration testing, suggestions load up synchronously during\ntests. This lets you skip waiting for suggestions messages\nto arrive. The asynchronous behaviour alone is already tested in\nComboBox own test suite, so there is no need for additional\nverification.","ref":"PlausibleWeb.Live.Components.ComboBox.html"},{"type":"function","title":"PlausibleWeb.Live.Components.ComboBox.dropdown/1","doc":"","ref":"PlausibleWeb.Live.Components.ComboBox.html#dropdown/1"},{"type":"function","title":"Attributes - PlausibleWeb.Live.Components.ComboBox.dropdown/1","doc":"* `ref` (`:string`) (required)\n* `suggestions` (`:list`) - Defaults to `[]`.\n* `suggest_fun` (`:any`) (required)\n* `target` (`:any`)\n* `creatable` (`:boolean`) (required)\n* `display_value` (`:string`) (required)","ref":"PlausibleWeb.Live.Components.ComboBox.html#dropdown/1-attributes"},{"type":"function","title":"PlausibleWeb.Live.Components.ComboBox.dropdown_anchor/1","doc":"","ref":"PlausibleWeb.Live.Components.ComboBox.html#dropdown_anchor/1"},{"type":"function","title":"Attributes - PlausibleWeb.Live.Components.ComboBox.dropdown_anchor/1","doc":"* `id` (`:any`) (required)","ref":"PlausibleWeb.Live.Components.ComboBox.html#dropdown_anchor/1-attributes"},{"type":"function","title":"PlausibleWeb.Live.Components.ComboBox.handle_event/3","doc":"","ref":"PlausibleWeb.Live.Components.ComboBox.html#handle_event/3"},{"type":"function","title":"PlausibleWeb.Live.Components.ComboBox.option/1","doc":"","ref":"PlausibleWeb.Live.Components.ComboBox.html#option/1"},{"type":"function","title":"Attributes - PlausibleWeb.Live.Components.ComboBox.option/1","doc":"* `display_value` (`:string`) (required)\n* `submit_value` (`:string`) (required)\n* `ref` (`:string`) (required)\n* `target` (`:any`)\n* `idx` (`:integer`) (required)\n* `creatable` (`:boolean`) - Defaults to `false`.","ref":"PlausibleWeb.Live.Components.ComboBox.html#option/1-attributes"},{"type":"function","title":"PlausibleWeb.Live.Components.ComboBox.render/1","doc":"","ref":"PlausibleWeb.Live.Components.ComboBox.html#render/1"},{"type":"function","title":"Attributes - PlausibleWeb.Live.Components.ComboBox.render/1","doc":"* `placeholder` (`:string`) - Defaults to `\"Select option or search by typing\"`.\n* `id` (`:any`) (required)\n* `options` (`:list`) - Defaults to `[]`.\n* `submit_name` (`:string`) (required)\n* `display_value` (`:string`) - Defaults to `\"\"`.\n* `submit_value` (`:string`) - Defaults to `\"\"`.\n* `selected` (`:any`)\n* `suggest_fun` (`:any`) (required)\n* `suggestions_limit` (`:integer`)\n* `class` (`:string`) - Defaults to `\"\"`.\n* `required` (`:boolean`) - Defaults to `false`.\n* `creatable` (`:boolean`) - Defaults to `false`.\n* `errors` (`:list`) - Defaults to `[]`.\n* `async` (`:boolean`) - Defaults to `true`.\n* `on_selection_made` (`:any`)","ref":"PlausibleWeb.Live.Components.ComboBox.html#render/1-attributes"},{"type":"function","title":"PlausibleWeb.Live.Components.ComboBox.select_option/4","doc":"","ref":"PlausibleWeb.Live.Components.ComboBox.html#select_option/4"},{"type":"function","title":"PlausibleWeb.Live.Components.ComboBox.update/2","doc":"","ref":"PlausibleWeb.Live.Components.ComboBox.html#update/2"},{"type":"module","title":"PlausibleWeb.Live.Components.ComboBox.StaticSearch","doc":"Default suggestion engine for the `ComboBox` component.\n\nAssumes, the user have already queried the database and the data set is\nsmall enough to be kept in state and filtered based on external input.\n\nFavours exact matches. Skips entries shorter than input.\nAllows fuzzy matching based on Jaro Distance.","ref":"PlausibleWeb.Live.Components.ComboBox.StaticSearch.html"},{"type":"function","title":"PlausibleWeb.Live.Components.ComboBox.StaticSearch.suggest/3","doc":"","ref":"PlausibleWeb.Live.Components.ComboBox.StaticSearch.html#suggest/3"},{"type":"module","title":"PlausibleWeb.Live.Components.Form","doc":"Generic components stolen from mix phx.new templates","ref":"PlausibleWeb.Live.Components.Form.html"},{"type":"function","title":"PlausibleWeb.Live.Components.Form.error/1","doc":"Generates a generic error message.","ref":"PlausibleWeb.Live.Components.Form.html#error/1"},{"type":"function","title":"Slots - PlausibleWeb.Live.Components.Form.error/1","doc":"* `inner_block` (required)","ref":"PlausibleWeb.Live.Components.Form.html#error/1-slots"},{"type":"function","title":"PlausibleWeb.Live.Components.Form.input/1","doc":"Renders an input with label and error messages.\n\nA `Phoenix.HTML.FormField` may be passed as argument,\nwhich is used to retrieve the input name, id, and values.\nOtherwise all attributes may be passed explicitly.","ref":"PlausibleWeb.Live.Components.Form.html#input/1"},{"type":"function","title":"Examples - PlausibleWeb.Live.Components.Form.input/1","doc":"<.input field={@form[:email]} type=\"email\" />\n<.input name=\"my-input\" errors={[\"oh no!\"]} />","ref":"PlausibleWeb.Live.Components.Form.html#input/1-examples"},{"type":"function","title":"Attributes - PlausibleWeb.Live.Components.Form.input/1","doc":"* `id` (`:any`) - Defaults to `nil`.\n* `name` (`:any`)\n* `label` (`:string`) - Defaults to `nil`.\n* `value` (`:any`)\n* `type` (`:string`) - Defaults to `\"text\"`.\n* `field` (`Phoenix.HTML.FormField`) - a form field struct retrieved from the form, for example: @form[:email].\n* `errors` (`:list`) - Defaults to `[]`.\n* `checked` (`:boolean`) - the checked flag for checkbox inputs.\n* `prompt` (`:string`) - the prompt for select inputs. Defaults to `nil`.\n* `options` (`:list`) - the options to pass to Phoenix.HTML.Form.options_for_select/2.\n* `multiple` (`:boolean`) - the multiple flag for select inputs. Defaults to `false`.\n* Global attributes are accepted. Supports all globals plus: `[\"accept\", \"autocomplete\", \"capture\", \"cols\", \"disabled\", \"form\", \"list\", \"max\", \"maxlength\", \"min\", \"minlength\", \"multiple\", \"pattern\", \"placeholder\", \"readonly\", \"required\", \"rows\", \"size\", \"step\"]`.","ref":"PlausibleWeb.Live.Components.Form.html#input/1-attributes"},{"type":"function","title":"Slots - PlausibleWeb.Live.Components.Form.input/1","doc":"* `inner_block`","ref":"PlausibleWeb.Live.Components.Form.html#input/1-slots"},{"type":"function","title":"PlausibleWeb.Live.Components.Form.input_with_clipboard/1","doc":"","ref":"PlausibleWeb.Live.Components.Form.html#input_with_clipboard/1"},{"type":"function","title":"Attributes - PlausibleWeb.Live.Components.Form.input_with_clipboard/1","doc":"* `id` (`:string`) (required)\n* `class` (`:string`) - Defaults to `\"\"`.\n* `name` (`:string`) (required)\n* `label` (`:string`) (required)\n* `value` (`:string`) - Defaults to `\"\"`.\n* Global attributes are accepted.","ref":"PlausibleWeb.Live.Components.Form.html#input_with_clipboard/1-attributes"},{"type":"function","title":"PlausibleWeb.Live.Components.Form.label/1","doc":"Renders a label.","ref":"PlausibleWeb.Live.Components.Form.html#label/1"},{"type":"function","title":"Attributes - PlausibleWeb.Live.Components.Form.label/1","doc":"* `for` (`:string`) - Defaults to `nil`.","ref":"PlausibleWeb.Live.Components.Form.html#label/1-attributes"},{"type":"function","title":"Slots - PlausibleWeb.Live.Components.Form.label/1","doc":"* `inner_block` (required)","ref":"PlausibleWeb.Live.Components.Form.html#label/1-slots"},{"type":"function","title":"PlausibleWeb.Live.Components.Form.password_input_with_strength/1","doc":"","ref":"PlausibleWeb.Live.Components.Form.html#password_input_with_strength/1"},{"type":"function","title":"Attributes - PlausibleWeb.Live.Components.Form.password_input_with_strength/1","doc":"* `id` (`:any`) - Defaults to `nil`.\n* `label` (`:string`) - Defaults to `nil`.\n* `field` (`Phoenix.HTML.FormField`) (required) - a form field struct retrieved from the form, for example: @form[:password].\n* `strength` (`:any`)\n* Global attributes are accepted. Supports all globals plus: `[\"autocomplete\", \"disabled\", \"form\", \"maxlength\", \"minlength\", \"readonly\", \"required\", \"size\"]`.","ref":"PlausibleWeb.Live.Components.Form.html#password_input_with_strength/1-attributes"},{"type":"function","title":"PlausibleWeb.Live.Components.Form.password_length_hint/1","doc":"","ref":"PlausibleWeb.Live.Components.Form.html#password_length_hint/1"},{"type":"function","title":"Attributes - PlausibleWeb.Live.Components.Form.password_length_hint/1","doc":"* `minimum` (`:integer`) (required)\n* `class` (`:any`)\n* `ok_class` (`:any`)\n* `error_class` (`:any`)\n* `field` (`Phoenix.HTML.FormField`) (required) - a form field struct retrieved from the form, for example: @form[:password].","ref":"PlausibleWeb.Live.Components.Form.html#password_length_hint/1-attributes"},{"type":"function","title":"PlausibleWeb.Live.Components.Form.strength_meter/1","doc":"","ref":"PlausibleWeb.Live.Components.Form.html#strength_meter/1"},{"type":"function","title":"Attributes - PlausibleWeb.Live.Components.Form.strength_meter/1","doc":"* `score` (`:integer`) - Defaults to `0`.\n* `warning` (`:string`) - Defaults to `\"\"`.\n* `suggestions` (`:list`) - Defaults to `[]`.","ref":"PlausibleWeb.Live.Components.Form.html#strength_meter/1-attributes"},{"type":"function","title":"PlausibleWeb.Live.Components.Form.translate_error/1","doc":"","ref":"PlausibleWeb.Live.Components.Form.html#translate_error/1"},{"type":"module","title":"PlausibleWeb.Live.Components.Modal","doc":"LiveView implementation of modal component.\n\nThis component is a general purpose modal implementation for LiveView\nwith emphasis on keeping nested components largely agnostic of the fact\nthat they are placed in a modal and maintaining good user experience\non connections with high latency.","ref":"PlausibleWeb.Live.Components.Modal.html"},{"type":"module","title":"Usage - PlausibleWeb.Live.Components.Modal","doc":"An example use case for a modal is embedding a form inside\nexisting live view which allows adding new entries of some kind:\n\n```\n<.live_component module={Modal} id=\"some-form-modal\" :let={modal_unique_id}>\n <.live_component\n module={SomeForm}\n id={\"some-form-#{modal_unique_id}\"}\n on_save_form={\n fn entry, socket ->\n send(self(), {:entry_added, entry})\n Modal.close(socket, \"some-form-modal\")\n end\n }\n />\n</.live_component>\n```\n\nThen somewhere in the same live view the modal is rendered in:\n\n```\n<.button x-data x-on:click={Modal.JS.open(\"goals-form-modal\")}>\n + Add Entry\n</.button>\n```","ref":"PlausibleWeb.Live.Components.Modal.html#module-usage"},{"type":"module","title":"Explanation - PlausibleWeb.Live.Components.Modal","doc":"The component embedded inside the modal is always rendered when\nthe live view is mounted but is kept hidden until `Modal.JS.open`\nis called on it. On subsequent openings within the same session\nthe contents of the modal are completely remounted. This assures\nthat any stateful components inside the modal are reset to their\ninitial state. The modal component provides `modal_unique_id`\nas an argument to its inner block. Appending this ID to every\nlive components' ID nested inside the modal is important for\nconsistent state reset on every reopening. This also applies\nto live components nested inside live components embedded directly\nin the modal's inner block - then the unique ID should be also\npassed down as an attribute and appended accordingly. Appending can\nbe skipped if embedded component handles state reset explicitly\n(via, for instance, `phx-click-away` callback).\n\n`Modal` exposes a number of functions for managing window state:\n\n * `Modal.JS.preopen/1` - to preopen the modal on the frontend.\n Useful when the actual opening is done server-side with\n `Modal.open/2` - helps avoid lack of feedback to the end user\n when server-side state change before opening the modal is\n still in progress.\n * `Modal.JS.open/1` - to open the modal from the frontend. It's\n important to make sure the element triggering that call is\n wrapped in an Alpine UI component - or is an Alpine component\n itself - adding `x-data` attribute without any value is enough\n to ensure that.\n * `Modal.open/2` - to open the modal from the backend; usually\n called from `handle_event/2` of component wrapping the modal\n and providing the state. Should be used together with\n `Modal.JS.preopen/1` for optimal user experience.\n * `Modal.close/2` - to close the modal from the backend; usually\n done inside wrapped component's `handle_event/2`. The example\n quoted above shows one way to implement this, under that assumption\n that the component exposes a callback, like this:\n\n ```\n defmodule SomeForm do\n use Phoenix.LiveComponent\n\n def update(assigns, socket) do\n # ...\n\n {:ok, assign(socket, :on_save_form, assigns.on_save_form)}\n end\n\n #...\n\n def handle_event(\"save-form\", %{\"form\" => form}, socket) do\n case save_entry(form) do\n {:ok, entry} ->\n {:noreply, socket.assigns.on_save_form(entry, socket)}\n\n # error case handling ...\n end\n end\n end\n ```\n\n Using callback approach has an added benefit of making the\n component more flexible.","ref":"PlausibleWeb.Live.Components.Modal.html#module-explanation"},{"type":"function","title":"PlausibleWeb.Live.Components.Modal.close/2","doc":"","ref":"PlausibleWeb.Live.Components.Modal.html#close/2"},{"type":"function","title":"PlausibleWeb.Live.Components.Modal.open/2","doc":"","ref":"PlausibleWeb.Live.Components.Modal.html#open/2"},{"type":"function","title":"PlausibleWeb.Live.Components.Modal.render/1","doc":"","ref":"PlausibleWeb.Live.Components.Modal.html#render/1"},{"type":"function","title":"Attributes - PlausibleWeb.Live.Components.Modal.render/1","doc":"* `id` (`:any`) (required)\n* `class` (`:string`) - Defaults to `\"\"`.\n* `preload?` (`:boolean`) - Defaults to `true`.","ref":"PlausibleWeb.Live.Components.Modal.html#render/1-attributes"},{"type":"function","title":"Slots - PlausibleWeb.Live.Components.Modal.render/1","doc":"* `inner_block` (required)","ref":"PlausibleWeb.Live.Components.Modal.html#render/1-slots"},{"type":"module","title":"PlausibleWeb.Live.Components.Pagination","doc":"Pagination components for LiveViews.","ref":"PlausibleWeb.Live.Components.Pagination.html"},{"type":"function","title":"PlausibleWeb.Live.Components.Pagination.pagination/1","doc":"","ref":"PlausibleWeb.Live.Components.Pagination.html#pagination/1"},{"type":"module","title":"PlausibleWeb.Live.Components.Verification","doc":"This component is responsible for rendering the verification progress\nand diagnostics.","ref":"PlausibleWeb.Live.Components.Verification.html"},{"type":"function","title":"PlausibleWeb.Live.Components.Verification.render/1","doc":"","ref":"PlausibleWeb.Live.Components.Verification.html#render/1"},{"type":"function","title":"Attributes - PlausibleWeb.Live.Components.Verification.render/1","doc":"* `domain` (`:string`) (required)\n* `modal?` (`:boolean`) - Defaults to `false`.\n* `message` (`:string`) - Defaults to `\"We're visiting your site to ensure that everything is working\"`.\n* `finished?` (`:boolean`) - Defaults to `false`.\n* `success?` (`:boolean`) - Defaults to `false`.\n* `interpretation` (`Plausible.Verification.Diagnostics.Result`) - Defaults to `nil`.\n* `attempts` (`:integer`) - Defaults to `0`.\n* `flow` (`:string`) - Defaults to `\"\"`.","ref":"PlausibleWeb.Live.Components.Verification.html#render/1-attributes"},{"type":"module","title":"PlausibleWeb.Live.Components.Visitors","doc":"Component rendering mini-graph of site's visitors over the last 24 hours.\n\nThe `gradient_defs` component should be rendered once before using `chart`\none or more times.\n\nAccepts input generated via `Plausible.Stats.Clickhouse.last_24h_visitors_hourly_intervals/2`.","ref":"PlausibleWeb.Live.Components.Visitors.html"},{"type":"function","title":"PlausibleWeb.Live.Components.Visitors.chart/1","doc":"","ref":"PlausibleWeb.Live.Components.Visitors.html#chart/1"},{"type":"function","title":"Attributes - PlausibleWeb.Live.Components.Visitors.chart/1","doc":"* `intervals` (`:list`) (required)\n* `height` (`:integer`) - Defaults to `50`.\n* `tick` (`:integer`) - Defaults to `20`.","ref":"PlausibleWeb.Live.Components.Visitors.html#chart/1-attributes"},{"type":"function","title":"PlausibleWeb.Live.Components.Visitors.gradient_defs/1","doc":"","ref":"PlausibleWeb.Live.Components.Visitors.html#gradient_defs/1"},{"type":"module","title":"PlausibleWeb.Live.Flash","doc":"Flash component for LiveViews - works also when embedded within dead views","ref":"PlausibleWeb.Live.Flash.html"},{"type":"function","title":"PlausibleWeb.Live.Flash.clear_flash_button/1","doc":"","ref":"PlausibleWeb.Live.Flash.html#clear_flash_button/1"},{"type":"function","title":"PlausibleWeb.Live.Flash.flash/1","doc":"","ref":"PlausibleWeb.Live.Flash.html#flash/1"},{"type":"function","title":"Attributes - PlausibleWeb.Live.Flash.flash/1","doc":"* `key` (`:string`) - Defaults to `nil`.\n* `on_close` (`:any`) - Defaults to `\"lv:clear-flash\"`.\n* `class` (`:string`) - Defaults to `\"\"`.\n* Global attributes are accepted.","ref":"PlausibleWeb.Live.Flash.html#flash/1-attributes"},{"type":"function","title":"Slots - PlausibleWeb.Live.Flash.flash/1","doc":"* `icon` (required)\n* `title`\n* `message` (required)","ref":"PlausibleWeb.Live.Flash.html#flash/1-slots"},{"type":"function","title":"PlausibleWeb.Live.Flash.flash_messages/1","doc":"","ref":"PlausibleWeb.Live.Flash.html#flash_messages/1"},{"type":"function","title":"PlausibleWeb.Live.Flash.icon_error/1","doc":"","ref":"PlausibleWeb.Live.Flash.html#icon_error/1"},{"type":"function","title":"PlausibleWeb.Live.Flash.icon_success/1","doc":"","ref":"PlausibleWeb.Live.Flash.html#icon_success/1"},{"type":"function","title":"PlausibleWeb.Live.Flash.put_live_flash/3","doc":"","ref":"PlausibleWeb.Live.Flash.html#put_live_flash/3"},{"type":"module","title":"PlausibleWeb.Live.FunnelSettings","doc":"LiveView allowing listing, creating and deleting funnels.","ref":"PlausibleWeb.Live.FunnelSettings.html"},{"type":"function","title":"PlausibleWeb.Live.FunnelSettings.handle_event/3","doc":"","ref":"PlausibleWeb.Live.FunnelSettings.html#handle_event/3"},{"type":"function","title":"PlausibleWeb.Live.FunnelSettings.handle_info/2","doc":"","ref":"PlausibleWeb.Live.FunnelSettings.html#handle_info/2"},{"type":"function","title":"PlausibleWeb.Live.FunnelSettings.mount/3","doc":"","ref":"PlausibleWeb.Live.FunnelSettings.html#mount/3"},{"type":"function","title":"PlausibleWeb.Live.FunnelSettings.render/1","doc":"","ref":"PlausibleWeb.Live.FunnelSettings.html#render/1"},{"type":"module","title":"PlausibleWeb.Live.FunnelSettings.Form","doc":"Phoenix LiveComponent that renders a form used for setting up funnels.\nMakes use of dynamically placed `PlausibleWeb.Live.FunnelSettings.ComboBox` components\nto allow building searchable funnel definitions out of list of goals available.","ref":"PlausibleWeb.Live.FunnelSettings.Form.html"},{"type":"function","title":"PlausibleWeb.Live.FunnelSettings.Form.add_step_button/1","doc":"","ref":"PlausibleWeb.Live.FunnelSettings.Form.html#add_step_button/1"},{"type":"function","title":"PlausibleWeb.Live.FunnelSettings.Form.evaluation/1","doc":"","ref":"PlausibleWeb.Live.FunnelSettings.Form.html#evaluation/1"},{"type":"function","title":"Attributes - PlausibleWeb.Live.FunnelSettings.Form.evaluation/1","doc":"* `at` (`:integer`) (required)\n* `result` (`:map`) (required)","ref":"PlausibleWeb.Live.FunnelSettings.Form.html#evaluation/1-attributes"},{"type":"function","title":"PlausibleWeb.Live.FunnelSettings.Form.handle_event/3","doc":"","ref":"PlausibleWeb.Live.FunnelSettings.Form.html#handle_event/3"},{"type":"function","title":"PlausibleWeb.Live.FunnelSettings.Form.handle_info/2","doc":"","ref":"PlausibleWeb.Live.FunnelSettings.Form.html#handle_info/2"},{"type":"function","title":"PlausibleWeb.Live.FunnelSettings.Form.mount/3","doc":"","ref":"PlausibleWeb.Live.FunnelSettings.Form.html#mount/3"},{"type":"function","title":"PlausibleWeb.Live.FunnelSettings.Form.remove_step_button/1","doc":"","ref":"PlausibleWeb.Live.FunnelSettings.Form.html#remove_step_button/1"},{"type":"function","title":"Attributes - PlausibleWeb.Live.FunnelSettings.Form.remove_step_button/1","doc":"* `step_idx` (`:integer`) (required)","ref":"PlausibleWeb.Live.FunnelSettings.Form.html#remove_step_button/1-attributes"},{"type":"function","title":"PlausibleWeb.Live.FunnelSettings.Form.render/1","doc":"","ref":"PlausibleWeb.Live.FunnelSettings.Form.html#render/1"},{"type":"module","title":"PlausibleWeb.Live.FunnelSettings.List","doc":"Phoenix LiveComponent module that renders a list of funnels with their names\nand the number of steps they have.\n\nEach funnel is displayed with a delete button, which triggers a confirmation\nmessage before deleting the funnel from the UI. If there are no funnels\nconfigured for the site, a message is displayed indicating so.","ref":"PlausibleWeb.Live.FunnelSettings.List.html"},{"type":"function","title":"PlausibleWeb.Live.FunnelSettings.List.render/1","doc":"","ref":"PlausibleWeb.Live.FunnelSettings.List.html#render/1"},{"type":"module","title":"PlausibleWeb.Live.GoalSettings","doc":"LiveView allowing listing, creating and deleting goals.","ref":"PlausibleWeb.Live.GoalSettings.html"},{"type":"function","title":"PlausibleWeb.Live.GoalSettings.handle_event/3","doc":"","ref":"PlausibleWeb.Live.GoalSettings.html#handle_event/3"},{"type":"function","title":"PlausibleWeb.Live.GoalSettings.handle_info/2","doc":"","ref":"PlausibleWeb.Live.GoalSettings.html#handle_info/2"},{"type":"function","title":"PlausibleWeb.Live.GoalSettings.mount/3","doc":"","ref":"PlausibleWeb.Live.GoalSettings.html#mount/3"},{"type":"function","title":"PlausibleWeb.Live.GoalSettings.render/1","doc":"","ref":"PlausibleWeb.Live.GoalSettings.html#render/1"},{"type":"module","title":"PlausibleWeb.Live.GoalSettings.Form","doc":"Live view for the goal creation form","ref":"PlausibleWeb.Live.GoalSettings.Form.html"},{"type":"function","title":"PlausibleWeb.Live.GoalSettings.Form.create_form/1","doc":"","ref":"PlausibleWeb.Live.GoalSettings.Form.html#create_form/1"},{"type":"function","title":"PlausibleWeb.Live.GoalSettings.Form.custom_event_fields/1","doc":"","ref":"PlausibleWeb.Live.GoalSettings.Form.html#custom_event_fields/1"},{"type":"function","title":"Attributes - PlausibleWeb.Live.GoalSettings.Form.custom_event_fields/1","doc":"* `f` (`Phoenix.HTML.Form`)\n* `site` (`Plausible.Site`)\n* `current_user` (`Plausible.Auth.User`)\n* `suffix` (`:string`)\n* `existing_goals` (`:list`)\n* `goal_options` (`:list`)\n* `goal` (`Plausible.Goal`) - Defaults to `nil`.\n* `has_access_to_revenue_goals?` (`:boolean`)\n* Global attributes are accepted.","ref":"PlausibleWeb.Live.GoalSettings.Form.html#custom_event_fields/1-attributes"},{"type":"function","title":"PlausibleWeb.Live.GoalSettings.Form.edit_form/1","doc":"","ref":"PlausibleWeb.Live.GoalSettings.Form.html#edit_form/1"},{"type":"function","title":"PlausibleWeb.Live.GoalSettings.Form.handle_event/3","doc":"","ref":"PlausibleWeb.Live.GoalSettings.Form.html#handle_event/3"},{"type":"function","title":"PlausibleWeb.Live.GoalSettings.Form.pageview_fields/1","doc":"","ref":"PlausibleWeb.Live.GoalSettings.Form.html#pageview_fields/1"},{"type":"function","title":"Attributes - PlausibleWeb.Live.GoalSettings.Form.pageview_fields/1","doc":"* `f` (`Phoenix.HTML.Form`)\n* `site` (`Plausible.Site`)\n* `suffix` (`:string`)\n* `goal` (`Plausible.Goal`) - Defaults to `nil`.\n* Global attributes are accepted.","ref":"PlausibleWeb.Live.GoalSettings.Form.html#pageview_fields/1-attributes"},{"type":"function","title":"PlausibleWeb.Live.GoalSettings.Form.pageviews_tab/1","doc":"","ref":"PlausibleWeb.Live.GoalSettings.Form.html#pageviews_tab/1"},{"type":"function","title":"PlausibleWeb.Live.GoalSettings.Form.render/1","doc":"","ref":"PlausibleWeb.Live.GoalSettings.Form.html#render/1"},{"type":"function","title":"PlausibleWeb.Live.GoalSettings.Form.revenue_goal_settings/1","doc":"","ref":"PlausibleWeb.Live.GoalSettings.Form.html#revenue_goal_settings/1"},{"type":"function","title":"PlausibleWeb.Live.GoalSettings.Form.suggest_event_names/3","doc":"","ref":"PlausibleWeb.Live.GoalSettings.Form.html#suggest_event_names/3"},{"type":"function","title":"PlausibleWeb.Live.GoalSettings.Form.suggest_page_paths/2","doc":"","ref":"PlausibleWeb.Live.GoalSettings.Form.html#suggest_page_paths/2"},{"type":"function","title":"PlausibleWeb.Live.GoalSettings.Form.tabs/1","doc":"","ref":"PlausibleWeb.Live.GoalSettings.Form.html#tabs/1"},{"type":"function","title":"PlausibleWeb.Live.GoalSettings.Form.update/2","doc":"","ref":"PlausibleWeb.Live.GoalSettings.Form.html#update/2"},{"type":"module","title":"PlausibleWeb.Live.GoalSettings.List","doc":"Phoenix LiveComponent module that renders a list of goals","ref":"PlausibleWeb.Live.GoalSettings.List.html"},{"type":"function","title":"PlausibleWeb.Live.GoalSettings.List.custom_event_description/1","doc":"","ref":"PlausibleWeb.Live.GoalSettings.List.html#custom_event_description/1"},{"type":"function","title":"PlausibleWeb.Live.GoalSettings.List.goal_description/1","doc":"","ref":"PlausibleWeb.Live.GoalSettings.List.html#goal_description/1"},{"type":"function","title":"PlausibleWeb.Live.GoalSettings.List.pageview_description/1","doc":"","ref":"PlausibleWeb.Live.GoalSettings.List.html#pageview_description/1"},{"type":"function","title":"PlausibleWeb.Live.GoalSettings.List.render/1","doc":"","ref":"PlausibleWeb.Live.GoalSettings.List.html#render/1"},{"type":"function","title":"Attributes - PlausibleWeb.Live.GoalSettings.List.render/1","doc":"* `goals` (`:list`) (required)\n* `domain` (`:string`) (required)\n* `filter_text` (`:string`)\n* `site` (`Plausible.Site`) (required)","ref":"PlausibleWeb.Live.GoalSettings.List.html#render/1-attributes"},{"type":"module","title":"PlausibleWeb.Live.ImportsExportsSettings","doc":"LiveView allowing listing and deleting imports.","ref":"PlausibleWeb.Live.ImportsExportsSettings.html"},{"type":"function","title":"PlausibleWeb.Live.ImportsExportsSettings.handle_info/2","doc":"","ref":"PlausibleWeb.Live.ImportsExportsSettings.html#handle_info/2"},{"type":"function","title":"PlausibleWeb.Live.ImportsExportsSettings.mount/3","doc":"","ref":"PlausibleWeb.Live.ImportsExportsSettings.html#mount/3"},{"type":"function","title":"PlausibleWeb.Live.ImportsExportsSettings.render/1","doc":"","ref":"PlausibleWeb.Live.ImportsExportsSettings.html#render/1"},{"type":"module","title":"PlausibleWeb.Live.Plugins.API.Settings","doc":"LiveView allowing listing, creating and revoking Plugins API tokens.","ref":"PlausibleWeb.Live.Plugins.API.Settings.html"},{"type":"function","title":"PlausibleWeb.Live.Plugins.API.Settings.handle_event/3","doc":"","ref":"PlausibleWeb.Live.Plugins.API.Settings.html#handle_event/3"},{"type":"function","title":"PlausibleWeb.Live.Plugins.API.Settings.handle_info/2","doc":"","ref":"PlausibleWeb.Live.Plugins.API.Settings.html#handle_info/2"},{"type":"function","title":"PlausibleWeb.Live.Plugins.API.Settings.mount/3","doc":"","ref":"PlausibleWeb.Live.Plugins.API.Settings.html#mount/3"},{"type":"function","title":"PlausibleWeb.Live.Plugins.API.Settings.render/1","doc":"","ref":"PlausibleWeb.Live.Plugins.API.Settings.html#render/1"},{"type":"module","title":"PlausibleWeb.Live.Plugins.API.TokenForm","doc":"Live view for the goal creation form","ref":"PlausibleWeb.Live.Plugins.API.TokenForm.html"},{"type":"function","title":"PlausibleWeb.Live.Plugins.API.TokenForm.handle_event/3","doc":"","ref":"PlausibleWeb.Live.Plugins.API.TokenForm.html#handle_event/3"},{"type":"function","title":"PlausibleWeb.Live.Plugins.API.TokenForm.handle_info/2","doc":"","ref":"PlausibleWeb.Live.Plugins.API.TokenForm.html#handle_info/2"},{"type":"function","title":"PlausibleWeb.Live.Plugins.API.TokenForm.mount/3","doc":"","ref":"PlausibleWeb.Live.Plugins.API.TokenForm.html#mount/3"},{"type":"function","title":"PlausibleWeb.Live.Plugins.API.TokenForm.render/1","doc":"","ref":"PlausibleWeb.Live.Plugins.API.TokenForm.html#render/1"},{"type":"module","title":"PlausibleWeb.Live.PropsSettings","doc":"LiveView allowing listing, allowing and disallowing custom event properties.","ref":"PlausibleWeb.Live.PropsSettings.html"},{"type":"function","title":"PlausibleWeb.Live.PropsSettings.handle_event/3","doc":"","ref":"PlausibleWeb.Live.PropsSettings.html#handle_event/3"},{"type":"function","title":"PlausibleWeb.Live.PropsSettings.handle_info/2","doc":"","ref":"PlausibleWeb.Live.PropsSettings.html#handle_info/2"},{"type":"function","title":"PlausibleWeb.Live.PropsSettings.mount/3","doc":"","ref":"PlausibleWeb.Live.PropsSettings.html#mount/3"},{"type":"function","title":"PlausibleWeb.Live.PropsSettings.render/1","doc":"","ref":"PlausibleWeb.Live.PropsSettings.html#render/1"},{"type":"module","title":"PlausibleWeb.Live.PropsSettings.Form","doc":"Live view for the custom props creation form","ref":"PlausibleWeb.Live.PropsSettings.Form.html"},{"type":"function","title":"PlausibleWeb.Live.PropsSettings.Form.handle_event/3","doc":"","ref":"PlausibleWeb.Live.PropsSettings.Form.html#handle_event/3"},{"type":"function","title":"PlausibleWeb.Live.PropsSettings.Form.handle_info/2","doc":"","ref":"PlausibleWeb.Live.PropsSettings.Form.html#handle_info/2"},{"type":"function","title":"PlausibleWeb.Live.PropsSettings.Form.mount/3","doc":"","ref":"PlausibleWeb.Live.PropsSettings.Form.html#mount/3"},{"type":"function","title":"PlausibleWeb.Live.PropsSettings.Form.render/1","doc":"","ref":"PlausibleWeb.Live.PropsSettings.Form.html#render/1"},{"type":"module","title":"PlausibleWeb.Live.PropsSettings.List","doc":"Phoenix LiveComponent module that renders a list of custom properties","ref":"PlausibleWeb.Live.PropsSettings.List.html"},{"type":"function","title":"PlausibleWeb.Live.PropsSettings.List.render/1","doc":"","ref":"PlausibleWeb.Live.PropsSettings.List.html#render/1"},{"type":"function","title":"Attributes - PlausibleWeb.Live.PropsSettings.List.render/1","doc":"* `props` (`:list`) (required)\n* `domain` (`:string`) (required)\n* `filter_text` (`:string`)","ref":"PlausibleWeb.Live.PropsSettings.List.html#render/1-attributes"},{"type":"module","title":"PlausibleWeb.Live.RegisterForm","doc":"LiveView for registration form.","ref":"PlausibleWeb.Live.RegisterForm.html"},{"type":"function","title":"PlausibleWeb.Live.RegisterForm.handle_event/3","doc":"","ref":"PlausibleWeb.Live.RegisterForm.html#handle_event/3"},{"type":"function","title":"PlausibleWeb.Live.RegisterForm.handle_info/2","doc":"","ref":"PlausibleWeb.Live.RegisterForm.html#handle_info/2"},{"type":"function","title":"PlausibleWeb.Live.RegisterForm.mount/3","doc":"","ref":"PlausibleWeb.Live.RegisterForm.html#mount/3"},{"type":"function","title":"PlausibleWeb.Live.RegisterForm.render/1","doc":"","ref":"PlausibleWeb.Live.RegisterForm.html#render/1"},{"type":"module","title":"PlausibleWeb.Live.ResetPasswordForm","doc":"LiveView for password reset form.","ref":"PlausibleWeb.Live.ResetPasswordForm.html"},{"type":"function","title":"PlausibleWeb.Live.ResetPasswordForm.handle_event/3","doc":"","ref":"PlausibleWeb.Live.ResetPasswordForm.html#handle_event/3"},{"type":"function","title":"PlausibleWeb.Live.ResetPasswordForm.handle_info/2","doc":"","ref":"PlausibleWeb.Live.ResetPasswordForm.html#handle_info/2"},{"type":"function","title":"PlausibleWeb.Live.ResetPasswordForm.mount/3","doc":"","ref":"PlausibleWeb.Live.ResetPasswordForm.html#mount/3"},{"type":"function","title":"PlausibleWeb.Live.ResetPasswordForm.render/1","doc":"","ref":"PlausibleWeb.Live.ResetPasswordForm.html#render/1"},{"type":"module","title":"PlausibleWeb.Live.SentryContext","doc":"This module tries to supply LiveViews with some common Sentry context\n(without it, there is practically none).\n\nUse via `use PlausibleWeb.Live.SentryContext` in your LiveView module,\nor preferably via `use PlausibleWeb, :live_view`.\n\nIn case you have multiple LiveViews, there is `use PlausibleWeb, live_view: :no_sentry_context`\nexposed that allows you to skip using this module. This is because\nonly the root LiveView has access to `connect_info` and an exception will be\nthrown otherwise.","ref":"PlausibleWeb.Live.SentryContext.html"},{"type":"function","title":"PlausibleWeb.Live.SentryContext.on_mount/4","doc":"","ref":"PlausibleWeb.Live.SentryContext.html#on_mount/4"},{"type":"module","title":"PlausibleWeb.Live.Shields.Countries","doc":"LiveView for IP Addresses Shield","ref":"PlausibleWeb.Live.Shields.Countries.html"},{"type":"function","title":"PlausibleWeb.Live.Shields.Countries.handle_info/2","doc":"","ref":"PlausibleWeb.Live.Shields.Countries.html#handle_info/2"},{"type":"function","title":"PlausibleWeb.Live.Shields.Countries.mount/3","doc":"","ref":"PlausibleWeb.Live.Shields.Countries.html#mount/3"},{"type":"function","title":"PlausibleWeb.Live.Shields.Countries.render/1","doc":"","ref":"PlausibleWeb.Live.Shields.Countries.html#render/1"},{"type":"module","title":"PlausibleWeb.Live.Shields.CountryRules","doc":"LiveView allowing Country Rules management","ref":"PlausibleWeb.Live.Shields.CountryRules.html"},{"type":"function","title":"PlausibleWeb.Live.Shields.CountryRules.handle_event/3","doc":"","ref":"PlausibleWeb.Live.Shields.CountryRules.html#handle_event/3"},{"type":"function","title":"PlausibleWeb.Live.Shields.CountryRules.render/1","doc":"","ref":"PlausibleWeb.Live.Shields.CountryRules.html#render/1"},{"type":"function","title":"PlausibleWeb.Live.Shields.CountryRules.send_flash/2","doc":"","ref":"PlausibleWeb.Live.Shields.CountryRules.html#send_flash/2"},{"type":"function","title":"PlausibleWeb.Live.Shields.CountryRules.update/2","doc":"","ref":"PlausibleWeb.Live.Shields.CountryRules.html#update/2"},{"type":"module","title":"PlausibleWeb.Live.Shields.HostnameRules","doc":"LiveView allowing hostname Rules management","ref":"PlausibleWeb.Live.Shields.HostnameRules.html"},{"type":"function","title":"PlausibleWeb.Live.Shields.HostnameRules.handle_event/3","doc":"","ref":"PlausibleWeb.Live.Shields.HostnameRules.html#handle_event/3"},{"type":"function","title":"PlausibleWeb.Live.Shields.HostnameRules.render/1","doc":"","ref":"PlausibleWeb.Live.Shields.HostnameRules.html#render/1"},{"type":"function","title":"PlausibleWeb.Live.Shields.HostnameRules.send_flash/2","doc":"","ref":"PlausibleWeb.Live.Shields.HostnameRules.html#send_flash/2"},{"type":"function","title":"PlausibleWeb.Live.Shields.HostnameRules.suggest_hostnames/3","doc":"","ref":"PlausibleWeb.Live.Shields.HostnameRules.html#suggest_hostnames/3"},{"type":"function","title":"PlausibleWeb.Live.Shields.HostnameRules.update/2","doc":"","ref":"PlausibleWeb.Live.Shields.HostnameRules.html#update/2"},{"type":"module","title":"PlausibleWeb.Live.Shields.Hostnames","doc":"LiveView for Hostnames Shield","ref":"PlausibleWeb.Live.Shields.Hostnames.html"},{"type":"function","title":"PlausibleWeb.Live.Shields.Hostnames.handle_info/2","doc":"","ref":"PlausibleWeb.Live.Shields.Hostnames.html#handle_info/2"},{"type":"function","title":"PlausibleWeb.Live.Shields.Hostnames.mount/3","doc":"","ref":"PlausibleWeb.Live.Shields.Hostnames.html#mount/3"},{"type":"function","title":"PlausibleWeb.Live.Shields.Hostnames.render/1","doc":"","ref":"PlausibleWeb.Live.Shields.Hostnames.html#render/1"},{"type":"module","title":"PlausibleWeb.Live.Shields.IPAddresses","doc":"LiveView for IP Addresses Shield","ref":"PlausibleWeb.Live.Shields.IPAddresses.html"},{"type":"function","title":"PlausibleWeb.Live.Shields.IPAddresses.handle_info/2","doc":"","ref":"PlausibleWeb.Live.Shields.IPAddresses.html#handle_info/2"},{"type":"function","title":"PlausibleWeb.Live.Shields.IPAddresses.mount/3","doc":"","ref":"PlausibleWeb.Live.Shields.IPAddresses.html#mount/3"},{"type":"function","title":"PlausibleWeb.Live.Shields.IPAddresses.render/1","doc":"","ref":"PlausibleWeb.Live.Shields.IPAddresses.html#render/1"},{"type":"module","title":"PlausibleWeb.Live.Shields.IPRules","doc":"LiveView allowing IP Rules management","ref":"PlausibleWeb.Live.Shields.IPRules.html"},{"type":"function","title":"PlausibleWeb.Live.Shields.IPRules.handle_event/3","doc":"","ref":"PlausibleWeb.Live.Shields.IPRules.html#handle_event/3"},{"type":"function","title":"PlausibleWeb.Live.Shields.IPRules.render/1","doc":"","ref":"PlausibleWeb.Live.Shields.IPRules.html#render/1"},{"type":"function","title":"PlausibleWeb.Live.Shields.IPRules.send_flash/2","doc":"","ref":"PlausibleWeb.Live.Shields.IPRules.html#send_flash/2"},{"type":"function","title":"PlausibleWeb.Live.Shields.IPRules.update/2","doc":"","ref":"PlausibleWeb.Live.Shields.IPRules.html#update/2"},{"type":"module","title":"PlausibleWeb.Live.Shields.PageRules","doc":"LiveView allowing page Rules management","ref":"PlausibleWeb.Live.Shields.PageRules.html"},{"type":"function","title":"PlausibleWeb.Live.Shields.PageRules.handle_event/3","doc":"","ref":"PlausibleWeb.Live.Shields.PageRules.html#handle_event/3"},{"type":"function","title":"PlausibleWeb.Live.Shields.PageRules.render/1","doc":"","ref":"PlausibleWeb.Live.Shields.PageRules.html#render/1"},{"type":"function","title":"PlausibleWeb.Live.Shields.PageRules.send_flash/2","doc":"","ref":"PlausibleWeb.Live.Shields.PageRules.html#send_flash/2"},{"type":"function","title":"PlausibleWeb.Live.Shields.PageRules.suggest_page_paths/3","doc":"","ref":"PlausibleWeb.Live.Shields.PageRules.html#suggest_page_paths/3"},{"type":"function","title":"PlausibleWeb.Live.Shields.PageRules.update/2","doc":"","ref":"PlausibleWeb.Live.Shields.PageRules.html#update/2"},{"type":"module","title":"PlausibleWeb.Live.Shields.Pages","doc":"LiveView for IP Addresses Shield","ref":"PlausibleWeb.Live.Shields.Pages.html"},{"type":"function","title":"PlausibleWeb.Live.Shields.Pages.handle_info/2","doc":"","ref":"PlausibleWeb.Live.Shields.Pages.html#handle_info/2"},{"type":"function","title":"PlausibleWeb.Live.Shields.Pages.mount/3","doc":"","ref":"PlausibleWeb.Live.Shields.Pages.html#mount/3"},{"type":"function","title":"PlausibleWeb.Live.Shields.Pages.render/1","doc":"","ref":"PlausibleWeb.Live.Shields.Pages.html#render/1"},{"type":"module","title":"PlausibleWeb.Live.Sites","doc":"LiveView for sites index.","ref":"PlausibleWeb.Live.Sites.html"},{"type":"function","title":"PlausibleWeb.Live.Sites.ellipsis_menu/1","doc":"","ref":"PlausibleWeb.Live.Sites.html#ellipsis_menu/1"},{"type":"function","title":"PlausibleWeb.Live.Sites.favicon/1","doc":"","ref":"PlausibleWeb.Live.Sites.html#favicon/1"},{"type":"function","title":"PlausibleWeb.Live.Sites.handle_event/3","doc":"","ref":"PlausibleWeb.Live.Sites.html#handle_event/3"},{"type":"function","title":"PlausibleWeb.Live.Sites.handle_info/2","doc":"","ref":"PlausibleWeb.Live.Sites.html#handle_info/2"},{"type":"function","title":"PlausibleWeb.Live.Sites.handle_params/3","doc":"","ref":"PlausibleWeb.Live.Sites.html#handle_params/3"},{"type":"function","title":"PlausibleWeb.Live.Sites.icon_pin/1","doc":"","ref":"PlausibleWeb.Live.Sites.html#icon_pin/1"},{"type":"function","title":"Attributes - PlausibleWeb.Live.Sites.icon_pin/1","doc":"* Global attributes are accepted.","ref":"PlausibleWeb.Live.Sites.html#icon_pin/1-attributes"},{"type":"function","title":"PlausibleWeb.Live.Sites.invitation/1","doc":"","ref":"PlausibleWeb.Live.Sites.html#invitation/1"},{"type":"function","title":"Attributes - PlausibleWeb.Live.Sites.invitation/1","doc":"* `site` (`Plausible.Site`) (required)\n* `invitation` (`Plausible.Auth.Invitation`) (required)\n* `hourly_stats` (`:map`) (required)","ref":"PlausibleWeb.Live.Sites.html#invitation/1-attributes"},{"type":"function","title":"PlausibleWeb.Live.Sites.invitation_modal/1","doc":"","ref":"PlausibleWeb.Live.Sites.html#invitation_modal/1"},{"type":"function","title":"PlausibleWeb.Live.Sites.mount/3","doc":"","ref":"PlausibleWeb.Live.Sites.html#mount/3"},{"type":"function","title":"PlausibleWeb.Live.Sites.percentage_change/1","doc":"","ref":"PlausibleWeb.Live.Sites.html#percentage_change/1"},{"type":"function","title":"Attributes - PlausibleWeb.Live.Sites.percentage_change/1","doc":"* `change` (`:integer`) (required)","ref":"PlausibleWeb.Live.Sites.html#percentage_change/1-attributes"},{"type":"function","title":"PlausibleWeb.Live.Sites.render/1","doc":"","ref":"PlausibleWeb.Live.Sites.html#render/1"},{"type":"function","title":"PlausibleWeb.Live.Sites.search_form/1","doc":"","ref":"PlausibleWeb.Live.Sites.html#search_form/1"},{"type":"function","title":"Attributes - PlausibleWeb.Live.Sites.search_form/1","doc":"* `filter_text` (`:string`) - Defaults to `\"\"`.\n* `uri` (`URI`) (required)","ref":"PlausibleWeb.Live.Sites.html#search_form/1-attributes"},{"type":"function","title":"PlausibleWeb.Live.Sites.site/1","doc":"","ref":"PlausibleWeb.Live.Sites.html#site/1"},{"type":"function","title":"Attributes - PlausibleWeb.Live.Sites.site/1","doc":"* `site` (`Plausible.Site`) (required)\n* `hourly_stats` (`:map`) (required)","ref":"PlausibleWeb.Live.Sites.html#site/1-attributes"},{"type":"function","title":"PlausibleWeb.Live.Sites.site_stats/1","doc":"","ref":"PlausibleWeb.Live.Sites.html#site_stats/1"},{"type":"function","title":"Attributes - PlausibleWeb.Live.Sites.site_stats/1","doc":"* `hourly_stats` (`:map`) (required)","ref":"PlausibleWeb.Live.Sites.html#site_stats/1-attributes"},{"type":"function","title":"PlausibleWeb.Live.Sites.upgrade_nag_screen/1","doc":"","ref":"PlausibleWeb.Live.Sites.html#upgrade_nag_screen/1"},{"type":"module","title":"PlausibleWeb.Live.Verification","doc":"LiveView coordinating the site verification process.\nOnboarding new sites, renders a standalone component. \nEmbedded modal variant is available for general site settings.","ref":"PlausibleWeb.Live.Verification.html"},{"type":"function","title":"PlausibleWeb.Live.Verification.handle_event/3","doc":"","ref":"PlausibleWeb.Live.Verification.html#handle_event/3"},{"type":"function","title":"PlausibleWeb.Live.Verification.handle_info/2","doc":"","ref":"PlausibleWeb.Live.Verification.html#handle_info/2"},{"type":"function","title":"PlausibleWeb.Live.Verification.mount/3","doc":"","ref":"PlausibleWeb.Live.Verification.html#mount/3"},{"type":"function","title":"PlausibleWeb.Live.Verification.render/1","doc":"","ref":"PlausibleWeb.Live.Verification.html#render/1"},{"type":"module","title":"PlausibleWeb.MJML.StatsReport","doc":"MJML rendered for the weekly or monthly report e-mail","ref":"PlausibleWeb.MJML.StatsReport.html"},{"type":"function","title":"PlausibleWeb.MJML.StatsReport.debug_mjml_template/0","doc":"Returns the raw MJML template. Useful for debugging rendering issues.","ref":"PlausibleWeb.MJML.StatsReport.html#debug_mjml_template/0"},{"type":"function","title":"PlausibleWeb.MJML.StatsReport.render/1","doc":"Safely render the MJML template using Phoenix.HTML","ref":"PlausibleWeb.MJML.StatsReport.html#render/1"},{"type":"module","title":"PlausibleWeb.PageController","doc":"","ref":"PlausibleWeb.PageController.html"},{"type":"function","title":"PlausibleWeb.PageController.index/2","doc":"The root path is never accessible in Plausible.Cloud because it is handled by the upstream reverse proxy.\n\nThis controller action is only ever triggered in self-hosted Plausible.","ref":"PlausibleWeb.PageController.html#index/2"},{"type":"module","title":"PlausibleWeb.PageView","doc":"","ref":"PlausibleWeb.PageView.html"},{"type":"function","title":"PlausibleWeb.PageView.__resource__/0","doc":"The resource name, as an atom, for this view","ref":"PlausibleWeb.PageView.html#__resource__/0"},{"type":"function","title":"PlausibleWeb.PageView.index.html/1","doc":"","ref":"PlausibleWeb.PageView.html#index.html/1"},{"type":"function","title":"PlausibleWeb.PageView.render/2","doc":"Renders the given template locally.","ref":"PlausibleWeb.PageView.html#render/2"},{"type":"function","title":"PlausibleWeb.PageView.template_not_found/2","doc":"Callback invoked when no template is found.\nBy default it raises but can be customized\nto render a particular template.","ref":"PlausibleWeb.PageView.html#template_not_found/2"},{"type":"module","title":"PlausibleWeb.Plugins.API.Controllers.Capabilities","doc":"Controller for Plugins API Capabilities - doesn't enforce authentication,\nserves as a comprehensive health check","ref":"PlausibleWeb.Plugins.API.Controllers.Capabilities.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.Capabilities.index/2","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.Capabilities.html#index/2"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.Capabilities.open_api_operation/1","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.Capabilities.html#open_api_operation/1"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.Capabilities.shared_security/0","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.Capabilities.html#shared_security/0"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.Capabilities.shared_tags/0","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.Capabilities.html#shared_tags/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Controllers.CustomProps","doc":"Controller for the CustomProp resource under Plugins API","ref":"PlausibleWeb.Plugins.API.Controllers.CustomProps.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.CustomProps.disable/2","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.CustomProps.html#disable/2"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.CustomProps.enable/2","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.CustomProps.html#enable/2"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.CustomProps.open_api_operation/1","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.CustomProps.html#open_api_operation/1"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.CustomProps.shared_security/0","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.CustomProps.html#shared_security/0"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.CustomProps.shared_tags/0","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.CustomProps.html#shared_tags/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Controllers.Funnels","doc":"Controller for the Funnel resource under Plugins API","ref":"PlausibleWeb.Plugins.API.Controllers.Funnels.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.Funnels.create/2","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.Funnels.html#create/2"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.Funnels.get/2","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.Funnels.html#get/2"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.Funnels.index/2","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.Funnels.html#index/2"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.Funnels.open_api_operation/1","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.Funnels.html#open_api_operation/1"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.Funnels.shared_security/0","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.Funnels.html#shared_security/0"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.Funnels.shared_tags/0","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.Funnels.html#shared_tags/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Controllers.Goals","doc":"Controller for the Goal resource under Plugins API","ref":"PlausibleWeb.Plugins.API.Controllers.Goals.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.Goals.create/2","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.Goals.html#create/2"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.Goals.delete/2","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.Goals.html#delete/2"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.Goals.delete_bulk/2","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.Goals.html#delete_bulk/2"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.Goals.get/2","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.Goals.html#get/2"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.Goals.index/2","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.Goals.html#index/2"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.Goals.open_api_operation/1","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.Goals.html#open_api_operation/1"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.Goals.shared_security/0","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.Goals.html#shared_security/0"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.Goals.shared_tags/0","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.Goals.html#shared_tags/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Controllers.SharedLinks","doc":"Controller for the Shared Link resource under Plugins API","ref":"PlausibleWeb.Plugins.API.Controllers.SharedLinks.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.SharedLinks.create/2","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.SharedLinks.html#create/2"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.SharedLinks.get/2","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.SharedLinks.html#get/2"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.SharedLinks.index/2","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.SharedLinks.html#index/2"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.SharedLinks.open_api_operation/1","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.SharedLinks.html#open_api_operation/1"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.SharedLinks.shared_security/0","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.SharedLinks.html#shared_security/0"},{"type":"function","title":"PlausibleWeb.Plugins.API.Controllers.SharedLinks.shared_tags/0","doc":"","ref":"PlausibleWeb.Plugins.API.Controllers.SharedLinks.html#shared_tags/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Errors","doc":"Common responses for Plugins API","ref":"PlausibleWeb.Plugins.API.Errors.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Errors.error/3","doc":"","ref":"PlausibleWeb.Plugins.API.Errors.html#error/3"},{"type":"function","title":"PlausibleWeb.Plugins.API.Errors.unauthorized/1","doc":"","ref":"PlausibleWeb.Plugins.API.Errors.html#unauthorized/1"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.Capabilities","doc":"OpenAPI schema for Capabilities","ref":"PlausibleWeb.Plugins.API.Schemas.Capabilities.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.Capabilities.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Capabilities.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.Capabilities.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Capabilities.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.CustomProp","doc":"OpenAPI schema for Goal","ref":"PlausibleWeb.Plugins.API.Schemas.CustomProp.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.CustomProp.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.CustomProp.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.CustomProp.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.CustomProp.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.CustomProp.DisableRequest","doc":"OpenAPI schema for Custom Property disable request","ref":"PlausibleWeb.Plugins.API.Schemas.CustomProp.DisableRequest.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.CustomProp.DisableRequest.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.CustomProp.DisableRequest.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.CustomProp.DisableRequest.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.CustomProp.DisableRequest.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.CustomProp.EnableRequest","doc":"OpenAPI schema for Custom Property creation request","ref":"PlausibleWeb.Plugins.API.Schemas.CustomProp.EnableRequest.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.CustomProp.EnableRequest.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.CustomProp.EnableRequest.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.CustomProp.EnableRequest.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.CustomProp.EnableRequest.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.CustomProp.ListResponse","doc":"OpenAPI schema for SharedLink list response","ref":"PlausibleWeb.Plugins.API.Schemas.CustomProp.ListResponse.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.CustomProp.ListResponse.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.CustomProp.ListResponse.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.CustomProp.ListResponse.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.CustomProp.ListResponse.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.Error","doc":"OpenAPI schema for an error included in a response","ref":"PlausibleWeb.Plugins.API.Schemas.Error.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.Error.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Error.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.Error.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Error.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.Funnel","doc":"OpenAPI schema for Funnel","ref":"PlausibleWeb.Plugins.API.Schemas.Funnel.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.Funnel.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Funnel.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.Funnel.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Funnel.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.Funnel.CreateRequest","doc":"OpenAPI schema for Funnel creation request - get or creates goals along the way","ref":"PlausibleWeb.Plugins.API.Schemas.Funnel.CreateRequest.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.Funnel.CreateRequest.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Funnel.CreateRequest.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.Funnel.CreateRequest.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Funnel.CreateRequest.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.Funnel.ListResponse","doc":"OpenAPI schema for Funnel list response","ref":"PlausibleWeb.Plugins.API.Schemas.Funnel.ListResponse.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.Funnel.ListResponse.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Funnel.ListResponse.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.Funnel.ListResponse.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Funnel.ListResponse.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.Goal","doc":"OpenAPI schema for Goal","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.Goal.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.Goal.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest","doc":"OpenAPI schema for Goal creation request","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.CustomEvent","doc":"OpenAPI schema for Custom Event Goal creation request","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.CustomEvent.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.CustomEvent.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.CustomEvent.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.CustomEvent.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.CustomEvent.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.Pageview","doc":"OpenAPI schema for Pageview Goal creation request","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.Pageview.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.Pageview.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.Pageview.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.Pageview.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.Pageview.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.Revenue","doc":"OpenAPI schema for Custom Event Goal creation request","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.Revenue.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.Revenue.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.Revenue.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.Revenue.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest.Revenue.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.Goal.CustomEvent","doc":"OpenAPI schema for Custom Event Goal object","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.CustomEvent.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.Goal.CustomEvent.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.CustomEvent.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.Goal.CustomEvent.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.CustomEvent.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.Goal.DeleteBulkRequest","doc":"OpenAPI schema for bulk Goal deletion request","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.DeleteBulkRequest.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.Goal.DeleteBulkRequest.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.DeleteBulkRequest.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.Goal.DeleteBulkRequest.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.DeleteBulkRequest.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.Goal.ListResponse","doc":"OpenAPI schema for Goals list response","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.ListResponse.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.Goal.ListResponse.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.ListResponse.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.Goal.ListResponse.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.ListResponse.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.Goal.Pageview","doc":"OpenAPI schema for Pageview Goal object","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.Pageview.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.Goal.Pageview.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.Pageview.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.Goal.Pageview.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.Pageview.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.Goal.Revenue","doc":"OpenAPI schema for Revenue Goal object","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.Revenue.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.Goal.Revenue.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.Revenue.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.Goal.Revenue.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.Revenue.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.Goal.Type","doc":"OpenAPI schema for common Goal Type\n\nFuture-proof: funnels etc.","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.Type.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.Goal.Type.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.Type.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.Goal.Type.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Goal.Type.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.Link","doc":"OpenAPI Link schema","ref":"PlausibleWeb.Plugins.API.Schemas.Link.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.Link.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Link.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.Link.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Link.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.NotFound","doc":"OpenAPI schema for a generic 404 response","ref":"PlausibleWeb.Plugins.API.Schemas.NotFound.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.NotFound.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.NotFound.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.NotFound.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.NotFound.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.PaginationMetadata","doc":"Pagination metadata OpenAPI schema","ref":"PlausibleWeb.Plugins.API.Schemas.PaginationMetadata.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.PaginationMetadata.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.PaginationMetadata.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.PaginationMetadata.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.PaginationMetadata.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.PaymentRequired","doc":"OpenAPI schema for a generic 402 response","ref":"PlausibleWeb.Plugins.API.Schemas.PaymentRequired.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.PaymentRequired.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.PaymentRequired.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.PaymentRequired.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.PaymentRequired.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.SharedLink","doc":"OpenAPI schema for SharedLink object","ref":"PlausibleWeb.Plugins.API.Schemas.SharedLink.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.SharedLink.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.SharedLink.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.SharedLink.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.SharedLink.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.SharedLink.CreateRequest","doc":"OpenAPI schema for SharedLink creation request","ref":"PlausibleWeb.Plugins.API.Schemas.SharedLink.CreateRequest.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.SharedLink.CreateRequest.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.SharedLink.CreateRequest.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.SharedLink.CreateRequest.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.SharedLink.CreateRequest.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.SharedLink.ListResponse","doc":"OpenAPI schema for SharedLink list response","ref":"PlausibleWeb.Plugins.API.Schemas.SharedLink.ListResponse.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.SharedLink.ListResponse.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.SharedLink.ListResponse.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.SharedLink.ListResponse.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.SharedLink.ListResponse.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.Unauthorized","doc":"OpenAPI schema for a generic 401 response","ref":"PlausibleWeb.Plugins.API.Schemas.Unauthorized.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.Unauthorized.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Unauthorized.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.Unauthorized.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.Unauthorized.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Schemas.UnprocessableEntity","doc":"OpenAPI schema for a generic 422 response","ref":"PlausibleWeb.Plugins.API.Schemas.UnprocessableEntity.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Schemas.UnprocessableEntity.schema/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.UnprocessableEntity.html#schema/0"},{"type":"type","title":"PlausibleWeb.Plugins.API.Schemas.UnprocessableEntity.t/0","doc":"","ref":"PlausibleWeb.Plugins.API.Schemas.UnprocessableEntity.html#t:t/0"},{"type":"module","title":"PlausibleWeb.Plugins.API.Spec","doc":"OpenAPI specification for the Plugins API","ref":"PlausibleWeb.Plugins.API.Spec.html"},{"type":"module","title":"PlausibleWeb.Plugins.API.Views.Capabilities","doc":"View for rendering Capabilities on the Plugins API","ref":"PlausibleWeb.Plugins.API.Views.Capabilities.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Views.Capabilities.__resource__/0","doc":"The resource name, as an atom, for this view","ref":"PlausibleWeb.Plugins.API.Views.Capabilities.html#__resource__/0"},{"type":"function","title":"PlausibleWeb.Plugins.API.Views.Capabilities.render/2","doc":"Renders the given template locally.","ref":"PlausibleWeb.Plugins.API.Views.Capabilities.html#render/2"},{"type":"function","title":"PlausibleWeb.Plugins.API.Views.Capabilities.template_not_found/2","doc":"Callback invoked when no template is found.\nBy default it raises but can be customized\nto render a particular template.","ref":"PlausibleWeb.Plugins.API.Views.Capabilities.html#template_not_found/2"},{"type":"module","title":"PlausibleWeb.Plugins.API.Views.CustomProp","doc":"View for rendering Custom Props in the Plugins API","ref":"PlausibleWeb.Plugins.API.Views.CustomProp.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Views.CustomProp.__resource__/0","doc":"The resource name, as an atom, for this view","ref":"PlausibleWeb.Plugins.API.Views.CustomProp.html#__resource__/0"},{"type":"function","title":"PlausibleWeb.Plugins.API.Views.CustomProp.render/2","doc":"Renders the given template locally.","ref":"PlausibleWeb.Plugins.API.Views.CustomProp.html#render/2"},{"type":"function","title":"PlausibleWeb.Plugins.API.Views.CustomProp.template_not_found/2","doc":"Callback invoked when no template is found.\nBy default it raises but can be customized\nto render a particular template.","ref":"PlausibleWeb.Plugins.API.Views.CustomProp.html#template_not_found/2"},{"type":"module","title":"PlausibleWeb.Plugins.API.Views.Error","doc":"View for rendering Plugins REST API errors","ref":"PlausibleWeb.Plugins.API.Views.Error.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Views.Error.__resource__/0","doc":"The resource name, as an atom, for this view","ref":"PlausibleWeb.Plugins.API.Views.Error.html#__resource__/0"},{"type":"function","title":"PlausibleWeb.Plugins.API.Views.Error.render/2","doc":"Renders the given template locally.","ref":"PlausibleWeb.Plugins.API.Views.Error.html#render/2"},{"type":"function","title":"PlausibleWeb.Plugins.API.Views.Error.template_not_found/2","doc":"Callback invoked when no template is found.\nBy default it raises but can be customized\nto render a particular template.","ref":"PlausibleWeb.Plugins.API.Views.Error.html#template_not_found/2"},{"type":"module","title":"PlausibleWeb.Plugins.API.Views.Funnel","doc":"View for rendering Funnels in the Plugins API","ref":"PlausibleWeb.Plugins.API.Views.Funnel.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Views.Funnel.__resource__/0","doc":"The resource name, as an atom, for this view","ref":"PlausibleWeb.Plugins.API.Views.Funnel.html#__resource__/0"},{"type":"function","title":"PlausibleWeb.Plugins.API.Views.Funnel.render/2","doc":"Renders the given template locally.","ref":"PlausibleWeb.Plugins.API.Views.Funnel.html#render/2"},{"type":"function","title":"PlausibleWeb.Plugins.API.Views.Funnel.template_not_found/2","doc":"Callback invoked when no template is found.\nBy default it raises but can be customized\nto render a particular template.","ref":"PlausibleWeb.Plugins.API.Views.Funnel.html#template_not_found/2"},{"type":"module","title":"PlausibleWeb.Plugins.API.Views.Goal","doc":"View for rendering Goals in the Plugins API","ref":"PlausibleWeb.Plugins.API.Views.Goal.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Views.Goal.__resource__/0","doc":"The resource name, as an atom, for this view","ref":"PlausibleWeb.Plugins.API.Views.Goal.html#__resource__/0"},{"type":"function","title":"PlausibleWeb.Plugins.API.Views.Goal.render/2","doc":"Renders the given template locally.","ref":"PlausibleWeb.Plugins.API.Views.Goal.html#render/2"},{"type":"function","title":"PlausibleWeb.Plugins.API.Views.Goal.template_not_found/2","doc":"Callback invoked when no template is found.\nBy default it raises but can be customized\nto render a particular template.","ref":"PlausibleWeb.Plugins.API.Views.Goal.html#template_not_found/2"},{"type":"module","title":"PlausibleWeb.Plugins.API.Views.Pagination","doc":"A view capable of rendering pagination metadata included\nin responses containing lists of objects.","ref":"PlausibleWeb.Plugins.API.Views.Pagination.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Views.Pagination.__resource__/0","doc":"The resource name, as an atom, for this view","ref":"PlausibleWeb.Plugins.API.Views.Pagination.html#__resource__/0"},{"type":"function","title":"PlausibleWeb.Plugins.API.Views.Pagination.render/2","doc":"Renders the given template locally.","ref":"PlausibleWeb.Plugins.API.Views.Pagination.html#render/2"},{"type":"function","title":"PlausibleWeb.Plugins.API.Views.Pagination.render_metadata_links/4","doc":"","ref":"PlausibleWeb.Plugins.API.Views.Pagination.html#render_metadata_links/4"},{"type":"function","title":"PlausibleWeb.Plugins.API.Views.Pagination.template_not_found/2","doc":"Callback invoked when no template is found.\nBy default it raises but can be customized\nto render a particular template.","ref":"PlausibleWeb.Plugins.API.Views.Pagination.html#template_not_found/2"},{"type":"module","title":"PlausibleWeb.Plugins.API.Views.SharedLink","doc":"View for rendering Shared Links in the Plugins API","ref":"PlausibleWeb.Plugins.API.Views.SharedLink.html"},{"type":"function","title":"PlausibleWeb.Plugins.API.Views.SharedLink.__resource__/0","doc":"The resource name, as an atom, for this view","ref":"PlausibleWeb.Plugins.API.Views.SharedLink.html#__resource__/0"},{"type":"function","title":"PlausibleWeb.Plugins.API.Views.SharedLink.render/2","doc":"Renders the given template locally.","ref":"PlausibleWeb.Plugins.API.Views.SharedLink.html#render/2"},{"type":"function","title":"PlausibleWeb.Plugins.API.Views.SharedLink.template_not_found/2","doc":"Callback invoked when no template is found.\nBy default it raises but can be customized\nto render a particular template.","ref":"PlausibleWeb.Plugins.API.Views.SharedLink.html#template_not_found/2"},{"type":"module","title":"PlausibleWeb.PluginsAPICase","doc":"This module defines the test case to be used by\ntests that require setting up a Plugins API connection.","ref":"PlausibleWeb.PluginsAPICase.html"},{"type":"module","title":"PlausibleWeb.Plugs.AuthorizePluginsAPI","doc":"Plug for Basic HTTP Authentication using\nPlugins API Tokens lookup.","ref":"PlausibleWeb.Plugs.AuthorizePluginsAPI.html"},{"type":"function","title":"PlausibleWeb.Plugs.AuthorizePluginsAPI.call/2","doc":"","ref":"PlausibleWeb.Plugs.AuthorizePluginsAPI.html#call/2"},{"type":"function","title":"PlausibleWeb.Plugs.AuthorizePluginsAPI.init/1","doc":"","ref":"PlausibleWeb.Plugs.AuthorizePluginsAPI.html#init/1"},{"type":"module","title":"PlausibleWeb.Plugs.AuthorizePublicAPI","doc":"Plug for authorizing access to Stats and Sites APIs.\n\nThe plug expects `:api_scope` to be provided in the assigns. The scope\nwill then be used to check for API key validity. The assign can be\nprovided in the router configuration in a following way:\n\n scope \"/api/v1/stats\", PlausibleWeb.Api, assigns: %{api_scope: \"some:scope:*\"} do\n pipe_through [:public_api, PlausibleWeb.Plugs.AuthorizePublicAPI]\n\n # route definitions follow\n # ...\n end\n\nThe scope from `:api_scope` is checked for match against all scopes from API key's\n`scopes` field. If the scope is among `@implicit_scopes`, it's considered to be\npresent for any valid API key. Scopes are checked for match by prefix, so if we have\n`some:scope:*` in matching route `:api_scope` and the API key has `some:*` in its\n`scopes` field, they will match.\n\nAfter a match is found, additional verification can be conducted, like in case of\n`stats:read:*`, where valid site ID is expected among parameters too.\n\nAll API requests are rate limited per API key, enforcing a given hourly request limit.","ref":"PlausibleWeb.Plugs.AuthorizePublicAPI.html"},{"type":"function","title":"PlausibleWeb.Plugs.AuthorizePublicAPI.call/2","doc":"","ref":"PlausibleWeb.Plugs.AuthorizePublicAPI.html#call/2"},{"type":"function","title":"PlausibleWeb.Plugs.AuthorizePublicAPI.init/1","doc":"","ref":"PlausibleWeb.Plugs.AuthorizePublicAPI.html#init/1"},{"type":"module","title":"PlausibleWeb.Plugs.ErrorHandler","doc":"A thin macro wrapper around Plug.ErrorHandler that adds Sentry context\n containing a readable support hash presented to the users.\n To be used in the user-facing APIs, so that we don't leak internal\n server errors.\n\n Usage: `use PlausibleWeb.Plugs.ErrorHandler`","ref":"PlausibleWeb.Plugs.ErrorHandler.html"},{"type":"module","title":"PlausibleWeb.Plugs.MaybeDisableRegistration","doc":"Plug toggling registration according to selfhosted state.","ref":"PlausibleWeb.Plugs.MaybeDisableRegistration.html"},{"type":"function","title":"PlausibleWeb.Plugs.MaybeDisableRegistration.call/2","doc":"","ref":"PlausibleWeb.Plugs.MaybeDisableRegistration.html#call/2"},{"type":"function","title":"PlausibleWeb.Plugs.MaybeDisableRegistration.init/1","doc":"","ref":"PlausibleWeb.Plugs.MaybeDisableRegistration.html#init/1"},{"type":"module","title":"PlausibleWeb.Plugs.NoRobots","doc":"Rejects bot requests by any means available.\n\nWe're adding `x-robots-tag` to the response header and annotate the conn\nwith \"noindex, nofollow\" under `private.robots` key.\n\nThe only exception is, if the request is trying to access our live demo\nat plausible.io/plausible.io - in which case we'll allow indexing, but deny\nfollowing links and skip the bot detection, in kind robots we trust.","ref":"PlausibleWeb.Plugs.NoRobots.html"},{"type":"module","title":"PlausibleWeb.RefInspector","doc":"","ref":"PlausibleWeb.RefInspector.html"},{"type":"function","title":"PlausibleWeb.RefInspector.format_referrer/1","doc":"","ref":"PlausibleWeb.RefInspector.html#format_referrer/1"},{"type":"function","title":"PlausibleWeb.RefInspector.parse/1","doc":"","ref":"PlausibleWeb.RefInspector.html#parse/1"},{"type":"function","title":"PlausibleWeb.RefInspector.right_uri?/1","doc":"","ref":"PlausibleWeb.RefInspector.html#right_uri?/1"},{"type":"module","title":"PlausibleWeb.RemoteIP","doc":"Implements the strategy of retrieving client's remote IP","ref":"PlausibleWeb.RemoteIP.html"},{"type":"function","title":"PlausibleWeb.RemoteIP.get/1","doc":"","ref":"PlausibleWeb.RemoteIP.html#get/1"},{"type":"module","title":"PlausibleWeb.RequireAccountPlug","doc":"","ref":"PlausibleWeb.RequireAccountPlug.html"},{"type":"function","title":"PlausibleWeb.RequireAccountPlug.call/2","doc":"","ref":"PlausibleWeb.RequireAccountPlug.html#call/2"},{"type":"function","title":"PlausibleWeb.RequireAccountPlug.init/1","doc":"","ref":"PlausibleWeb.RequireAccountPlug.html#init/1"},{"type":"module","title":"PlausibleWeb.RequireLoggedOutPlug","doc":"","ref":"PlausibleWeb.RequireLoggedOutPlug.html"},{"type":"function","title":"PlausibleWeb.RequireLoggedOutPlug.call/2","doc":"","ref":"PlausibleWeb.RequireLoggedOutPlug.html#call/2"},{"type":"function","title":"PlausibleWeb.RequireLoggedOutPlug.init/1","doc":"","ref":"PlausibleWeb.RequireLoggedOutPlug.html#init/1"},{"type":"module","title":"PlausibleWeb.Router","doc":"","ref":"PlausibleWeb.Router.html"},{"type":"function","title":"PlausibleWeb.Router.api/2","doc":"","ref":"PlausibleWeb.Router.html#api/2"},{"type":"function","title":"PlausibleWeb.Router.app_layout/2","doc":"","ref":"PlausibleWeb.Router.html#app_layout/2"},{"type":"function","title":"PlausibleWeb.Router.browser/2","doc":"","ref":"PlausibleWeb.Router.html#browser/2"},{"type":"function","title":"PlausibleWeb.Router.call/2","doc":"Callback invoked by Plug on every request.","ref":"PlausibleWeb.Router.html#call/2"},{"type":"function","title":"PlausibleWeb.Router.csrf/2","doc":"","ref":"PlausibleWeb.Router.html#csrf/2"},{"type":"function","title":"PlausibleWeb.Router.flags/2","doc":"","ref":"PlausibleWeb.Router.html#flags/2"},{"type":"function","title":"PlausibleWeb.Router.focus_layout/2","doc":"","ref":"PlausibleWeb.Router.html#focus_layout/2"},{"type":"function","title":"PlausibleWeb.Router.init/1","doc":"Callback required by Plug that initializes the router\nfor serving web requests.","ref":"PlausibleWeb.Router.html#init/1"},{"type":"function","title":"PlausibleWeb.Router.internal_stats_api/2","doc":"","ref":"PlausibleWeb.Router.html#internal_stats_api/2"},{"type":"function","title":"PlausibleWeb.Router.kaffy_browser/2","doc":"","ref":"PlausibleWeb.Router.html#kaffy_browser/2"},{"type":"function","title":"PlausibleWeb.Router.plugins_api/2","doc":"","ref":"PlausibleWeb.Router.html#plugins_api/2"},{"type":"function","title":"PlausibleWeb.Router.plugins_api_auth/2","doc":"","ref":"PlausibleWeb.Router.html#plugins_api_auth/2"},{"type":"function","title":"PlausibleWeb.Router.public_api/2","doc":"","ref":"PlausibleWeb.Router.html#public_api/2"},{"type":"function","title":"PlausibleWeb.Router.shared_link/2","doc":"","ref":"PlausibleWeb.Router.html#shared_link/2"},{"type":"module","title":"PlausibleWeb.SessionTimeoutPlug","doc":"NOTE: This plug will be replaced with a different\nsession expiration mechanism once server-side persisted\nsessions are rolled out.","ref":"PlausibleWeb.SessionTimeoutPlug.html"},{"type":"function","title":"PlausibleWeb.SessionTimeoutPlug.call/2","doc":"","ref":"PlausibleWeb.SessionTimeoutPlug.html#call/2"},{"type":"function","title":"PlausibleWeb.SessionTimeoutPlug.init/1","doc":"","ref":"PlausibleWeb.SessionTimeoutPlug.html#init/1"},{"type":"module","title":"PlausibleWeb.Site.MembershipController","doc":"This controller deals with user management via the UI in Site Settings -> People. It's important to enforce permissions in this controller.\n\n Owner - Can manage users, can trigger a 'transfer ownership' request\n Admin - Can manage users\n Viewer - Can not access user management settings\n Anyone - Can accept invitations\n\n Everything else should be explicitly disallowed.","ref":"PlausibleWeb.Site.MembershipController.html"},{"type":"function","title":"PlausibleWeb.Site.MembershipController.invite_member/2","doc":"","ref":"PlausibleWeb.Site.MembershipController.html#invite_member/2"},{"type":"function","title":"PlausibleWeb.Site.MembershipController.invite_member_form/2","doc":"","ref":"PlausibleWeb.Site.MembershipController.html#invite_member_form/2"},{"type":"function","title":"PlausibleWeb.Site.MembershipController.remove_member/2","doc":"","ref":"PlausibleWeb.Site.MembershipController.html#remove_member/2"},{"type":"function","title":"PlausibleWeb.Site.MembershipController.transfer_ownership/2","doc":"","ref":"PlausibleWeb.Site.MembershipController.html#transfer_ownership/2"},{"type":"function","title":"PlausibleWeb.Site.MembershipController.transfer_ownership_form/2","doc":"","ref":"PlausibleWeb.Site.MembershipController.html#transfer_ownership_form/2"},{"type":"function","title":"PlausibleWeb.Site.MembershipController.update_role/2","doc":"Updates the role of a user. The user being updated could be the same or different from the user taking\n the action. When updating the role, it's important to enforce permissions:\n\n Owner - Can update anyone's role except for themselves. If they want to change their own role, they have to use the 'transfer ownership' feature.\n Admin - Can update anyone's role except for owners. Can downgrade their own access to 'viewer'. Can promote a viewer to admin.","ref":"PlausibleWeb.Site.MembershipController.html#update_role/2"},{"type":"module","title":"PlausibleWeb.Site.MembershipView","doc":"","ref":"PlausibleWeb.Site.MembershipView.html"},{"type":"function","title":"PlausibleWeb.Site.MembershipView.__resource__/0","doc":"The resource name, as an atom, for this view","ref":"PlausibleWeb.Site.MembershipView.html#__resource__/0"},{"type":"function","title":"PlausibleWeb.Site.MembershipView.invite_member_form.html/1","doc":"","ref":"PlausibleWeb.Site.MembershipView.html#invite_member_form.html/1"},{"type":"function","title":"PlausibleWeb.Site.MembershipView.render/2","doc":"Renders the given template locally.","ref":"PlausibleWeb.Site.MembershipView.html#render/2"},{"type":"function","title":"PlausibleWeb.Site.MembershipView.template_not_found/2","doc":"Callback invoked when no template is found.\nBy default it raises but can be customized\nto render a particular template.","ref":"PlausibleWeb.Site.MembershipView.html#template_not_found/2"},{"type":"function","title":"PlausibleWeb.Site.MembershipView.transfer_ownership_form.html/1","doc":"","ref":"PlausibleWeb.Site.MembershipView.html#transfer_ownership_form.html/1"},{"type":"module","title":"PlausibleWeb.SiteController","doc":"","ref":"PlausibleWeb.SiteController.html"},{"type":"function","title":"PlausibleWeb.SiteController.add_monthly_report_recipient/2","doc":"","ref":"PlausibleWeb.SiteController.html#add_monthly_report_recipient/2"},{"type":"function","title":"PlausibleWeb.SiteController.add_snippet/2","doc":"","ref":"PlausibleWeb.SiteController.html#add_snippet/2"},{"type":"function","title":"PlausibleWeb.SiteController.add_snippet_after_domain_change/2","doc":"","ref":"PlausibleWeb.SiteController.html#add_snippet_after_domain_change/2"},{"type":"function","title":"PlausibleWeb.SiteController.add_traffic_change_notification_recipient/2","doc":"","ref":"PlausibleWeb.SiteController.html#add_traffic_change_notification_recipient/2"},{"type":"function","title":"PlausibleWeb.SiteController.add_weekly_report_recipient/2","doc":"","ref":"PlausibleWeb.SiteController.html#add_weekly_report_recipient/2"},{"type":"function","title":"PlausibleWeb.SiteController.change_domain/2","doc":"","ref":"PlausibleWeb.SiteController.html#change_domain/2"},{"type":"function","title":"PlausibleWeb.SiteController.change_domain_submit/2","doc":"","ref":"PlausibleWeb.SiteController.html#change_domain_submit/2"},{"type":"function","title":"PlausibleWeb.SiteController.create_shared_link/2","doc":"","ref":"PlausibleWeb.SiteController.html#create_shared_link/2"},{"type":"function","title":"PlausibleWeb.SiteController.create_site/2","doc":"","ref":"PlausibleWeb.SiteController.html#create_site/2"},{"type":"function","title":"PlausibleWeb.SiteController.csv_import/2","doc":"","ref":"PlausibleWeb.SiteController.html#csv_import/2"},{"type":"function","title":"PlausibleWeb.SiteController.delete_google_auth/2","doc":"","ref":"PlausibleWeb.SiteController.html#delete_google_auth/2"},{"type":"function","title":"PlausibleWeb.SiteController.delete_shared_link/2","doc":"","ref":"PlausibleWeb.SiteController.html#delete_shared_link/2"},{"type":"function","title":"PlausibleWeb.SiteController.delete_site/2","doc":"","ref":"PlausibleWeb.SiteController.html#delete_site/2"},{"type":"function","title":"PlausibleWeb.SiteController.disable_monthly_report/2","doc":"","ref":"PlausibleWeb.SiteController.html#disable_monthly_report/2"},{"type":"function","title":"PlausibleWeb.SiteController.disable_traffic_change_notification/2","doc":"","ref":"PlausibleWeb.SiteController.html#disable_traffic_change_notification/2"},{"type":"function","title":"PlausibleWeb.SiteController.disable_weekly_report/2","doc":"","ref":"PlausibleWeb.SiteController.html#disable_weekly_report/2"},{"type":"function","title":"PlausibleWeb.SiteController.download_export/2","doc":"","ref":"PlausibleWeb.SiteController.html#download_export/2"},{"type":"function","title":"PlausibleWeb.SiteController.edit_shared_link/2","doc":"","ref":"PlausibleWeb.SiteController.html#edit_shared_link/2"},{"type":"function","title":"PlausibleWeb.SiteController.enable_monthly_report/2","doc":"","ref":"PlausibleWeb.SiteController.html#enable_monthly_report/2"},{"type":"function","title":"PlausibleWeb.SiteController.enable_traffic_change_notification/2","doc":"","ref":"PlausibleWeb.SiteController.html#enable_traffic_change_notification/2"},{"type":"function","title":"PlausibleWeb.SiteController.enable_weekly_report/2","doc":"","ref":"PlausibleWeb.SiteController.html#enable_weekly_report/2"},{"type":"function","title":"PlausibleWeb.SiteController.forget_import/2","doc":"","ref":"PlausibleWeb.SiteController.html#forget_import/2"},{"type":"function","title":"PlausibleWeb.SiteController.forget_imported/2","doc":"","ref":"PlausibleWeb.SiteController.html#forget_imported/2"},{"type":"function","title":"PlausibleWeb.SiteController.make_private/2","doc":"","ref":"PlausibleWeb.SiteController.html#make_private/2"},{"type":"function","title":"PlausibleWeb.SiteController.make_public/2","doc":"","ref":"PlausibleWeb.SiteController.html#make_public/2"},{"type":"function","title":"PlausibleWeb.SiteController.new/2","doc":"","ref":"PlausibleWeb.SiteController.html#new/2"},{"type":"function","title":"PlausibleWeb.SiteController.new_shared_link/2","doc":"","ref":"PlausibleWeb.SiteController.html#new_shared_link/2"},{"type":"function","title":"PlausibleWeb.SiteController.remove_monthly_report_recipient/2","doc":"","ref":"PlausibleWeb.SiteController.html#remove_monthly_report_recipient/2"},{"type":"function","title":"PlausibleWeb.SiteController.remove_traffic_change_notification_recipient/2","doc":"","ref":"PlausibleWeb.SiteController.html#remove_traffic_change_notification_recipient/2"},{"type":"function","title":"PlausibleWeb.SiteController.remove_weekly_report_recipient/2","doc":"","ref":"PlausibleWeb.SiteController.html#remove_weekly_report_recipient/2"},{"type":"function","title":"PlausibleWeb.SiteController.reset_stats/2","doc":"","ref":"PlausibleWeb.SiteController.html#reset_stats/2"},{"type":"function","title":"PlausibleWeb.SiteController.settings/2","doc":"","ref":"PlausibleWeb.SiteController.html#settings/2"},{"type":"function","title":"PlausibleWeb.SiteController.settings_danger_zone/2","doc":"","ref":"PlausibleWeb.SiteController.html#settings_danger_zone/2"},{"type":"function","title":"PlausibleWeb.SiteController.settings_email_reports/2","doc":"","ref":"PlausibleWeb.SiteController.html#settings_email_reports/2"},{"type":"function","title":"PlausibleWeb.SiteController.settings_funnels/2","doc":"","ref":"PlausibleWeb.SiteController.html#settings_funnels/2"},{"type":"function","title":"PlausibleWeb.SiteController.settings_general/2","doc":"","ref":"PlausibleWeb.SiteController.html#settings_general/2"},{"type":"function","title":"PlausibleWeb.SiteController.settings_goals/2","doc":"","ref":"PlausibleWeb.SiteController.html#settings_goals/2"},{"type":"function","title":"PlausibleWeb.SiteController.settings_imports_exports/2","doc":"","ref":"PlausibleWeb.SiteController.html#settings_imports_exports/2"},{"type":"function","title":"PlausibleWeb.SiteController.settings_integrations/2","doc":"","ref":"PlausibleWeb.SiteController.html#settings_integrations/2"},{"type":"function","title":"PlausibleWeb.SiteController.settings_people/2","doc":"","ref":"PlausibleWeb.SiteController.html#settings_people/2"},{"type":"function","title":"PlausibleWeb.SiteController.settings_props/2","doc":"","ref":"PlausibleWeb.SiteController.html#settings_props/2"},{"type":"function","title":"PlausibleWeb.SiteController.settings_shields/2","doc":"","ref":"PlausibleWeb.SiteController.html#settings_shields/2"},{"type":"function","title":"PlausibleWeb.SiteController.settings_visibility/2","doc":"","ref":"PlausibleWeb.SiteController.html#settings_visibility/2"},{"type":"function","title":"PlausibleWeb.SiteController.update_feature_visibility/2","doc":"","ref":"PlausibleWeb.SiteController.html#update_feature_visibility/2"},{"type":"function","title":"PlausibleWeb.SiteController.update_google_auth/2","doc":"","ref":"PlausibleWeb.SiteController.html#update_google_auth/2"},{"type":"function","title":"PlausibleWeb.SiteController.update_settings/2","doc":"","ref":"PlausibleWeb.SiteController.html#update_settings/2"},{"type":"function","title":"PlausibleWeb.SiteController.update_shared_link/2","doc":"","ref":"PlausibleWeb.SiteController.html#update_shared_link/2"},{"type":"function","title":"PlausibleWeb.SiteController.update_traffic_change_notification/2","doc":"","ref":"PlausibleWeb.SiteController.html#update_traffic_change_notification/2"},{"type":"module","title":"PlausibleWeb.SiteView","doc":"","ref":"PlausibleWeb.SiteView.html"},{"type":"function","title":"PlausibleWeb.SiteView.__resource__/0","doc":"The resource name, as an atom, for this view","ref":"PlausibleWeb.SiteView.html#__resource__/0"},{"type":"function","title":"PlausibleWeb.SiteView.change_domain.html/1","doc":"","ref":"PlausibleWeb.SiteView.html#change_domain.html/1"},{"type":"function","title":"PlausibleWeb.SiteView.csv_import.html/1","doc":"","ref":"PlausibleWeb.SiteView.html#csv_import.html/1"},{"type":"function","title":"PlausibleWeb.SiteView.edit_shared_link.html/1","doc":"","ref":"PlausibleWeb.SiteView.html#edit_shared_link.html/1"},{"type":"function","title":"PlausibleWeb.SiteView.new.html/1","doc":"","ref":"PlausibleWeb.SiteView.html#new.html/1"},{"type":"function","title":"PlausibleWeb.SiteView.new_shared_link.html/1","doc":"","ref":"PlausibleWeb.SiteView.html#new_shared_link.html/1"},{"type":"function","title":"PlausibleWeb.SiteView.plausible_url/0","doc":"","ref":"PlausibleWeb.SiteView.html#plausible_url/0"},{"type":"function","title":"PlausibleWeb.SiteView.render/2","doc":"Renders the given template locally.","ref":"PlausibleWeb.SiteView.html#render/2"},{"type":"function","title":"PlausibleWeb.SiteView.render_snippet/1","doc":"","ref":"PlausibleWeb.SiteView.html#render_snippet/1"},{"type":"function","title":"PlausibleWeb.SiteView.settings_danger_zone.html/1","doc":"","ref":"PlausibleWeb.SiteView.html#settings_danger_zone.html/1"},{"type":"function","title":"PlausibleWeb.SiteView.settings_email_reports.html/1","doc":"","ref":"PlausibleWeb.SiteView.html#settings_email_reports.html/1"},{"type":"function","title":"PlausibleWeb.SiteView.settings_funnels.html/1","doc":"","ref":"PlausibleWeb.SiteView.html#settings_funnels.html/1"},{"type":"function","title":"PlausibleWeb.SiteView.settings_general.html/1","doc":"","ref":"PlausibleWeb.SiteView.html#settings_general.html/1"},{"type":"function","title":"PlausibleWeb.SiteView.settings_goals.html/1","doc":"","ref":"PlausibleWeb.SiteView.html#settings_goals.html/1"},{"type":"function","title":"PlausibleWeb.SiteView.settings_imports_exports.html/1","doc":"","ref":"PlausibleWeb.SiteView.html#settings_imports_exports.html/1"},{"type":"function","title":"PlausibleWeb.SiteView.settings_integrations.html/1","doc":"","ref":"PlausibleWeb.SiteView.html#settings_integrations.html/1"},{"type":"function","title":"PlausibleWeb.SiteView.settings_people.html/1","doc":"","ref":"PlausibleWeb.SiteView.html#settings_people.html/1"},{"type":"function","title":"PlausibleWeb.SiteView.settings_props.html/1","doc":"","ref":"PlausibleWeb.SiteView.html#settings_props.html/1"},{"type":"function","title":"PlausibleWeb.SiteView.settings_search_console.html/1","doc":"","ref":"PlausibleWeb.SiteView.html#settings_search_console.html/1"},{"type":"function","title":"PlausibleWeb.SiteView.settings_shields.html/1","doc":"","ref":"PlausibleWeb.SiteView.html#settings_shields.html/1"},{"type":"function","title":"PlausibleWeb.SiteView.settings_visibility.html/1","doc":"","ref":"PlausibleWeb.SiteView.html#settings_visibility.html/1"},{"type":"function","title":"PlausibleWeb.SiteView.shared_link_dest/2","doc":"","ref":"PlausibleWeb.SiteView.html#shared_link_dest/2"},{"type":"function","title":"PlausibleWeb.SiteView.snippet.html/1","doc":"","ref":"PlausibleWeb.SiteView.html#snippet.html/1"},{"type":"function","title":"PlausibleWeb.SiteView.snippet_after_domain_change.html/1","doc":"","ref":"PlausibleWeb.SiteView.html#snippet_after_domain_change.html/1"},{"type":"function","title":"PlausibleWeb.SiteView.template_not_found/2","doc":"Callback invoked when no template is found.\nBy default it raises but can be customized\nto render a particular template.","ref":"PlausibleWeb.SiteView.html#template_not_found/2"},{"type":"function","title":"PlausibleWeb.SiteView.traffic_change_form/1","doc":"","ref":"PlausibleWeb.SiteView.html#traffic_change_form/1"},{"type":"function","title":"PlausibleWeb.SiteView.with_indefinite_article/1","doc":"","ref":"PlausibleWeb.SiteView.html#with_indefinite_article/1"},{"type":"module","title":"PlausibleWeb.StatsController","doc":"This controller is responsible for rendering stats dashboards.\n\nThe stats dashboards are currently the only part of the app that uses client-side\nrendering. Since the dashboards are heavily interactive, they are built with React\nwhich is an appropriate choice for highly interactive browser UIs.\n\n \nsequenceDiagram\n Browser->>StatsController: GET /mydomain.com\n StatsController-->>Browser: StatsView.render(\"stats.html\")\n Note left of Browser: ReactDom.render(Dashboard)\n\n Browser -) Api.StatsController: GET /api/stats/mydomain.com/top-stats\n Api.StatsController --) Browser: {\"top_stats\": [...]}\n Note left of Browser: TopStats.render()\n\n Browser -) Api.StatsController: GET /api/stats/mydomain.com/main-graph\n Api.StatsController --) Browser: [{\"plot\": [...], \"labels\": [...]}, ...]\n Note left of Browser: VisitorGraph.render()\n\n Browser -) Api.StatsController: GET /api/stats/mydomain.com/sources\n Api.StatsController --) Browser: [{\"name\": \"Google\", \"visitors\": 292150}, ...]\n Note left of Browser: Sources.render()\n\n Note over Browser,StatsController: And so on, for all reports in the viewport\n \n\nThis reasoning for this sequence is as follows:\n 1. First paint is fast because it doesn't do any data aggregation yet - good UX\n 2. The basic structure of the dashboard is rendered with spinners before reports are ready - good UX\n 2. Rendering on the frontend allows for maximum interactivity. Re-rendering and re-fetching can be as granular as needed.\n 3. Routing on the frontend allows the user to navigate the dashboard without reloading the page and losing context\n 4. Rendering on the frontend allows caching results in the browser to reduce pressure on backends and storage\n 3.1 No client-side caching has been implemented yet. This is still theoretical. See https://github.com/plausible/analytics/discussions/1278\n 3.2 This is a big potential opportunity, because analytics data is mostly immutable. Clients can cache all historical data.\n 5. Since frontend rendering & navigation is harder to build and maintain than regular server-rendered HTML, we don't use SPA-style rendering anywhere else\n .The only place currently where the benefits outweigh the costs is the dashboard.","ref":"PlausibleWeb.StatsController.html"},{"type":"function","title":"PlausibleWeb.StatsController.authenticate_shared_link/2","doc":"","ref":"PlausibleWeb.StatsController.html#authenticate_shared_link/2"},{"type":"function","title":"PlausibleWeb.StatsController.csv_export/2","doc":"The export is limited to 300 entries for other reports and 100 entries for pages because bigger result sets\nstart causing failures. Since we request data like time on page or bounce_rate for pages in a separate query\nusing the IN filter, it causes the requests to balloon in payload size.","ref":"PlausibleWeb.StatsController.html#csv_export/2"},{"type":"function","title":"PlausibleWeb.StatsController.shared_link/2","doc":"Authorizes and renders a shared link:\n 1. Shared link with no password protection: needs to just make sure the shared link entry is still\n in our database. This check makes sure shared link access can be revoked by the site admins. If the\n shared link exists, render it directly.\n\n 2. Shared link with password protection: Same checks as without the password, but an extra step is taken to\n protect the page with a password. When the user passes the password challenge, a cookie is set with Plausible.Auth.Token.sign_shared_link().\n The cookie allows the user to access the dashboard for 24 hours without entering the password again.\n\n #","ref":"PlausibleWeb.StatsController.html#shared_link/2"},{"type":"function","title":"Backwards compatibility - PlausibleWeb.StatsController.shared_link/2","doc":"The URL format for shared links was changed in [this pull request](https://github.com/plausible/analytics/pull/752) in order\n to make the URLs easier to bookmark. The old format is supported along with the new in order to not break old links.\n\n See: https://plausible.io/docs/shared-links","ref":"PlausibleWeb.StatsController.html#shared_link/2-backwards-compatibility"},{"type":"function","title":"PlausibleWeb.StatsController.stats/2","doc":"","ref":"PlausibleWeb.StatsController.html#stats/2"},{"type":"module","title":"PlausibleWeb.StatsView","doc":"","ref":"PlausibleWeb.StatsView.html"},{"type":"function","title":"PlausibleWeb.StatsView.__resource__/0","doc":"The resource name, as an atom, for this view","ref":"PlausibleWeb.StatsView.html#__resource__/0"},{"type":"function","title":"PlausibleWeb.StatsView.large_number_format/1","doc":"","ref":"PlausibleWeb.StatsView.html#large_number_format/1"},{"type":"function","title":"PlausibleWeb.StatsView.plausible_url/0","doc":"","ref":"PlausibleWeb.StatsView.html#plausible_url/0"},{"type":"function","title":"PlausibleWeb.StatsView.pretty_stats_url/1","doc":"Returns a readable stats URL.\n\nNative Phoenix router functions percent-encode all diacritics, resulting in\nugly URLs, e.g. `https://plausible.io/café.com` transforms into\n`https://plausible.io/caf%C3%A9.com`.\n\nThis function encodes only the slash (`/`) character from the site's domain.","ref":"PlausibleWeb.StatsView.html#pretty_stats_url/1"},{"type":"function","title":"Examples - PlausibleWeb.StatsView.pretty_stats_url/1","doc":"iex> PlausibleWeb.StatsView.pretty_stats_url(%Plausible.Site{domain: \"user.gittea.io/repo\"})\n \"http://localhost:8000/user.gittea.io%2Frepo\"\n\n iex> PlausibleWeb.StatsView.pretty_stats_url(%Plausible.Site{domain: \"anakin.test\"})\n \"http://localhost:8000/anakin.test\"\n\n iex> PlausibleWeb.StatsView.pretty_stats_url(%Plausible.Site{domain: \"café.test\"})\n \"http://localhost:8000/café.test\"","ref":"PlausibleWeb.StatsView.html#pretty_stats_url/1-examples"},{"type":"function","title":"PlausibleWeb.StatsView.render/2","doc":"Renders the given template locally.","ref":"PlausibleWeb.StatsView.html#render/2"},{"type":"function","title":"PlausibleWeb.StatsView.shared_link_password.html/1","doc":"","ref":"PlausibleWeb.StatsView.html#shared_link_password.html/1"},{"type":"function","title":"PlausibleWeb.StatsView.site_locked.html/1","doc":"","ref":"PlausibleWeb.StatsView.html#site_locked.html/1"},{"type":"function","title":"PlausibleWeb.StatsView.stats.html/1","doc":"","ref":"PlausibleWeb.StatsView.html#stats.html/1"},{"type":"function","title":"PlausibleWeb.StatsView.stats_container_class/1","doc":"","ref":"PlausibleWeb.StatsView.html#stats_container_class/1"},{"type":"function","title":"PlausibleWeb.StatsView.template_not_found/2","doc":"Callback invoked when no template is found.\nBy default it raises but can be customized\nto render a particular template.","ref":"PlausibleWeb.StatsView.html#template_not_found/2"},{"type":"function","title":"PlausibleWeb.StatsView.waiting_first_pageview.html/1","doc":"","ref":"PlausibleWeb.StatsView.html#waiting_first_pageview.html/1"},{"type":"module","title":"PlausibleWeb.Tracker","doc":"","ref":"PlausibleWeb.Tracker.html"},{"type":"function","title":"PlausibleWeb.Tracker.call/2","doc":"","ref":"PlausibleWeb.Tracker.html#call/2"},{"type":"function","title":"PlausibleWeb.Tracker.child_spec/1","doc":"Returns a specification to start this module under a supervisor.\n\nSee `Supervisor`.","ref":"PlausibleWeb.Tracker.html#child_spec/1"},{"type":"function","title":"PlausibleWeb.Tracker.init/1","doc":"","ref":"PlausibleWeb.Tracker.html#init/1"},{"type":"module","title":"PlausibleWeb.TwoFactor.Session","doc":"Functions for managing session data related to Two-Factor\nAuthentication.","ref":"PlausibleWeb.TwoFactor.Session.html"},{"type":"function","title":"PlausibleWeb.TwoFactor.Session.clear_2fa_user/1","doc":"","ref":"PlausibleWeb.TwoFactor.Session.html#clear_2fa_user/1"},{"type":"function","title":"PlausibleWeb.TwoFactor.Session.clear_remember_2fa/1","doc":"","ref":"PlausibleWeb.TwoFactor.Session.html#clear_remember_2fa/1"},{"type":"function","title":"PlausibleWeb.TwoFactor.Session.get_2fa_user/1","doc":"","ref":"PlausibleWeb.TwoFactor.Session.html#get_2fa_user/1"},{"type":"function","title":"PlausibleWeb.TwoFactor.Session.maybe_set_remember_2fa/3","doc":"","ref":"PlausibleWeb.TwoFactor.Session.html#maybe_set_remember_2fa/3"},{"type":"function","title":"PlausibleWeb.TwoFactor.Session.remember_2fa?/2","doc":"","ref":"PlausibleWeb.TwoFactor.Session.html#remember_2fa?/2"},{"type":"function","title":"PlausibleWeb.TwoFactor.Session.remember_2fa_days/0","doc":"","ref":"PlausibleWeb.TwoFactor.Session.html#remember_2fa_days/0"},{"type":"function","title":"PlausibleWeb.TwoFactor.Session.set_2fa_user/2","doc":"","ref":"PlausibleWeb.TwoFactor.Session.html#set_2fa_user/2"},{"type":"module","title":"PlausibleWeb.UnsubscribeController","doc":"","ref":"PlausibleWeb.UnsubscribeController.html"},{"type":"function","title":"PlausibleWeb.UnsubscribeController.monthly_report/2","doc":"","ref":"PlausibleWeb.UnsubscribeController.html#monthly_report/2"},{"type":"function","title":"PlausibleWeb.UnsubscribeController.weekly_report/2","doc":"","ref":"PlausibleWeb.UnsubscribeController.html#weekly_report/2"},{"type":"module","title":"PlausibleWeb.UnsubscribeView","doc":"","ref":"PlausibleWeb.UnsubscribeView.html"},{"type":"function","title":"PlausibleWeb.UnsubscribeView.__resource__/0","doc":"The resource name, as an atom, for this view","ref":"PlausibleWeb.UnsubscribeView.html#__resource__/0"},{"type":"function","title":"PlausibleWeb.UnsubscribeView.render/2","doc":"Renders the given template locally.","ref":"PlausibleWeb.UnsubscribeView.html#render/2"},{"type":"function","title":"PlausibleWeb.UnsubscribeView.success.html/1","doc":"","ref":"PlausibleWeb.UnsubscribeView.html#success.html/1"},{"type":"function","title":"PlausibleWeb.UnsubscribeView.template_not_found/2","doc":"Callback invoked when no template is found.\nBy default it raises but can be customized\nto render a particular template.","ref":"PlausibleWeb.UnsubscribeView.html#template_not_found/2"},{"type":"module","title":"PlausibleWeb.UserAuth","doc":"Functions for user session management.\n\nIn it's current shape, both current (legacy) and soon to be implemented (new)\nuser sessions are supported side by side.\n\nOnce the token-based sessions are implemented, `create_user_session/1` will\nstart returning new token instead of the legacy one. At the same time,\n`put_token_in_session/2` will always set the new token. The legacy token will\nstill be accepted from the session cookie. Once 14 days pass (the current time\nwindow for which session cookie is valid without any activity), the legacy\ncookies won't be accepted anymore (token retrieval will most likely be\ninstrumented to confirm the usage falls in the mentioned time window as\nexpected) and the logic will be cleaned of branching for legacy session.","ref":"PlausibleWeb.UserAuth.html"},{"type":"function","title":"PlausibleWeb.UserAuth.get_user/1","doc":"","ref":"PlausibleWeb.UserAuth.html#get_user/1"},{"type":"function","title":"PlausibleWeb.UserAuth.get_user_session/1","doc":"","ref":"PlausibleWeb.UserAuth.html#get_user_session/1"},{"type":"function","title":"PlausibleWeb.UserAuth.log_in_user/3","doc":"","ref":"PlausibleWeb.UserAuth.html#log_in_user/3"},{"type":"function","title":"PlausibleWeb.UserAuth.log_out_user/1","doc":"","ref":"PlausibleWeb.UserAuth.html#log_out_user/1"},{"type":"function","title":"PlausibleWeb.UserAuth.set_logged_in_cookie/1","doc":"Sets the `logged_in` cookie share with the static site for determining\nwhether client is authenticated.\n\nAs it's a separate cookie, there's a chance it might fall out of sync\nwith session cookie state due to manual deletion or premature expiration.","ref":"PlausibleWeb.UserAuth.html#set_logged_in_cookie/1"},{"type":"extras","title":"Introduction","doc":"# Plausible Analytics\n\n \n \n \n \n \n \n Simple Metrics |\n Lightweight Script |\n Privacy Focused |\n Open Source |\n Docs |\n Contributing \n \n \n\n[Plausible Analytics](https://plausible.io/) is an easy to use, lightweight (< 1 KB), open source and privacy-friendly alternative to Google Analytics. It doesn’t use cookies and is fully compliant with GDPR, CCPA and PECR. You can self-host Plausible Community Edition or have us manage Plausible Analytics for you in the cloud. Here's [the live demo of our own website stats](https://plausible.io/plausible.io). Made and hosted in the EU 🇪🇺\n\nWe are dedicated to making web analytics more privacy-friendly. Our mission is to reduce corporate surveillance by providing an alternative web analytics tool which doesn’t come from the AdTech world. We are completely independent and solely funded by our subscribers.\n\n","ref":"readme.html"},{"type":"extras","title":"Why Plausible? - Introduction","doc":"Here's what makes Plausible a great Google Analytics alternative and why we're trusted by 12,000+ paying subscribers to deliver their website and business insights:\n\n- **Clutter Free**: Plausible Analytics provides [simple web analytics](https://plausible.io/simple-web-analytics) and it cuts through the noise. No layers of menus, no need for custom reports. Get all the important insights on one single page. No training necessary.\n- **GDPR/CCPA/PECR compliant**: Measure traffic, not individuals. No personal data or IP addresses are ever stored in our database. We don't use cookies or any other persistent identifiers. [Read more about our data policy](https://plausible.io/data-policy)\n- **Lightweight**: Plausible Analytics works by loading a script on your website, like Google Analytics. Our script is [45x smaller](https://plausible.io/lightweight-web-analytics), making your website quicker to load. You can also send events directly to our [events API](https://plausible.io/docs/events-api).\n- **Email or Slack reports**: Keep an eye on your traffic with weekly and/or monthly email or Slack reports. You can also get traffic spike notifications.\n- **Invite team members and share stats**: You have the option to be transparent and open your web analytics to everyone. Your website stats are private by default but you can choose to make them public so anyone with your custom link can view them. You can [invite team members](https://plausible.io/docs/users-roles) and assign user roles too.\n- **Define key goals and track conversions**: Create custom events with custom dimensions to track conversions and attribution to understand and identify the trends that matter. Includes easy ways to track outbound link clicks, file downloads and 404 error pages.\n- **Search keywords**: Integrate your dashboard with Google Search Console to get the most accurate reporting on your search keywords.\n- **SPA support**: Plausible is built with modern web frameworks in mind and it works automatically with any pushState based router on the frontend. We also support frameworks that use the URL hash for routing. See [our documentation](https://plausible.io/docs/hash-based-routing).\n- **Smooth transition from Google Analytics**: There's a realtime dashboard, entry pages report and integration with Search Console. You can track your paid campaigns and conversions. You can invite team members. You can even [import your historical Google Analytics stats](https://plausible.io/docs/google-analytics-import). Learn how to [get the most out of your Plausible experience](https://plausible.io/docs/your-plausible-experience) and join thousands who have already migrated from Google Analytics.\n\nInterested to learn more? [Read more on our website](https://plausible.io), learn more about the team and the goals of the project on [our about page](https://plausible.io/about) or explore [the documentation](https://plausible.io/docs).","ref":"readme.html#why-plausible"},{"type":"extras","title":"Why is Plausible Analytics Cloud not free like Google Analytics? - Introduction","doc":"Plausible Analytics is an independently owned and actively developed project. To keep the project development going, to stay in business, to continue putting effort into building a better product and to cover our costs, we need to charge a fee.\n\nGoogle Analytics is free because Google has built their company and their wealth by collecting and analyzing huge amounts of personal information from web users and using these personal and behavioral insights to sell advertisements.\n\nPlausible has no part in that business model. No personal data is being collected and analyzed either. With Plausible, you 100% own and control all of your website data. This data is not being shared with or sold to any third-parties.\n\nWe choose the subscription business model rather than the business model of surveillance capitalism. See reasons why we believe you should [stop using Google Analytics on your website](https://plausible.io/blog/remove-google-analytics).","ref":"readme.html#why-is-plausible-analytics-cloud-not-free-like-google-analytics"},{"type":"extras","title":"Getting started with Plausible - Introduction","doc":"The easiest way to get started with Plausible Analytics is with [our official managed service in the cloud](https://plausible.io/#pricing). It takes 2 minutes to start counting your stats with a worldwide CDN, high availability, backups, security and maintenance all done for you by us.\n\nIn order to be compliant with the GDPR and the Schrems II ruling, all visitor data for our managed service in the cloud is exclusively processed on servers and cloud infrastructure owned and operated by European providers. Your website data never leaves the EU.\n\nOur managed hosting can save a substantial amount of developer time and resources. For most sites this ends up being the best value option and the revenue goes to funding the maintenance and further development of Plausible. So you’ll be supporting open source software and getting a great service!\n\n#","ref":"readme.html#getting-started-with-plausible"},{"type":"extras","title":"Can Plausible be self-hosted? - Introduction","doc":"Plausible is [open source web analytics](https://plausible.io/open-source-website-analytics) and we have a free as in beer and self-hosted solution called [Plausible Community Edition (CE)](https://plausible.io/self-hosted-web-analytics). Here are the differences between Plausible Analytics managed hosting in the cloud and the Plausible CE:\n\n| | Plausible Analytics Cloud | Plausible Community Edition |\n| ------------- | ------------- | ------------- |\n| **Infrastructure management** | Easy and convenient. It takes 2 minutes to start counting your stats with a worldwide CDN, high availability, backups, security and maintenance all done for you by us. We manage everything so you don’t have to worry about anything and can focus on your stats. | You do it all yourself. You need to get a server and you need to manage your infrastructure. You are responsible for installation, maintenance, upgrades, server capacity, uptime, backup, security, stability, consistency, loading time and so on.|\n| **Release schedule** | Continuously developed and improved with new features and updates multiple times per week. | [It's a long term release](https://plausible.io/blog/building-open-source) published twice per year so latest features and improvements won't be immediately available.|\n| **Premium features** | All features available as listed in [our pricing plans](https://plausible.io/#pricing). | Selected premium features such as funnels and ecommerce revenue goals are not available as we aim to ensure a [protective barrier around our cloud offering](https://plausible.io/blog/community-edition).|\n| **Bot filtering** | Advanced bot filtering for more accurate stats. Our algorithm detects and excludes non-human traffic patterns. We also exclude known bots by the User-Agent header and filter out traffic from data centers and referrer spam domains. | Basic bot filtering that targets the most common non-human traffic based on the User-Agent header and referrer spam domains.|\n| **Server location** | All visitor data is exclusively processed on EU-owned cloud infrastructure. We keep your site data on a secure, encrypted and green energy powered server in Germany. This ensures that your site data is protected by the strict European Union data privacy laws and ensures compliance with GDPR. Your website data never leaves the EU. | You have full control and can host your instance on any server in any country that you wish. Host it on a server in your basement or host it with any cloud provider wherever you want, even those that are not GDPR compliant.|\n| **Data portability** | You see all your site stats and metrics on our modern-looking, simple to use and fast loading dashboard. You can only see the stats aggregated in the dashboard. You can download the stats using the [CSV export](https://plausible.io/docs/export-stats), [stats API](https://plausible.io/docs/stats-api) or tools such as the [Data Studio Connector](https://plausible.io/docs/integration-guides#google-data-studio). | Do you want access to the raw data? Self-hosting gives you that option. You can take the data directly from the ClickHouse database. |\n| **Premium support** | Real support delivered by real human beings who build and maintain Plausible. | Premium support is not included. CE is community supported only.|\n| **Costs** | There's a cost associated with providing an analytics service so we charge a subscription fee. We choose the subscription business model rather than the business model of surveillance capitalism. Your money funds further development of Plausible. | You need to pay for your server, CDN, backups and whatever other cost there is associated with running the infrastructure. You never have to pay any fees to us. Your money goes to 3rd party companies with no connection to us.|\n\nInterested in self-hosting Plausible CE on your server? Take a look at our [Plausible CE installation instructions](https://github.com/plausible/community-edition/).\n\nPlausible CE is a community supported project and there are no guarantees that you will get support from the creators of Plausible to troubleshoot your self-hosting issues. There is a [community supported forum](https://github.com/plausible/analytics/discussions/categories/self-hosted-support) where you can ask for help.\n\nOur only source of funding is our premium, managed service for running Plausible in the cloud.","ref":"readme.html#can-plausible-be-self-hosted"},{"type":"extras","title":"Technology - Introduction","doc":"Plausible Analytics is a standard Elixir/Phoenix application backed by a PostgreSQL database for general data and a Clickhouse\ndatabase for stats. On the frontend we use [TailwindCSS](https://tailwindcss.com/) for styling and React to make the dashboard interactive.","ref":"readme.html#technology"},{"type":"extras","title":"Contributors - Introduction","doc":"For anyone wishing to contribute to Plausible, we recommend taking a look at [our contributor guide](https://github.com/plausible/analytics/blob/master/CONTRIBUTING.md).","ref":"readme.html#contributors"},{"type":"extras","title":"Feedback & Roadmap - Introduction","doc":"We welcome feedback from our community. We have a public roadmap driven by the features suggested by the community members. Take a look at our [feedback board](https://plausible.io/feedback). Please let us know if you have any requests and vote on open issues so we can better prioritize.\n\nTo stay up to date with all the latest news and product updates, make sure to follow us on [X (formerly Twitter)](https://twitter.com/plausiblehq), [LinkedIn](https://www.linkedin.com/company/plausible-analytics/) or [Mastodon](https://fosstodon.org/@plausible).","ref":"readme.html#feedback-roadmap"},{"type":"extras","title":"License & Trademarks - Introduction","doc":"Plausible CE is open source under the GNU Affero General Public License Version 3 (AGPLv3) or any later version. You can [find it here](https://github.com/plausible/analytics/blob/master/LICENSE.md).\n\nTo avoid issues with AGPL virality, we've released the JavaScript tracker which gets included on your website under the MIT license. You can [find it here](https://github.com/plausible/analytics/blob/master/tracker/LICENSE.md).\n\nCopyright (c) 2018-present Plausible Insights OÜ. Plausible Analytics name and logo are trademarks of Plausible Insights OÜ. Please see our [trademark guidelines](https://plausible.io/trademark) for info on acceptable usage.","ref":"readme.html#license-trademarks"},{"type":"extras","title":"Contributing","doc":"# Contributing\n\nWe welcome everyone to contribute to Plausible. This document is to help you on setting up your environment, finding a task, and opening pull requests.","ref":"contributing.html"},{"type":"extras","title":"Development setup - Contributing","doc":"The easiest way to get up and running is to [install](https://docs.docker.com/get-docker/) and use Docker for running both Postgres and Clickhouse.\n\nMake sure Docker, Elixir, Erlang and Node.js are all installed on your development machine. The [`.tool-versions`](https://github.com/plausible/analytics/blob/master/.tool-versions) file is available to use with [asdf](https://github.com/asdf-vm/asdf) or similar tools.\n\n#","ref":"contributing.html#development-setup"},{"type":"extras","title":"Start the environment - Contributing","doc":"1. Run both `make postgres` and `make clickhouse`.\n2. You can set up everything with `make install`, alternatively run each command separately:\n 1. Run `mix deps.get`. This will download the required Elixir dependencies.\n 2. Run `mix ecto.create`. This will create the required databases in both Postgres and Clickhouse.\n 3. Run `mix ecto.migrate` to build the database schema.\n 4. Run `mix run priv/repo/seeds.exs` to seed the database. Check the [Seeds](#Seeds) section for more.\n 5. Run `npm ci --prefix assets` to install the required client-side dependencies.\n 6. Run `npm ci --prefix tracker` to install the required tracker dependencies.\n 7. Run `mix assets.setup` to install Tailwind and Esbuild\n 8. Run `npm run deploy --prefix tracker` to generate tracker files in `priv/tracker/js`\n 9. Run `mix download_country_database` to fetch geolocation database\n3. Run `make server` or `mix phx.server` to start the Phoenix server.\n4. The system is now available on `localhost:8000`.\n\n#","ref":"contributing.html#start-the-environment"},{"type":"extras","title":"Seeds - Contributing","doc":"You can optionally seed your database to automatically create an account and a site with stats:\n\n1. Run `mix run priv/repo/seeds.exs` to seed the database.\n2. Start the server with `make server` and navigate to `http://localhost:8000/login`.\n3. Log in with the following e-mail and password combination: `user@plausible.test` and `plausible`.\n4. You should now have a `dummy.site` site with generated stats.\n\nAlternatively, you can manually create a new account:\n\n1. Navigate to `http://localhost:8000/register` and fill in the form.\n2. Fill in the rest of the forms and for the domain use `dummy.site`\n3. Skip the JS snippet and click start collecting data.\n4. Run `mix send_pageview` from the terminal to generate a fake pageview event for the dummy site.\n5. You should now be all set!\n\n#","ref":"contributing.html#seeds"},{"type":"extras","title":"Stopping Docker containers - Contributing","doc":"1. Stop and remove the Postgres container with `make postgres-stop`.\n2. Stop and remove the Clickhouse container with `make clickhouse-stop`.\n\nVolumes are preserved. You'll find that the Postgres and Clickhouse state are retained when you bring them up again the next time: no need to re-register and so on.\n\nNote: Since we are deleting the containers, be careful when deleting volumes with `docker volume prune`. You might accidentally delete the database and would have to go through re-registration process.\n\n#","ref":"contributing.html#stopping-docker-containers"},{"type":"extras","title":"Pre-commit hooks - Contributing","doc":"`pre-commit` requires Python to be available locally and covers Elixir, JavaScript, and CSS. Set up with `pip install --user pre-commit` followed by `pre-commit install`. Conversely, if the prompts are far too bothersome, remove with `pre-commit uninstall`.","ref":"contributing.html#pre-commit-hooks"},{"type":"extras","title":"Finding a task - Contributing","doc":"Bugs can be found in our [issue tracker](https://github.com/plausible/analytics/issues). Issues are usually up for grabs.\n\nNew features need to be discussed with the core team and the community first. If you're tackling a feature, please make sure it has been already discussed in the [Discussions tab](https://github.com/plausible/analytics/discussions). We kindly ask contributors to use the discussion comment section to propose a solution before opening a pull request.\n\nPull requests without an associated issue or discussion may still be merged, but we will focus on changes that have already been talked through.","ref":"contributing.html#finding-a-task"}],"content_type":"text/markdown"} |