Category sales

Units sold per category.

GET/stores/{storeId}/v1/analytics/sales-by-category

Scopes (any one)analytics:readRead sales reports analytics.categories:readRead category sales

Query parameters

fromstring (date)required
tostring (date)required

Response

dataarray<object>required
categorystring
unitsinteger
mappingstring
executionobject: Who executed the request: the app, version, installation and store. Field names here are camelCase.
appIdstring (uuid)
versionIdstring (uuid)
installationIdstring (uuid)
storeIdstring (uuid)
requestIdstring (uuid)
generationinteger
routeEpochinteger
appAuthEpochinteger
grantRevisioninteger
metaobjectrequired
metric_definitionobject
timezoneobject
fromstring (date)
tostring (date)
currencyobject
request_idstring (uuid)

Request

cURL

curl -X GET "https://larm.sa/stores/$STORE_ID/v1/analytics/sales-by-category?from=2026-10-01&to=2026-10-15" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Node.js

const response = await fetch(`https://larm.sa/stores/${storeId}/v1/analytics/sales-by-category?from=2026-10-01&to=2026-10-15`, {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${accessToken}`,
  },
})
if (!response.ok) throw new Error((await response.json()).error.code)
const { data, meta } = await response.json()

Python

import requests

response = requests.get(
    f"https://larm.sa/stores/{store_id}/v1/analytics/sales-by-category?from=2026-10-01&to=2026-10-15",
    headers={"Authorization": f"Bearer {access_token}"},
    timeout=15,
)
response.raise_for_status()
data = response.json()["data"]

PHP

$ch = curl_init("https://larm.sa/stores/{$storeId}/v1/analytics/sales-by-category?from=2026-10-01&to=2026-10-15");
curl_setopt_array($ch, [
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . $accessToken],
]);
$data = json_decode(curl_exec($ch), true)['data'];

Response 200

JSON

{
  "data": [
    {
      "category": "Top-up cards",
      "units": 530,
      "mapping": "category"
    }
  ],
  "execution": {
    "appId": "1f2e3d4c-5b6a-4978-8695-a4b3c2d1e0f9",
    "versionId": "9a8b7c6d-5e4f-4a3b-8c2d-1e0f9a8b7c6d",
    "installationId": "c7e4a1f2-6b3d-4e8a-9c05-1d2f3a4b5c6d",
    "storeId": "5b1d7a62-0c4e-4f38-9a51-2e7b3c9d8f10",
    "requestId": "3f0c2b8e-7a51-4c1e-9d0a-5b6f1e2d4c3a",
    "generation": 1,
    "routeEpoch": 4,
    "appAuthEpoch": 1,
    "grantRevision": 2
  },
  "meta": {
    "metric_definition": "dashboard_sales_v1",
    "timezone": "Asia/Riyadh",
    "from": "2026-10-01",
    "to": "2026-10-15",
    "currency": "SAR",
    "request_id": "3f0c2b8e-7a51-4c1e-9d0a-5b6f1e2d4c3a"
  }
}