@bipsync/apiclient/sample-reports/active-users-report.js

var APIClient = require( '@bipsync/apiclient' );


APIClient.generateReportTool( {

    formats : [ 'html' ],

    schema : {
        "type" : "object",
        "properties" : {
            "reportPeriod" : {
                "title" : "WAU/MAU Report Period",
                "type" : "string",
                "enum": [ "wau", "mau" ],
                "enumNames": [ "Weekly Active Users", "Monthly Active Users" ]
            }
        },
        "required" : [ "reportPeriod" ]
    },

    fetch : function() {

        APIClient( 'https://devenvone-api.bipsync.dev' )
            .then( function( client ) {

                client.request( 'v1/analytics/' + client.options.reportPeriod, { body : {
                        select : 'name,singular,initialStage,created,updated',
                        dateFormat : 'm/j/Y'
                    } } )
                    .then( function( report ) {

                        var reportPeriod = client.options.reportPeriod === 'wau' ? 'week' : 'month',
                            period = Object.keys( report[ 'calendar' + reportPeriod ] )[ 0 ],
                            users = report[ 'calendar' + reportPeriod ][ period ].users;

                        var output = {
                            period : period,
                            users : []
                        };

                        var chain = new Promise( function( resolve ) {

                            users.forEach( function( id ) {

                                client.request( 'v1/user/' + id )
                                    .then( function( document ) {
                                        output.users.push( document );

                                        if ( output.users.length === users.length ) {
                                            resolve();
                                        }
                                    } );

                            } );

                        });


                        chain.then( function() {
                            client.output( output );
                        } );

                    } );

            } );

    },

    template : `
    <div class="hide-with-empty-cells">
        <h1>{{month}}</h1>
        <!--<h2>Total Users: {{total}}</h2>-->

        <table class="hide-with-empty-cells">
            <tr>
                <th>User ID</th>
                <th>Name</th>
                <th>Email</th>
            </tr>
            {{#users}}<tr>
                <td>{{id}}</td>
                <td>{{name}}</td>
                <td>{{email}}</td>
            </tr>{{/users}}
        </table>
    </div>`

} );