Organization API: Organizations & Members: Acquisition

Part of Organizations & Members.

GET /api/v1/orgs/{org_slug}/acquisition

Where the organization's visits, sign-ups, orders and revenue came from, over a period and against the one before it. Needs the Owner or Admin role.

The period is from to to in the brand's time zone, the last 30 days when left out, and at most 366 days. Every list holds at most limit rows, ranked by orders, then revenue, then visits. The totals always cover every row.

An order is a paid storefront order that is not free, counted in currency. Orders and revenue never mix currencies: currencies names every currency with an order in the period, and currency picks the one the answer is in. Revenue is the invoice total without tax, in that currency's minor units. A sign-up is a customer made through the storefront, so a customer the staff create is not one. A visit is a stored session with bots left out. Sessions are kept for 180 days, so visits_complete is false when the period starts earlier and the visit figures are partial.

The answer holds:

• totals: visits, signups, orders, new_customers (orders from a customer's first paid order), revenue_minor and conversion_rate_bp (orders over visits). previous holds the same figures for the earlier period, or null when compare is none. Every figure ending in _bp is basis points, so 123 is 1.23 percent.
• channels: each channel of the last touch with its visits, signups, orders, new_customers, revenue_minor and share_bp (its share of the orders). first_touch ranks the channels of the first touch, and matrix counts orders by first channel and last channel.
• sources, campaigns, landing_pages and devices: the same figures by the last touch's source and medium, its campaign, the page it landed on (the path, with no query and no language prefix) and the device.
• click_ids: how many orders carry an ad click ID, and for which ad network.
• heard_about: the answers to "How did you first hear about us?" with their share of the answered orders.
• return: the ad spend return report for the period in currency (rows, totals, truncated), or null when the organization has no ad spend in the period. truncated is true when the return report read only its first 50,000 orders.

A from after to, a period over 366 days, a compare other than previous or none, a currency that is not three letters and a limit outside 1 to 50 answer 422.