Triple Whale API

Introduction to the Triple Whale API
API Keys
- Creating and Managing Triple Whale API Keys
- Validate Your Triple Whale API Keyget
Data In (BETA)
Data Out
- Get Customer Journey Attribution Datapost
- Get Summary Page Datapost

Sync to Data Warehouse

Sync to Data Warehouse
BigQuery Setup and Configuration
Snowflake Setup and Configuration
AWS S3 Setup and Configuration
Google Cloud Storage Setup and Configuration
De-duplication for Data Warehouse Sync

Orcabase API

Introduction to the Orcabase API
Register Your Developer App
API Keys
- Creating and Managing Orcabase API Keys
Manage Users
Authenticate Users
- User Connection Flow
- Get User Sign-In Tokenpost
Manage Integrations
- Retrieve Orcabase Integration Statusespost
Query Data
- Execute Natural Language Query (Moby AI)post
- Execute Custom SQL Querypost

Triple Whale API

Introduction to the Triple Whale API
API Keys
- Creating and Managing Triple Whale API Keys
- Validate Your Triple Whale API Keyget
Data In (BETA)
Data Out
- Get Customer Journey Attribution Datapost
- Get Summary Page Datapost

Sync to Data Warehouse

Sync to Data Warehouse
BigQuery Setup and Configuration
Snowflake Setup and Configuration
AWS S3 Setup and Configuration
Google Cloud Storage Setup and Configuration
De-duplication for Data Warehouse Sync

Orcabase API

Introduction to the Orcabase API
Register Your Developer App
API Keys
- Creating and Managing Orcabase API Keys
Manage Users
Authenticate Users
- User Connection Flow
- Get User Sign-In Tokenpost
Manage Integrations
- Retrieve Orcabase Integration Statusespost
Query Data
- Execute Natural Language Query (Moby AI)post
- Execute Custom SQL Querypost

Get Summary Page Data

post https://api.triplewhale.com/api/v2/summary-page/get-data

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

Body Params

shopDomain

string

required

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

period

object

required

The time range for the requested data. Specify the start and end dates.

todayHour

number

required

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

Responses

Response body

object

metrics

array of objects

A list of key metrics and their values for the specified time period.

metrics

object

metricName

string

required

The name of the metric (e.g., revenue, orders).

value

number

required

The value of the metric for the requested time period.

Headers

object

RateLimit-Policy

string

The rate limit policy for this endpoint, given as {quota};w={window} where window is in seconds and quota is the allowed number of calls per window.

RateLimit

string

Information about the user's rate limit usage for this endpoint.

Response body

object

success

boolean

message

string

Headers

object

Retry-After

string

The number of seconds until the user can make another request.

Updated 5 days ago

Get Customer Journey Attribution Data

Sync to Data Warehouse

Did this page help you?

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.triplewhale.com/api/v2/summary-page/get-data \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

*/*

Updated 5 days ago

Get Customer Journey Attribution Data

Sync to Data Warehouse

Did this page help you?

Triple Whale API
Introduction to the Triple Whale API
API Keys
Validate Your Triple Whale API Keyget
Creating and Managing Triple Whale API Keys
Data In (BETA)
Enrich Orders Datapost
Create Post-Purchase Survey (PPS) Recordpost
Create Product Recordpost
Create Subscription Recordpost
Create Order Recordpost
Create Ad Recordpost
Upload Ads Data Using Google Sheets
Use Cases for Data-In Endpoints
Data Out
Get Summary Page Datapost
Get Customer Journey Attribution Datapost

Sync to Data Warehouse
Sync to Data Warehouse
BigQuery Setup and Configuration
Snowflake Setup and Configuration
AWS S3 Setup and Configuration
Google Cloud Storage Setup and Configuration
De-duplication for Data Warehouse Sync

Orcabase API
Introduction to the Orcabase API
Register Your Developer App
API Keys
Creating and Managing Orcabase API Keys
Manage Users
Delete Orcabase User Accountpost
Edit Orcabase User Account Detailspost
Managing User Accounts
Create Orcabase End User Accountpost
Adding User Accounts
Authenticate Users
Get User Sign-In Tokenpost
User Connection Flow
Manage Integrations
Retrieve Orcabase Integration Statusespost
Query Data
Execute Custom SQL Querypost
Execute Natural Language Query (Moby AI)post

Triple Whale API
Introduction to the Triple Whale API
API Keys
Validate Your Triple Whale API Keyget
Creating and Managing Triple Whale API Keys
Data In (BETA)
Enrich Orders Datapost
Create Post-Purchase Survey (PPS) Recordpost
Create Product Recordpost
Create Subscription Recordpost
Create Order Recordpost
Create Ad Recordpost
Upload Ads Data Using Google Sheets
Use Cases for Data-In Endpoints
Data Out
Get Summary Page Datapost
Get Customer Journey Attribution Datapost

Sync to Data Warehouse
Sync to Data Warehouse
BigQuery Setup and Configuration
Snowflake Setup and Configuration
AWS S3 Setup and Configuration
Google Cloud Storage Setup and Configuration
De-duplication for Data Warehouse Sync

Orcabase API
Introduction to the Orcabase API
Register Your Developer App
API Keys
Creating and Managing Orcabase API Keys
Manage Users
Delete Orcabase User Accountpost
Edit Orcabase User Account Detailspost
Managing User Accounts
Create Orcabase End User Accountpost
Adding User Accounts
Authenticate Users
Get User Sign-In Tokenpost
User Connection Flow
Manage Integrations
Retrieve Orcabase Integration Statusespost
Query Data
Execute Custom SQL Querypost
Execute Natural Language Query (Moby AI)post

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

400Bad Request

429Too Many Requests