Get the revenue time series
const url = 'https://apibase.ecomweb.app/api/v1/stores/example/analytics/time-series?period=day';const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://apibase.ecomweb.app/api/v1/stores/example/analytics/time-series?period=day' \ --header 'x-api-key: <x-api-key>'Returns revenue, orders and customers per day, week, month or year, oldest first, for charting trends. Empty buckets are included with zeros. The period parameter sets both the bucket size and how far back the series goes.
Required scopes: read:analytics
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The store’s ref, as returned by GET /stores.
Query Parameters
Section titled “Query Parameters”Bucket size and window: day returns the last 30 days, week the last 12 weeks, month the last 12 months and year the last 5 years.
Responses
Section titled “Responses”object
Start of the bucket: YYYY-MM-DD for day, IYYY-IW (ISO year and week) for week, YYYY-MM for month and YYYY for year.
Revenue of the bucket, in the store currency.
Orders placed in the bucket.
Distinct customers who ordered in the bucket.
Example generated
[ { "date": "example", "revenue": 1, "orders": 1, "customers": 1 }]The request is malformed or failed validation.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key is missing, invalid, revoked or expired.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.
object
The HTTP status code.
What went wrong; validation failures list one message per problem.
The HTTP status text, such as Bad Request.
object
A stable, machine-readable error code.
A human-readable explanation.
Extra context about the error, when there is any.
object
When the error happened, as an ISO 8601 timestamp.
Example generated
{ "statusCode": 1, "message": [ "example" ], "error": "example"}