> ## Documentation Index > Fetch the complete documentation index at: https://docs.shoply.gg/llms.txt > Use this file to discover all available pages before exploring further. # Get the live view > What is happening on the store now: who is on it and where, the checkouts and orders of the last ten minutes, and the day's running totals. Needs the `analytics.read` permission (Read Analytics). ## OpenAPI ````yaml /api-reference/openapi.json get /stores/{storeId}/analytics/live openapi: 3.1.0 info: title: Shoply API version: '1' description: >- Everything a store's own server can do with a secret API key: its catalogue, orders, customers, marketing, finance and the rest of what the dashboard does. And the Customer API, which a buyer's own device asks with a token of theirs. servers: - url: https://api.shoply.gg/v1 security: - apiKey: [] tags: - name: API key - name: Store - name: Domain - name: Payment methods - name: Analytics - name: Storefronts - name: Storefront code - name: Payment Routing - name: Custom payment methods - name: Products - name: Product pictures - name: Stock - name: Categories - name: Upsells - name: Subscriptions - name: Orders - name: Invoices - name: Reviews - name: Coupons - name: Coupon categories - name: Coupon pop-up - name: Sales - name: Blog - name: Search settings - name: Redirects - name: Sitemap - name: Cart Recovery - name: Email Marketing - name: Email Templates - name: Customers - name: Affiliates - name: Support Tickets - name: Blacklist - name: Fraud protection - name: Disputes - name: Finance - name: Tax - name: Expenses - name: Expense setup - name: API requests - name: Webhook endpoints - name: Webhook deliveries - name: Customer API paths: /stores/{storeId}/analytics/live: get: tags: - Analytics summary: Get the live view description: >- What is happening on the store now: who is on it and where, the checkouts and orders of the last ten minutes, and the day's running totals. Needs the `analytics.read` permission (Read Analytics). operationId: analytics.live parameters: - name: storeId in: path required: true description: >- The store's ID. A key reaches the store it was made in: `GET /key` answers which. schema: type: string - name: tz in: query required: false description: The time zone "today" is in, as an IANA name. Left out, UTC. schema: type: string responses: '200': description: It worked. content: application/json: schema: type: object properties: success: type: boolean message: nullable: true code: nullable: true data: type: object properties: windowMinutes: type: integer currencyCode: type: string home: type: object properties: countryCode: type: string country: type: string latitude: type: number longitude: type: number now: type: object properties: visitors: type: integer carted: type: integer checkingOut: type: integer purchased: type: integer today: type: object properties: sessions: type: integer views: type: integer orders: type: integer revenue: type: number from: type: string timezone: type: string visitors: type: - array - object orders: type: - array - object topPages: type: - array - object topLocations: type: - array - object example: success: true message: null code: null data: windowMinutes: 10 currencyCode: USD home: countryCode: DE country: Germany latitude: 51.13 longitude: 10.29 now: visitors: 0 carted: 0 checkingOut: 0 purchased: 0 today: sessions: 0 views: 0 orders: 3 revenue: 29.98 from: '2026-10-22' timezone: UTC visitors: [] orders: [] topPages: [] topLocations: [] '401': $ref: '#/components/responses/NoKey' '403': $ref: '#/components/responses/NotAllowed' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooMany' x-codeSamples: - lang: javascript label: Node.js source: | import Shoply from "@shoplygg/node"; const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY }); const result = await shoply.analytics.live(); - lang: php label: PHP source: | getenv('SHOPLY_API_KEY')]); $result = $shoply->analytics->live(); - lang: python label: Python source: | import shoply client = shoply.Client() # reads SHOPLY_API_KEY result = client.analytics.live() components: responses: NoKey: description: >- No API key was sent, or the one sent is not a live key: `api_key_required`, `invalid_api_key`. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotAllowed: description: >- The key is real and may not do this: `missing_scope` (with `requiredScope`), `ip_not_allowed`, `account_unavailable`, or `dashboard_only` for something only a person in the dashboard may do. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotFound: description: >- There is no such thing in this store: `not_found`. A store that is not the key's own is answered the same way. content: application/json: schema: $ref: '#/components/schemas/Refusal' TooMany: description: >- The key has used up its budget for now: `rate_limited`. `Retry-After` says how many seconds to wait. content: application/json: schema: $ref: '#/components/schemas/Refusal' schemas: Refusal: type: object properties: success: type: boolean example: false message: type: string description: What is wrong, in words for a person. code: type: string description: What is wrong, as a word that does not change. data: nullable: true errors: type: object description: >- For `validation_failed`: what is wrong with each field, by the field's name. additionalProperties: type: string required: - success - message - code securitySchemes: apiKey: type: http scheme: bearer description: >- A secret API key, made under Developers in the dashboard: `Authorization: Bearer shoply_sk_...` ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.