💬DashboardKpiData

Represent dashboard KPI data.

Types

Counter

Default Fields :

• type : <number> ('counter' | 'percent')

• name : <string>

• value : <number>

• date_range : <array> of <date> optional

• history : <array> of <object> optional

  • label : <string>

  • value : <number>

  • date_range : <array> of <date>

Object Example :

{
    type: 'counter',
    name: 'ACTIVE_USER_COUNT_TOTAL',
    value: 32532
}

or

{
    type: 'counter',
    name: 'ACTIVE_USER_COUNT_LAST_DAY',
    value: 32532,
    date_range: [ '2017-10-19', '2017-10-19' ],
    history: [
        {
            label: 'PREV_DAY',
            value: 31734,
            date_range: [ '2017-10-18', '2017-10-18' ]
        },
        {
            label: 'PREV_WEEK',
            value: 33765,
            date_range: [ '2017-10-12', '2017-10-12' ]
        },
        {
            label: 'PREV_MONTH',
            value: 28784,
            date_range: [ '2017-09-19', '2017-09-19' ]
        },
        {
            label: 'PREV_YEAR',
            value: 12352,
            date_range: [ '2016-10-19', '2016-10-19' ]
        }
    ]
}

Chart

Default Fields :

• type : <number> ('line' | 'columns')

• name : <string>

• x_axis : <object>

  • type : <string> ('date' | 'year_week' | 'year_month' | 'hour' | 'weekday'| 'string'| 'number')

  • range : <array> of <mixed> optional

• y_axis : <object>

  • type : <string> ('number')

  • range : <array> of <mixed>

• lines : <array> of <object>

  • dots : <array> of <object>

    • x : <mixed>

    • y : <mixed>

• columns : <array> of <object>

  • values : <array> of <object>

    • x : <mixed>

    • y : <mixed>

Either lines or columns is supplied.

Object Example :

{
    type: 'line',
    name: 'ACTIVE_USER_COUNT_DAILY',
    x_axis: {
        type: 'date',
        range: [ '2017-05-19', '2017-10-20' ]
    },
    y_axis: {
        type: 'number',
        range: [ 1000, 1500 ]
    },
    lines: [
        {
            dots: [
                {
                    x: '2017-10-20',
                    y: 1324
                },
                {
                    x: '2017-10-19',
                    y: 1423
                },
                ...
            ]
        }
    ]
}

or

{
    type: 'columns',
    name: 'TRIP_COUNT_PER_HOUR_BREAKDOWN',
    x_axis: {
        type: 'hour',
        range: [ 0, 23 ]
    },
    y_axis: {
        type: 'number',
        range: [ 100, 1500 ]
    },
    columns: [
        {
            values: [
                {
                    x: 0,
                    y: 142
                },
                {
                    x: 1,
                    y: 321
                },
                ...
            ]
        }
    ]
}

Pie

Default Fields :

• type : <number> ('pie')

• name : <string>

• sections : <array> of <object>

  • values : <array> of <object>

    • label : <string>

    • value : <number>

Object Example :

{
    type: 'pie',
    name: 'ACTIVE_USER_COUNT_PER_DEVICE_BREAKDOWN',
    sections: [
        {
            values: [
                {
                    label: 'iphone',
                    value: 344
                },
                {
                    label: 'ipad',
                    value: 6
                },
                {
                    label: 'android',
                    value: 5
                }
            ]
        }
    ]
}