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.

🚧
Send the Order Record First
Triple Whale maps each PPS response to an order using order_id. Send the order record before the PPS record. If the order does not exist yet, the PPS request can fail (for example with 404 Order Not Found) and the response will not map for attribution models such as Total Impact.

Body Params

shop

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.

platform

string

Defaults to custom_pps_platform

The platform where the post-purchase survey originated.

platform_account_id

string

Defaults to custom_platform_account

The account ID associated with the platform.

order_id

string

required

The unique identifier for the order associated with the PPS.

created_at

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.

total_price

number

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

question_id

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.

question_text

string

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

response_id

string

Unique ID for the survey response.

response

string

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

include_in_attribution

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.

source

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

Send the Order Record First

200PPS record successfully received.

400Bad Request

404Order Not Found

429Too Many Requests

500Internal Server Error