Store performance

GET /cx/v1/stores/{range}

The roster with chain totals, percent change against the prior equal-length period, and each store’s share of chain revenue.

curl https://api.plunk.io/cx/v1/stores/this_month \
  -H "Authorization: Bearer sk_live_••••"

{
  "range": "this_month",
  "chainRevenue": 2410083.00,
  "chainOrders": 1181,
  "count": 5,
  "stores": [
    {
      "id": "S01",
      "name": "Main Street",
      "type": "store",
      "revenue": 612044.00,
      "orders": 292,
      "units": 631,
      "aov": 2096.04,
      "deltaPct": 7.9,
      "sharePct": 25.4
    }
  ]
}

GET /cx/v1/stores/{range}/{storeId}

One store’s KPIs and top categories.

{
  "range": "this_month",
  "id": "S01",
  "name": "Main Street",
  "type": "store",
  "kpi": {
    "revenue": 612044.00,
    "orders": 292,
    "units": 631,
    "aov": 2096.04
  },
  "topCategories": [
    { "category": "Sofas", "revenue": 228412.00, "units": 121 }
  ]
}

Was this helpful?

Still stuck? Contact support and include the job or page you were on.