Admin API

Insights

Checkout health, failure causes and alerts.

GETWhat dropped in the last 24 hours against a usual day, who caused it and what to do
GETHow payments went: success, failures by cause in plain words, pending and recovered
GETSales, orders and checkout success for a period, with the previous period
GETWhat needs the seller now, money at risk first
GETBest selling products in the last 30 days

What dropped in the last 24 hours against a usual day, who caused it and what to do

GET/admin/2026-11/insights/alerts

scope read_analytics

Response 200

dataarray of objectrequired
data[].idstringrequired
data[].severityenumrequired
One of high medium
data[].sideenumrequired
Who caused it: fewer visitors, StoreLyne, the payment network, banks, buyers, the store setup.
One of traffic our_side payment_network bank buyer store_setup buyer_network
data[].titlestringrequired
data[].detailstringrequired
data[].actionstringrequired
data[].hrefstringrequired
The admin screen that helps.
comparedobjectrequired
compared.fromstringrequired
compared.tostringrequired

Errors

401	`authentication_required`	Send a valid access token or session.
403	`missing_scope`	The app token does not have the scope this endpoint needs.
429	`rate_limited`	Too many requests. Wait for the time in RateLimit-Reset.
500	`internal_error`	Something went wrong on our side. Quote the trace_id to support.

curl https://api.storelyne.com/admin/2026-11/insights/alerts \
  -H "Authorization: Bearer pat_live_..."

const res = await fetch('https://api.storelyne.com/admin/2026-11/insights/alerts', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.STORELYNE_TOKEN}`,
  },
});
const data = await res.json();

Response 200

{
  "data": [
    {
      "id": "string",
      "severity": "high",
      "side": "traffic",
      "title": "Festive saree",
      "detail": "string",
      "action": "string",
      "href": "string"
    }
  ],
  "compared": {
    "from": "string",
    "to": "string"
  }
}

How payments went: success, failures by cause in plain words, pending and recovered

GET/admin/2026-11/insights/checkout-health

scope read_analytics

Query parameters

periodenum
One of today 7d 30d
Default "7d"

Response 200

periodenumrequired
One of today 7d 30d
attemptsintegerrequired
paidintegerrequired
success_ratenumber or nullrequired
failedobjectrequired
failed.countintegerrequired
failed.valueintegerrequired
pendingobjectrequired
pending.countintegerrequired
pending.valueintegerrequired
recoveredobjectrequired
Orders paid after an earlier attempt failed.
recovered.countintegerrequired
recovered.valueintegerrequired
platform_errorsintegerrequired
causesarray of objectrequired
causes[].cause_groupstringrequired
causes[].cause_codestringrequired
causes[].seller_messagestringrequired
causes[].attemptsintegerrequired
causes[].valueintegerrequired
causes[].sharenumberrequired
recent_failedarray of objectrequired
recent_failed[].attempt_idID (att_...)required
recent_failed[].order_idID (ord_...)required
recent_failed[].order_namestringrequired
recent_failed[].methodstringrequired
recent_failed[].amountintegerrequired
recent_failed[].seller_messagestring or nullrequired
recent_failed[].recoveredbooleanrequired
recent_failed[].created_attimestamprequired

Errors

400	`validation_failed`	A field in the request is missing or invalid. See param.
401	`authentication_required`	Send a valid access token or session.
403	`missing_scope`	The app token does not have the scope this endpoint needs.
429	`rate_limited`	Too many requests. Wait for the time in RateLimit-Reset.
500	`internal_error`	Something went wrong on our side. Quote the trace_id to support.

curl https://api.storelyne.com/admin/2026-11/insights/checkout-health \
  -H "Authorization: Bearer pat_live_..."

const res = await fetch('https://api.storelyne.com/admin/2026-11/insights/checkout-health', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.STORELYNE_TOKEN}`,
  },
});
const data = await res.json();

Response 200

