Analytics

Get business overview

Account-wide business pulse in one call: revenue, orders, leads, new customers, and live-site traffic over a date range, each compared against the immediately preceding period of equal length. Defaults to the last 7 days; the range cannot exceed 366 days. Use this as the starting point for any business review — drill into a specific site with GET /sites/{id}/analytics, and into records with the orders/customers list endpoints.

get/analytics

Request

  • Base URL: https://api.crevio.co/v1
  • URL: https://api.crevio.co/v1/analytics
  • Auth: API key in header Authorization

Query parameters

start_datestring date

Start of the date range (inclusive), as an ISO-8601 date (YYYY-MM-DD). Defaults to 7 days before end_date.

end_datestring date

End of the date range (inclusive), as an ISO-8601 date (YYYY-MM-DD). Defaults to today.

Response

Business overview for the requested period

object'business_overview' required
currencystring required

Lowercase ISO currency code all monetary amounts are expressed in (the account's display currency).

lifetime_revenueinteger required

All-time revenue in the account currency, in the smallest currency unit (cents for USD).

Changes

No recorded changes to this operation across all 2 revisions of this API.