ComputeAnalytics1 - Bubblehouse API

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

Method	GET or POST
Kind	Read-Only
URL	`https://app.bubblehouse.com/api/v2023061/<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_daydaterequired
The first day to consider.
end_daydaterequired
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_countintegerrequired
The number of customers the online shop has by the end of the period.
member_deltaintegerrequired
The number of customers the online shop has gained during the period.
point_redeeming_customersintegerrequired
The number of customers that have redeemed points at least once by the end of the period.
point_redeemers_avg_purchase_countfloatrequired
Average purchase count for point redeemers (customers that have redeemed points at least once by the end of the period).
point_redeemers_avg_order_valuemonetaryrequired
Average order value for point redeemers (customers that have redeemed points at least once by the end of the period).
point_redeemers_avg_revenuemonetaryrequired
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_countfloatrequired
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_valuemonetaryrequired
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_revenuemonetaryrequired
Average revenue brought in by point non-redeemers (customers that have NOT redeemed points at least once by the end of the period).
votesintegerrequired
Number of votes recorded during the period.
voting_customersintegerrequired
Number of customers who voted during the period.
voting_pointsintegerrequired
Total number of points awarded for voting during the period.
referrals_sentintegerrequired
Total number of referrals sent during the period.
referrals_approvedintegerrequired
Total number of referrals approved during the period.

Specific Errors

Status	Error	Reason & Examples
None.

API-wide Errors

Status	Error	Reason & Examples
None.

Global Errors

Status	Error	Reason & Examples
401	invalid_token	The provided authentication token is invalid or has expired. `{"id":"invalid_token","message":"The token 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. `{"id":"rate_limit_exceeded","message":"You are over the read limit per second for this customer"}`
400	obsolete_global_api_version	The global API version you are trying to use is no longer supported. `{"id":"obsolete_global_api_version"}`
400	invalid_global_api_version	The global API version you are trying to use has never existed. `{"id":"invalid_global_api_version"}`
400	inaccessible_global_api_version	The global API version you are trying to use is not enabled on your account. `{"id":"inaccessible_global_api_version"}`