TRtriplewhale
Data Out

Get Summary Page Data

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

post/summary-page/get-data

Request

  • Base URL
    https://api.triplewhale.com/api/v2
  • URL
    https://api.triplewhale.com/api/v2/summary-page/get-data
  • Auth
    API key in header x-api-key

Request body

shopDomainstring required

The unique identifier for the shop (e.g., example.myshopify.com). This is the shop-id value in your Triple Whale app URL (for example ?shop-id=example.myshopify.com).

todayHournumber required

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

Example request

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

Response

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

Changes

No recorded changes to this operation across all 2 revisions of this API.