Merchant Analytics

Retrieves the analytics of a logged in merchant.

Endpoint:

GET /company/merchants/{external_id}/analytics

Authorization: Bearer <ACCESS_TOKEN>

Response:

{
    "success": true,
    "data": {
                "price_sum_per_month_paid":{
                    "1719792000000":5662.82,
                    "1722470400000":0.0,
                    "1725148800000":0.0,
                    "1727740800000":1140.0
                },
                "price_sum_per_month_refunded":{
                    "1719792000000":0.0,
                    "1722470400000":0.0,
                    "1725148800000":0.0,
                    "1727740800000":0.0
                },
                "order_count_per_month":{
                    "1719792000000":3,
                    "1722470400000":0,
                    "1725148800000":0,
                    "1727740800000":1
                },
                "unique_customers_per_month":{
                    "1719792000000":3,
                    "1722470400000":0,
                    "1725148800000":0,
                    "1727740800000":20
                },
                "number_of_products_sold_per_month":{
                    "1719792000000":11,
                    "1722470400000":0,
                    "1725148800000":0,
                    "1727740800000":233
                },
                "aov":1700.705,
                "aoc":2.0,
                "average_sales_growth":-0.798686873324598,
                "average_sales_growth_zeros":0.0,
                "credify_growth_score":2270.7049999999995,
                "credify_growth_score_zeros":911.0705,
                "returning_customer_rate":0,
                "total_number_of_orders":4,
                "total_sales":6802.82
            }
}

Fields

info

Note: Map fields are having timestamp (top of the month) as the key.

`price_sum_per_month_paid`

The total amount of paid orders per month.

`price_sum_per_month_refunded`

The total amount of refunded orders per month.

`order_count_per_month`

The total number of orders per month.

`unique_customers_per_month`

The total number of unique customers per month.

`number_of_products_sold_per_month`

The total number of products sold per month.

`aov`

The average order value.

`aoc`

The average order count.

`average_sales_growth`

The average sales growth.

`average_sales_growth_zeros`

The average sales growth including months without sales.

`credify_growth_score`

The credify growth score.

`credify_growth_score_zeros`

The credify growth score including months without sales.

`returning_customer_rate`

The returning customer rate.

`total_number_of_orders`

The total number of orders.

`total_sales`

The total sales.