Attribution report for one question

Attributed revenue, orders, average order value and share per answer for a "How did you hear about us?" style question, bucketed by day, week or month (weeks start Monday), with the same figures for the previous window of equal length so change can be shown. Also returns a cross-tab of the answers against one traffic field recorded on the responses (groupBy): the Shopify last-click source by default, or sourceType, landingPage, referrerUrl and shopify_order_discount_codes from the order, or the fields the on-site embed reads off the arrival URL: utm_source, utm_medium, utm_campaign, utm_content, utm_term, utm_source_platform, utm_creative_format, utm_marketing_tactic, original-referrer, landing-page, campaign_name, adset_name, ad_name, placement, site_source_name, gad_source. Common spellings of a channel are folded into one row (raw lists what was merged); (none) is the bucket of responses without the field, which for source fields is the unattributed share. Revenue is the order total credited to each selected answer in the shop's presentment currency, so multi-select questions can exceed store revenue; aov divides by answers that carry an order value. Synthetic research responses are excluded. Defaults to a trailing 90-day window. presentations is how many customers the survey was shown to in the window and responseRate the question's responses over it. When the window can be projected honestly (projectionBlocker is null: views recorded, at least 30 responses, a answer rate of 5% or more, and no more answers than views), every byAnswer and bySource row carries projected (count and revenue lifted from those who answered to everyone surveyed, at the responders' proportions and AOV) and totals.projected sums them; otherwise projected is null and a note explains why.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The accountId or _id of the account object

string

The slideId or _id of the slide object

string

A JS timestamp. Returns records created on or after this time. For example: Date.now()

string

A JS timestamp. Returns records created on or before this time. For example: Date.now()

string
enum

Period size for byPeriod. One of day, week, month (default week).

Allowed:
string
enum

Response-metadata field to cross-tab answers against (default source).

string

Minutes offset from UTC for day bucketing.

Responses

403

API access requires the Premium plan or higher

422

slideId is required, or the date range is inverted

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