Analytics API

Read Call

ComputeAnalytics1

Computes high-level shop analytics for the given date range.

Kind Read API call
Method GET or POST
URL https://app.bubblehouse.com/api/v20230601/<shop>/ComputeAnalytics1
Authentication Shop Token

Day boundaries are in the shop's time zone.

Note that this is a very expensive operation and might take a long time to complete. Please test and set a timeout accordingly. If you're going to be routinely calling this more than once a day in production, please talk to us first.

Input

  • start_day date required

    The first day to consider.

  • end_day date required

    The last day to consider. (This does not have to be a day that actually exists, as long as the range contains all the days you want included. E.g. you can use YYYY-MM-31 to refer to the last day of the month.)

Output

  • member_count integer required

    The number of customers the online shop has by the end of the period.

  • member_delta integer required

    The number of customers the online shop has gained during the period.

  • point_redeeming_customers integer required

    The number of customers that have redeemed points at least once by the end of the period.

  • point_redeemers_avg_purchase_count float required

    Average purchase count for point redeemers (customers that have redeemed points at least once by the end of the period).

  • point_redeemers_avg_order_value monetary required

    Average order value for point redeemers (customers that have redeemed points at least once by the end of the period).

  • point_redeemers_avg_revenue monetary required

    Average revenue brought in by point redeemers (customers that have redeemed points at least once by the end of the period).

  • point_nonredeemers_avg_purchase_count float required

    Average purchase count for point non-redeemers (customers that have NOT redeemed points at least once by the end of the period).

  • point_nonredeemers_avg_order_value monetary required

    Average order value for point non-redeemers (customers that have NOT redeemed points at least once by the end of the period).

  • point_nonredeemers_avg_revenue monetary required

    Average revenue brought in by point non-redeemers (customers that have NOT redeemed points at least once by the end of the period).

  • votes integer required

    Number of votes recorded during the period.

  • voting_customers integer required

    Number of customers who voted during the period.

  • voting_points integer required

    Total number of points awarded for voting during the period.

  • referrals_sent integer required

    Total number of referrals sent during the period.

  • referrals_approved integer required

    Total number of referrals approved during the period.

Global Errors

Status Error Reason & Examples
401 invalid_token

The provided authentication token is invalid or has expired.

429 rate_limit_exceeded

Your usage is over the rate limit. Ensure that you're not making duplicate calls, and contact our team for a rate limit increase.

Previous
Overview