API Reference

Create Post-Purchase Survey (PPS) Record

post
https://api.triplewhale.com/api/v2/data-in/pps

Ingest PPS data into Triple Whale. This endpoint allows users to upload detailed post-purchase survey information, including order-related data, questions, and responses.

Body Params
string
required

The exact Shop URL (e.g., 'example.myshopify.com'). Must match the Shop URL value shown in Settings → Store. The API key owner must also have access to the shop, otherwise the request will return 403.

string
Defaults to custom_pps_platform

The platform where the post-purchase survey originated.

string
Defaults to custom_platform_account

The account ID associated with the platform.

string
required

The unique identifier for the order associated with the PPS.

date-time

The time at which the post-purchase survey record was created. Must be provided in ISO 8601 format, with explicit timezone information (Z or +/-HH:mm offset). Offsets are supported (e.g., 2024-11-29T12:00:00+02:00). Defaults to the current time.

number

The total price of the order associated with the PPS. Must be non-negative.

string

Unique ID for the survey question. If omitted, the data will still be used for attribution (when include_in_attribution = true), but won’t appear in the PPS table, SQL, or Moby.

string

The text of the survey question. Maps to question in the Post-Purchase Survey table.

string

Unique ID for the survey response.

string

The customer’s response to the survey question. Maps to answer in the Post-Purchase Survey table.

boolean

Set to true to include this survey response in the Total Impact and Triple Attribution models. If omitted, Triple Whale will determine whether the question is attribution-related based on the question_text.

string

The marketing or referral channel that appears in Attribution. If omitted, Triple Whale infers the source from the response text. You may provide any string value, but using a Standardized PPS Source ID (e.g. facebook-ads) ensures offline events are grouped with existing channels rather than appearing as a separate custom source.

Responses

Updated 9 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 9 months ago