GET /v1/commerce/analytics/summary

GET/v1/commerce/analytics/summary

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Responses

200OK

abandoned_carts_countinteger<int64>required

active_carts_countinteger<int64>required

booking_upcoming_7dMerchantUpcomingBooking[] | nullrequired

Show properties

Array of MerchantUpcomingBooking

customer_namestring

delivery_datestringrequired

delivery_timeslotstring

order_idstringrequired

order_nostringrequired

statusstringrequired

booking_upcoming_countinteger<int64>required

gmv_30dinteger<int64>required

gmv_7dinteger<int64>required

gmv_todayinteger<int64>required

orders_by_statusobjectrequired

orders_todayinteger<int64>required

paid_countinteger<int64>required

pending_delivery_countinteger<int64>required

pending_payment_countinteger<int64>required

top_productsMerchantTopProduct[] | nullrequired

Show properties

Array of MerchantTopProduct

product_idstringrequired

revenueinteger<int64>required

titlestringrequired

unitsinteger<int64>required

defaultError

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/commerce/analytics/summary"

const response = await fetch("/v1/commerce/analytics/summary", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/commerce/analytics/summary",
)

Response

{
  "abandoned_carts_count": 0,
  "active_carts_count": 0,
  "booking_upcoming_7d": [
    {
      "customer_name": "string",
      "delivery_date": "string",
      "delivery_timeslot": "string",
      "order_id": "string",
      "order_no": "string",
      "status": "string"
    }
  ],
  "booking_upcoming_count": 0,
  "gmv_30d": 0,
  "gmv_7d": 0,
  "gmv_today": 0,
  "orders_by_status": {},
  "orders_today": 0,
  "paid_count": 0,
  "pending_delivery_count": 0,
  "pending_payment_count": 0,
  "top_products": [
    {
      "product_id": "string",
      "revenue": 0,
      "title": "string",
      "units": 0
    }
  ]
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}