Options

Options

Options used when initializing Amplitude

Option	Type	Default	Description
apiEndpoint	string	api.amplitude.com	Endpoint to send amplitude event requests to.
batchEvents	string	false	If true, then events are batched together and uploaded only when the number of unsent events is greater than or equal to eventUploadThreshold or after eventUploadPeriodMillis milliseconds have passed since the first unsent event was logged.
cookieExpiration	string	365	The number of days after which the Amplitude cookie will expire. 12 months is for GDPR compliance.
cookieName	string	amplitude_id	DEPRECATED
sameSiteCookie	string	'None'	Sets the SameSite flag on the amplitude cookie. Decides cookie privacy policy.
cookieForceUpgrade	string	false	Forces pre-v6.0.0 instances to adopt post-v6.0.0 compat cookie formats.
deferInitialization	string	null	If true, disables the core functionality of the sdk, including saving a cookie and all logging, until explicitly enabled. To enable tracking, please call amplitude.getInstance().enableTracking() Note: This will not affect users who already have an amplitude cookie. The decision to track events is determined by whether or not a user has an amplitude analytics cookie. If the cookieExpiration</code> is manually defined to be a short lifespan, you may need to run amplitude.getInstance().enableTracking()` upon the cookie expiring or upon logging in.
disableCookies	string	false	Disable Ampllitude cookies altogether.
deviceId	string	A randomly generated UUID.	The custom Device ID to set. Note: This is not recommended unless you know what you are doing (e.g. you have your own system for tracking user devices).
deviceIdFromUrlParam	string	false	If true, then the SDK will parse Device ID values from the URL parameter amp_device_id if available. Device IDs defined in the configuration options during init will take priority over Device IDs from URL parameters.
domain	string	The top domain of the current page's URL. ('https://amplitude.com')	Set a custom domain for the Amplitude cookie. To include subdomains, add a preceding period, eg: .amplitude.com.
eventUploadPeriodMillis	string	30000 (30 sec)	Amount of time in milliseconds that the SDK waits before uploading events if batchEvents is true.
eventUploadThreshold	string	30	Minimum number of events to batch together per request if batchEvents is true.
forceHttps	string	true	If true, the events will always be uploaded to HTTPS endpoint. Otherwise, it will use the embedding site's protocol.
includeFbclid	string	false	If true, captures the fbclid URL parameter as well as the user's initial_fbclid via a setOnce operation.
includeGclid	string	false	If true, captures the gclid URL parameter as well as the user's initial_gclid via a setOnce operation.
includeReferrer	string	false	If true, captures the referrer and referring_domain for each session, as well as the user's initial_referrer and initial_referring_domain via a setOnce operation.
includeUtm	string	false	If true, finds UTM parameters in the query string or the _utmz cookie, parses, and includes them as user properties on all events uploaded. This also captures initial UTM parameters for each session via a setOnce operation.
language	string	The language determined by the browser	Custom language to set.
library	string	{ name: 'amplitude-js', version: packageJsonVersion }	Values for the library version
logLevel	string	WARN	Level of logs to be printed in the developer console. Valid values are 'DISABLE', 'ERROR', 'WARN', 'INFO'. To learn more about the different options, see below.
logAttributionCapturedEvent	string	false	If true, the SDK will log an Amplitude event anytime new attribution values are captured from the user. Note: These events count towards your event volume. Event name being logged: [Amplitude] Attribution Captured. Event Properties that can be logged: utm_source, utm_medium, utm_campaign, utm_term, utm_content, referrer, referring_domain, gclid, fbclid. For UTM properties to be logged, includeUtm must be set to true. For the referrer and referring_domain properties to be logged, includeReferrer must be set to true. For the gclid property to be logged, includeGclid must be set to true. For the fbclid property to be logged, includeFbclid must be set to true.
optOut	string	false	Whether or not to disable tracking for the current user.
onError	string	() => {}	Function to call on error.
onExitPage	string	() => {}	Function called when the user exits the browser. Useful logging on page exit.
plan	string		Tracking plan properties
plan.branch	string		The tracking plan branch name e.g. "main"
plan.source	string		The tracking plan source e.g. "web"
plan.version	string		The tracking plan version e.g. "1", "15"
platform	string	Web	Platform device is running on. Defaults to Web (browser, including mobile browsers).
savedMaxCount	string	1000	Maximum number of events to save in localStorage. If more events are logged while offline, then old events are removed.
saveEvents	string	true	If true, saves events to localStorage and removes them upon successful upload. Note: Without saving events, events may be lost if the user navigates to another page before the events are uploaded.
saveParamsReferrerOncePerSession	string	true	If true, then includeGclid, includeFbclid, includeReferrer, and includeUtm will only track their respective properties once per session. New values that come in during the middle of the user's session will be ignored. Set to false to always capture new values.
secureCookie	string	false	If true, the amplitude cookie will be set with the Secure flag.
sessionTimeout	string	30*60*1000 (30 min)	The time between logged events before a new session starts in milliseconds.
storage	string	''	Sets storage strategy. Options are 'cookies', 'localStorage', 'sessionStorage', or none. Will override disableCookies option
trackingOptions	string	{ city: true, country: true, carrier: true, device_manufacturer: true, device_model: true, dma: true, ip_address: true, language: true, os_name: true, os_version: true, platform: true, region: true, version_name: true}	Type of data associated with a user.
transport	string	http	Network transport mechanism used to send events. Options are 'http' and 'beacon'.
unsetParamsReferrerOnNewSession	string	false	If false, the existing referrer and utm_parameter values will be carried through each new session. If set to true, the referrer and utm_parameter user properties, which include referrer, utm_source, utm_medium, utm_campaign, utm_term, and utm_content, will be set to null upon instantiating a new session. Note: This only works if includeReferrer or includeUtm is set to true.
unsentKey	string	amplitude_unsent	localStorage key that stores unsent events.
unsentIdentifyKey	string	amplitude_unsent_identify	localStorage key that stores unsent identifies.
uploadBatchSize	string	100	The maximum number of events to send to the server per request.
headers	string	{ 'Content-Type': 'application/x-www-form-urlencoded; charset=UTF-8' }	Headers attached to an event(s) upload network request. Custom header properties are merged with this object.
serverZone	string		For server zone related configuration, used for server api endpoint and dynamic configuration.
useDynamicConfig	string		Enable dynamic configuration to find best server url for user.
serverZoneBasedApi	string		To update api endpoint with serverZone change or not. For data residency, recommend to enable it unless using own proxy server.
sessionId	string	null	The custom Session ID for the current session. *Note: This is not recommended unless you know what you are doing because the Session ID of a session is utilized for all session metrics in Amplitude.