v1

latestOpenAPI 3.1.02026-08-04170116.0 KB

Data Out

Get Summary Page Data

Retrieve data from the Summary Page for a specified time period.

post/summary-page/get-data

shopDomainstring required

The domain of the shop for which data is being requested (e.g., example.myshopify.com).

todayHournumber required

The hour of the current day for which data is requested, base-1 (range: 1–25).

{
  "shopDomain": "example.myshopify.com",
  "period": {
    "start": "2023-01-01",
    "end": "2023-01-07"
  },
  "todayHour": 1
}

A successful response containing Summary Page data for the specified shop and period.