Returns orders heatmap

get

https://api.flipdish.co/reporting/v1.0/{appNameId}/order/heatmap

By passing in the appropriate query, you can receive filtered order overview

Path Params

appNameId

string | null

required

App Name Id

Query Params

GraphGranularity

string

enum

Defines granularity of the graph

DeliveryType

array of objects | null

Query delivery type/s

DeliveryType

Platform

array of objects | null

Query platform/s

Platform

StoreId

array of int32s | null

Query store/s

StoreId

MainPeriod.Period

string

enum

The period type, for custom period Start and End must be specified

MainPeriod.Start

date-time | null

Start Time of the period

MainPeriod.End

date-time | null

End time of the period

ComparePeriod.Period

string

enum

The period type, for custom period Start and End must be specified

Allowed:

ComparePeriod.Start

date-time | null

Start Time of the period

ComparePeriod.End

date-time | null

End time of the period

VoucherCodes

array of strings | null

Query voucher code/s

VoucherCodes

PaymentType

array of strings | null

Query payment type/s

PaymentType

DeliveryZones

array of int32s | null

Delivery Zones filter

DeliveryZones

CurrencyFilter

string | null

Currency filter (ISO 4217:2015)

UserTimezone

string | null

User TImezone (IANA)

Precision

string

enum

The finer the precision the more data is returned

TopLeft.Lat

double

Latitude

TopLeft.Lon

double

Longitude

BottomRight.Lat

double

Latitude

BottomRight.Lon

double

Longitude

Responses

400

Incorrect input

500

An irrecoverable error occured

Language

Credentials

OAuth2

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Results matching the criteria