{
  "period": "today",
  "attempts": 1,
  "paid": 1,
  "success_rate": 1,
  "failed": {
    "count": 1,
    "value": 1
  },
  "pending": {
    "count": 1,
    "value": 1
  },
  "recovered": {
    "count": 1,
    "value": 1
  },
  "platform_errors": 1,
  "causes": [
    {
      "cause_group": "string",
      "cause_code": "string",
      "seller_message": "Hand block printed cotton.",
      "attempts": 1,
      "value": 1,
      "share": 1
    }
  ],
  "recent_failed": [
    {
      "attempt_id": "att_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
      "order_id": "ord_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
      "order_name": "Festive saree",
      "method": "string",
      "amount": 49900,
      "seller_message": "Hand block printed cotton.",
      "recovered": false,
      "created_at": "2026-11-04T10:00:00.000Z"
    }
  ]
}

Sales, orders and checkout success for a period, with the previous period

GET/admin/2026-11/insights/summary

scope read_analytics

Query parameters

periodenum
One of today 7d 30d
Default "today"

Response 200

periodenumrequired
One of today 7d 30d
currencystringrequired
salesintegerrequired
Confirmed orders (paid or cash on delivery), GST included, in paise.
ordersintegerrequired
average_order_valueinteger or nullrequired
checkout_successnumber or nullrequired
Share of finished payment attempts that were paid, 0 to 1; null before any.
previousobjectrequired
previous.salesintegerrequired
previous.ordersintegerrequired
pointsarray of integerrequired
Sales per hour (today) or per day.

Errors

400	`validation_failed`	A field in the request is missing or invalid. See param.
401	`authentication_required`	Send a valid access token or session.
403	`missing_scope`	The app token does not have the scope this endpoint needs.
429	`rate_limited`	Too many requests. Wait for the time in RateLimit-Reset.
500	`internal_error`	Something went wrong on our side. Quote the trace_id to support.

curl https://api.storelyne.com/admin/2026-11/insights/summary \
  -H "Authorization: Bearer pat_live_..."

const res = await fetch('https://api.storelyne.com/admin/2026-11/insights/summary', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.STORELYNE_TOKEN}`,
  },
});
const data = await res.json();

Response 200

{
  "period": "today",
  "currency": "INR",
  "sales": 1,
  "orders": 1,
  "average_order_value": 1,
  "checkout_success": 1,
  "previous": {
    "sales": 1,
    "orders": 1
  },
  "points": [
    1
  ]
}

What needs the seller now, money at risk first

GET/admin/2026-11/insights/todo

scope read_analytics

Response 200

dataarray of objectrequired
data[].idstringrequired
data[].titlestringrequired
data[].detailstringrequired
data[].amountinteger or nullrequired
Money at risk in paise; null for items without money.
data[].hrefstringrequired
data[].toneenumrequired
One of bad warn neutral

Errors

401	`authentication_required`	Send a valid access token or session.
403	`missing_scope`	The app token does not have the scope this endpoint needs.
429	`rate_limited`	Too many requests. Wait for the time in RateLimit-Reset.
500	`internal_error`	Something went wrong on our side. Quote the trace_id to support.

curl https://api.storelyne.com/admin/2026-11/insights/todo \
  -H "Authorization: Bearer pat_live_..."

const res = await fetch('https://api.storelyne.com/admin/2026-11/insights/todo', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.STORELYNE_TOKEN}`,
  },
});
const data = await res.json();

Response 200

{
  "data": [
    {
      "id": "string",
      "title": "Festive saree",
      "detail": "string",
      "amount": 49900,
      "href": "string",
      "tone": "bad"
    }
  ]
}

Best selling products in the last 30 days

GET/admin/2026-11/insights/top-products

scope read_analytics

Response 200

dataarray of objectrequired
data[].product_idID (prd_...)required
data[].titlestringrequired
data[].unitsintegerrequired
data[].salesintegerrequired

Errors

401	`authentication_required`	Send a valid access token or session.
403	`missing_scope`	The app token does not have the scope this endpoint needs.
429	`rate_limited`	Too many requests. Wait for the time in RateLimit-Reset.
500	`internal_error`	Something went wrong on our side. Quote the trace_id to support.

curl https://api.storelyne.com/admin/2026-11/insights/top-products \
  -H "Authorization: Bearer pat_live_..."

const res = await fetch('https://api.storelyne.com/admin/2026-11/insights/top-products', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${process.env.STORELYNE_TOKEN}`,
  },
});
const data = await res.json();

Response 200

{
  "data": [
    {
      "product_id": "prd_01JCG8ZQ5S7T0V4X8K2M3N6P9R",
      "title": "Festive saree",
      "units": 1,
      "sales": 1
    }
  ]
}