Skip to main content
GET
Retrieve organization location analytics

Authorizations

x-api-key
string
header
required

Location/organization API key.

Path Parameters

organization_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

Analytics broken down by location.

object
enum<string>
required
Available options:
organization_location_analytics
organization_id
string
required
Example:

"busorg_k3m9x2p7qw"

period
object
required
locations
object[]
required