Analytics

📊 View store performance, revenue, and visitor statistics.

Get Store Analytics

get

Retrieve dashboard analytics including revenue, order counts, and visitor stats.

Authorizations

ApiKeyAuth & StoreHashAuth

x-api-keystringRequired

Your PapelShip API Key

x-store-hashstringRequired

Your Store Hash ID

Query parameters

fromstring · dateOptional

Start date (YYYY-MM-DD)

tostring · dateOptional

End date (YYYY-MM-DD)

Responses

200

Successful response

application/json

get

/analytics

HTTPcURLJavaScriptPython

GET /api_user/api/v1/analytics HTTP/1.1
Host: papelship.com
x-api-key: YOUR_API_KEY
x-store-hash: YOUR_API_KEY
Accept: */*

200

Successful response

{
  "success": true,
  "analytics": {
    "revenue": {
      "cents": 1,
      "currency": "text"
    },
    "orders": {
      "total": 1,
      "completed": 1
    },
    "customers": {
      "total": 1
    },
    "period": {
      "from": "text",
      "to": "text"
    }
  }
}