Analytics.screen

Feature description

Leaves an analytics log at the moment of entering the screen. If you call it when entering a page screen A log of that type is sent.

log_nameIf it is not specified, based on the current path <pathname>::screen a name in the format is automatically used. In addition to the value you passed, the log parameters also automatically include the current page's query string (search), entrance path (referrer), document title(document_title), deployment information (deployment_id, deployment_timestamp) is automatically included.

The current page URL is httpsIf it is not, the log is not sent.

Type

Analytics.screen(params?: { log_name?: string } & { [key: string]: LogParam }): Promise<void> | undefined;

Params

// Keys other than log_name are also recorded as log parameters.
type LogParam = string | number | boolean | null | undefined;

Response

The current page URL is httpsIf it is not, the log is not sent and undefinedis returned.

Example code

JavaScript

import { Analytics } from "@apps-in-toss/web-framework";

// Call it once when entering the page.
Analytics.screen({ entry_point: "home" });