logo GoogleAnalytics Sether API

get_google_website_users

Description:

The number of new and returning people who visit your site during a set period of time.

Definition:

function get_google_website_users(
            bytes32 setherToken,
            string memory authToken,
            bytes32 date,
            bytes32 targetId,
            uint8 level,
            bytes32 requestID)
            public

Parameters:

setherToken - Token obtained from the Sether dashboard;
authToken - Token for the GoogleAnalytics platform
date - The date for which the kpi is needed
targetId - The campaign target ID
level - The level of the KPI. Values:
    0 - Ad
    1 - AdSet
    2 - Campaign
    3 - Account
requestID - The requestID to uniquely identify the call on the client side

get_google_website_time_on_site

Description:

The average amount of time a user spends on a page on your website.

Definition:

function get_google_website_time_on_site(
            bytes32 setherToken,
            string memory authToken,
            bytes32 date,
            bytes32 targetId,
            uint8 level,
            bytes32 requestID)
            public

Parameters:

setherToken - Token obtained from the Sether dashboard;
authToken - Token for the GoogleAnalytics platform
date - The date for which the kpi is needed
targetId - The campaign target ID
level - The level of the KPI. Values:
    0 - Ad
    1 - AdSet
    2 - Campaign
    3 - Account
requestID - The requestID to uniquely identify the call on the client side

get_google_website_sessions

Description:

A session is a group of user interactions with your website that take place within a given time frame. For example, a single session can contain multiple page views, events, social interactions, and e-commerce transactions.

Definition:

function get_google_website_sessions(
            bytes32 setherToken,
            string memory authToken,
            bytes32 date,
            bytes32 targetId,
            uint8 level,
            bytes32 requestID)
            public

Parameters:

setherToken - Token obtained from the Sether dashboard;
authToken - Token for the GoogleAnalytics platform
date - The date for which the kpi is needed
targetId - The campaign target ID
level - The level of the KPI. Values:
    0 - Ad
    1 - AdSet
    2 - Campaign
    3 - Account
requestID - The requestID to uniquely identify the call on the client side

get_google_website_page_views

Description:

A page view is defined as a view of a page on your site that is being tracked by the Analytics tracking code. If a user clicks reload after reaching the page, this is counted as an additional page view.

Definition:

function get_google_website_page_views(
            bytes32 setherToken,
            string memory authToken,
            bytes32 date,
            bytes32 targetId,
            uint8 level,
            bytes32 requestID)
            public

Parameters:

setherToken - Token obtained from the Sether dashboard;
authToken - Token for the GoogleAnalytics platform
date - The date for which the kpi is needed
targetId - The campaign target ID
level - The level of the KPI. Values:
    0 - Ad
    1 - AdSet
    2 - Campaign
    3 - Account
requestID - The requestID to uniquely identify the call on the client side

get_google_website_new_users

Description:

The first time a person visits your site, a Google Analytics cookie will be set and a unique identifier will be assigned to them. This will help distinguish the person as a new user.

Definition:

function get_google_website_new_users(
            bytes32 setherToken,
            string memory authToken,
            bytes32 date,
            bytes32 targetId,
            uint8 level,
            bytes32 requestID)
            public

Parameters:

setherToken - Token obtained from the Sether dashboard;
authToken - Token for the GoogleAnalytics platform
date - The date for which the kpi is needed
targetId - The campaign target ID
level - The level of the KPI. Values:
    0 - Ad
    1 - AdSet
    2 - Campaign
    3 - Account
requestID - The requestID to uniquely identify the call on the client side

get_google_website_new_sessions

Description:

The percentage of sessions initiated by users who had never visited the page before.

Definition:

function get_google_website_new_sessions(
            bytes32 setherToken,
            string memory authToken,
            bytes32 date,
            bytes32 targetId,
            uint8 level,
            bytes32 requestID)
            public

Parameters:

setherToken - Token obtained from the Sether dashboard;
authToken - Token for the GoogleAnalytics platform
date - The date for which the kpi is needed
targetId - The campaign target ID
level - The level of the KPI. Values:
    0 - Ad
    1 - AdSet
    2 - Campaign
    3 - Account
requestID - The requestID to uniquely identify the call on the client side

get_google_website_bounce_rate

Description:

Bounce rate consists of single-page sessions divided by all sessions, or the percentage of all sessions on your site in which users viewed only a single page, then leaving the page and so, triggered only a single request to the Analytics server.

Definition:

function get_google_website_bounce_rate(
            bytes32 setherToken,
            string memory authToken,
            bytes32 date,
            bytes32 targetId,
            uint8 level,
            bytes32 requestID)
            public

Parameters:

setherToken - Token obtained from the Sether dashboard;
authToken - Token for the GoogleAnalytics platform
date - The date for which the kpi is needed
targetId - The campaign target ID
level - The level of the KPI. Values:
    0 - Ad
    1 - AdSet
    2 - Campaign
    3 - Account
requestID - The requestID to uniquely identify the call on the client side