Insights Api

Current version: v1.1

View Insights Overview

GET

/insights/overview.json


$storeden = new Storeden\Storeden($config);
$result = $storeden->get('/insights/overview.json');


{
    "today": {
        "orders_count": 0,
        "orders_total": 0,
        "average_order_value": 0
    },
    "yesterday": {
        "orders_count": 0,
        "orders_total": 0,
        "average_order_value": 0
    },
    "last_7_days": {
        "orders_count": 4,
        "orders_total": 162.89,
        "average_order_value": 40.72
    },
    "last_30_days": {
        "orders_count": 4,
        "orders_total": 162.89,
        "average_order_value": 40.72
    },
    "this_month": {
        "orders_count": 4,
        "orders_total": 162.89,
        "average_order_value": 40.72
    },
    "lifetime": {
        "orders_count": 378,
        "orders_total": 32544.34,
        "average_order_value": 86.10
    }
}

View Today Insight Overview

GET

/insights/today.json


$storeden = new Storeden\Storeden($config);
$result = $storeden->get('/insights/today.json');


{
    "insight": {
        "orders_count": 0,
        "orders_total": 0,
        "average_order_value": 0,
        "date": {
            "from": "2021-06-14 00:00:00",
            "to": "2021-06-14 23:59:59"
        }
    }
}

View Yesterday Insight Overview

GET

/insights/yesterday.json


$storeden = new Storeden\Storeden($config);
$result = $storeden->get('/insights/yesterday.json');


{
    "insight": {
        "orders_count": 0,
        "orders_total": 0,
        "average_order_value": 0,
        "date": {
            "from": "2021-06-13 00:00:00",
            "to": "2021-06-13 23:59:59"
        }
    }
}

View Custom Range Insight Overview

GET

/insights/custom.json

from required (date)	Start date to fetch insights
to required (date)	End date to fetch insights


$storeden = new Storeden\Storeden($config);
$result = $storeden->get('/insights/custom.json?from=yyyy-mm-dd&to=yyyy-mm-dd');


{
    "insight": {
        "orders_count": 3,
        "orders_total": 550,
        "average_order_value": 183.33,
        "date": {
            "from": "2021-01-01 00:00:00",
            "to": "2021-02-23 23:59:59"
        }
    }
}