For the complete documentation index, see llms.txt. This page is also available as Markdown.

Dashboard

Customers count in admin dashboard

get

This is for getting the count for customers in the admin dashboard.

Query parameters
durationintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptionalDefault: 1
messagestringOptionalDefault: Successfully got dashboard customers count
get/product/dashboard/admin-customers-count
GET /product/dashboard/admin-customers-count?duration=1 HTTP/1.1
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully got dashboard customers count"
}

Order count in admin dashboard

get

This is for getting the count of orders in the admin dashboard.

Query parameters
durationintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptionalDefault: 1
messagestringOptionalDefault: Successfully got dashboard orders and vendors count based on orders
get/product/dashboard-admin/orders-count
GET /product/dashboard-admin/orders-count?duration=1 HTTP/1.1
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully got dashboard orders and vendors count based on orders"
}

Average order value in admin dashboard

get

This is for getting the average of the order value in admin dashboard.

Query parameters
durationintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptionalDefault: 1
messagestringOptionalDefault: Successfully got the average order value
get/product/dashboard-average-order-value
GET /product/dashboard-average-order-value?duration=1 HTTP/1.1
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully got the average order value"
}

Total Revenue earned

get

This is for getting the total revenue earned from the eCommerce portal and this will be shown in admin dashboard.

Query parameters
durationintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptionalDefault: 1
messagestringOptionalDefault: Successfully got the total revenue amount
get/product/dashboard-total-revenue
GET /product/dashboard-total-revenue?duration=1 HTTP/1.1
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully got the total revenue amount"
}

Average conversion ratio

get

This is for getting the average conversion rate of the eCommerce portal.

Query parameters
durationintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptionalDefault: 1
messagestringOptionalDefault: Successfully got average conversion ratio
get/product/dashboard-average-conversion-ratio
GET /product/dashboard-average-conversion-ratio?duration=1 HTTP/1.1
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "Successfully got average conversion ratio"
}

Graph for weekly sales list

get

This is for getting the graph for the weekly sales list.

Query parameters
productIdintegerRequired
Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptionalDefault: 1
messagestringOptionalDefault: Successfully got the top ten weekly sales list
get/product/dashboard/graph-weekly-saleslist
GET /product/dashboard/graph-weekly-saleslist?productId=1 HTTP/1.1
Authorization: text
Accept: */*
{
  "status": 1,
  "message": "Successfully got the top ten weekly sales list"
}

Dashboard counts

get

This is for fetching the counds in the dashboard.

Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptionalDefault: 1
messagestringOptionalDefault: successfully got the dashboard count.
get/product/dashboard-count
GET /product/dashboard-count HTTP/1.1
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "successfully got the dashboard count."
}

Total vendor count and total product code in admin dashboard.

get

This is for fetching the count for the total vendors and total product, in the admin dashboard.

Header parameters
AuthorizationstringRequired
Responses
200

success response

*/*
statusintegerOptionalDefault: 1
messagestringOptionalDefault: successfully got the dashboard total vendor and total product count.
get/product/dashboard-admin-totalvendor-totalproduct-count
GET /product/dashboard-admin-totalvendor-totalproduct-count HTTP/1.1
Authorization: text
Accept: */*
200

success response

{
  "status": 1,
  "message": "successfully got the dashboard total vendor and total product count."
}

Last updated