PaidGoods
API referenceAnalytics

Dashboard home: today, last 30 days, pending work, setup

GET
/v1/stores/{storeId}/overview

Authorization

AuthorizationBearer <token>

API key from Settings → API keys

In: header

Path Parameters

storeId*string

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/stores/string/overview"
{  "today": {    "revenue": [      {        "currency": "string",        "amountMinor": -9007199254740991      }    ],    "orders": -9007199254740991  },  "last30": {    "revenue": [      {        "currency": "string",        "amountMinor": -9007199254740991      }    ],    "orders": -9007199254740991,    "customers": -9007199254740991  },  "pending": {    "confirming": -9007199254740991,    "awaitingManual": -9007199254740991,    "failedDeliveries": -9007199254740991,    "partialDeliveries": -9007199254740991,    "openTickets": -9007199254740991,    "lowStock": [      {        "productId": "dcd53ddb-8104-4e48-8cc0-5df1088c6113",        "variantId": "d53feca7-c65b-4741-aca7-827a42d686bf",        "name": "string",        "available": -9007199254740991      }    ]  },  "setup": [    {      "key": "string",      "title": "string",      "done": true,      "path": "string"    }  ],  "recent": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "number": -9007199254740991,      "uniqueId": "string",      "env": "live",      "status": "pending",      "paymentSummary": "string",      "fulfilmentSummary": "string",      "completionKind": "automatic",      "email": "string",      "currency": "string",      "totalMinor": -9007199254740991,      "paidMinor": -9007199254740991,      "refundedMinor": -9007199254740991,      "paymentMethod": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "label": "string",        "provider": "string"      },      "items": [        {          "name": "string",          "variant": "string",          "qty": -9007199254740991        }      ],      "source": "string",      "buyerCountry": "string",      "createdAt": "string",      "paidAt": "string",      "archived": true,      "note": "string",      "storeCurrency": {        "currency": "string",        "rate": "string",        "rateDate": "string",        "totalMinor": -9007199254740991,        "refundedMinor": -9007199254740991      }    }  ],  "series": [    {      "day": "string",      "currency": "string",      "orders": -9007199254740991,      "revenueMinor": -9007199254740991    }  ]}