Nasal Piercings Manipulator

    @elianvancutsem/mostvisitedpages
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.9 • Public • Published

    MostVisitedPages

    Package created to fetch your x most frequent visited pages from Google Analytics and the Google Analytics Data API.

    Both TypeScript and ESModules are supported

    Installation

    npm i @elianvancutsem/mostvisitedpages

    or use a CDN like Skypack

    import { MostVisitedPages } from "https://cdn.skypack.dev/@elianvancutsem/mostvisitedpages@0.0.8";

    Using @elianvancutsem/mostvisitedpages

    The MostVisitedPages constructor takes in two required parameters: credentials & propertyId and one possible undefined parameter options.

    credentials

    Credentials has two variables; client_email and private_key. Both of these can be created by creating a JSON Service Account.

    Follow the Official Google Analytics Data API documentation for more information about how to do this.

    propertyId

    The PropertyId is the PropertyID of the Google analytics property.

    NOTE: the Service account should be added with read & analyze access to the property.

    options

    The options parameter will be used for more configuration options in the future, but is only used right now to exclude certain url's from the return array. The only downside to this is that if you set a limit on your request and x number of url's are exluded, the result will return xresults less instead of your set limit

    Example

    import { MostVisitedPages } from "@elianvancutsem/mostvisitedpages";
    
    const testEmail = "xxx"
    const testKey = "xxx"
    const options = {
        exludeUrls = ['www.elian.codes/']
    }
    
    const mostVisitedPages = new MostVisitedPages({client_email: testEmail, private_key: testKey}, 'xxxxxxxx', options)

    Functions

    getPageViews(limit?: number)

    Function that returns an array of the x most viewed pages in the last 90 days according to Google Analytics.

    This function returns an array of the Page type (which can be imported from @elianvancutsem/mostvisitedpages)

    The limit parameter provides a limit to the number of pages returned, will default to 10 if none is set.

    getPageViewsSince(startDate: string, limit?: number)

    Works like getPageViews() but with a required startDate.

    The startDate parameter can be a date like 2021-10-01 (YYYY-MM-DD) or can be a sring like NdaysAgo or yesterday. It will default to the past 90 days if none is provided.

    getAllPageViewsSince(startDate: string)

    Works like getPageViewsSince() but without a limit on pages.

    getActiveUsers(limit?: number)

    works like getPageViews(), but returns the active users instead of the views.

    getActiveUsersSince(startDate: string, limit?: number)

    works like getPageViewsSince(), but returns the active users instead of the views.

    Types

    types can be imported from @elianvancutsem/mostvisitedpages like the following:

    import { Page } from '@elianvancutsem/mostvisitedpages';

    Options

    {
        excludeUrls?: string[]
    }

    Page

    {
        title: string
        url: string
        views?: number
        users?: number
    }

    Credentials

    {
        client_email: string
        private_key: string
    }

    CommonJS Support

    To use this package with CommonJS, use require(@elianvancutsem/mostvisitedpages) instead of import. Below is an example

    const mvp = require("@elianvancutsem/mostvisitedpages");
    
    const testEmail = "xxx"
    const testKey = "xxx"
    
    const mostVisitedPages = new mvp.MostVisitedPages({client_email: testEmail, private_key: testKey}, 'xxxxxxxx')
    
    const getReport = async () => {
        console.log(await mostVisitedPages.getPageViewsSince('yesterday', 4));
    }
    
    getReport();

    Full Example

    import { MostVisitedPages } from "@elianvancutsem/mostvisitedpages";
    
    const testEmail = "xxx"
    const testKey = "xxx"
    
    const mostVisitedPages = new MostVisitedPages({client_email: testEmail, private_key: testKey}, 'xxxxxxxx')
    
    const getReport = async () => {
        console.log(await mostVisitedPages.getPageViewsSince('yesterday', 4));
    }
    
    getReport();

    Install

    npm i @elianvancutsem/mostvisitedpages

    DownloadsWeekly Downloads

    10

    Version

    0.0.9

    License

    ISC

    Unpacked Size

    10.8 kB

    Total Files

    10

    Last publish

    Collaborators

    • elianvancutsem