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

Create Orcabase End User Account

post https://api.triplewhale.com/api/v2/orcabase/dev/register-account

Register a user account for access to the Orcabase API. This endpoint allows you to provide details about the user account, such as account ID, account name, timezone, and currency, to enable API access. It is an alternative to registering accounts manually through the Triple Whale Developer Portal.

Body Params

appId

string

required

Your app’s unique client ID token, provided during developer app registration as client_id. To retrieve it, visit Developer App > App Settings.

accountId

string

required

Your user's unique account ID. Must be globally unique (recommended to use unique ID from your existing systems). Note that when connecting to a sales platform (e.g. Shopify, WooCommerce, BigCommerce), the user's account ID must match their existing shop ID (e.g. example-user-shop.myshopify.com).

accountName

string

required

The name of the user's account.

timezone

string

required

The IANA Time Zone Database identifier for the user's timezone.

currency

string

required

The ISO 4217 code representing the currency for the user's account.

Responses

Response body

object

success

boolean

Indicates whether the account registration was successful.

message

string

A success message confirming account registration.

Response body

object

success

boolean

Indicates whether the account registration was successful.

message

string

An error message describing why the request failed, including the names of missing or malformed parameters or duplication issues.

Response body

object

success

boolean

Indicates whether the account registration was successful.

message

string

An error message describing why the request was forbidden.

Response body

object

success

boolean

Indicates whether the account registration was successful.

message

string

An error message describing the internal server error.

Updated about 13 hours ago

Adding User Accounts

Managing User Accounts

Did this page help you?

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.triplewhale.com/api/v2/orcabase/dev/register-account \
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 about 13 hours ago

Adding User Accounts

Managing User Accounts

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

200The user account was successfully registered for access to the Orcabase API.

400Invalid request due to missing or malformed parameters, or because the account already exists.

403Forbidden. The user does not have permission to register accounts for the provided app.

500Internal server error. An unexpected issue occurred while processing the request.