Skip to main content
GET
Retrieve location product analytics

Authorizations

x-api-key
string
header
required

Location/organization API key.

Path Parameters

location_id
string
required

Query Parameters

from
string<date-time>

Start of the analytics period. If both from and to are omitted, the period defaults to the last 30 days.

to
string<date-time>

End of the analytics period. If both from and to are omitted, the period defaults to now.

service_type
enum<string>

Restrict order-backed statistics to delivery or collection orders.

Available options:
delivery,
collection

Response

The location product analytics.

object
enum<string>
required
Available options:
location_product_analytics
location_id
string
required
Example:

"loc_r8v4n2c6tz"

period
object
required
summary
object
required
top_products
object[]
required
daily_top_product_sales
object[]
required

Daily quantities for the three best-selling menu items.