Analytics Information

Get Gender

By using this API endpoint, it is possible to collect gender information that is collected by Wi-Fi splash page and social network. If date parameters aren't set, the API endpoint returns data from last week. If only one date parameter is set, the API endpoint returns again 1-week data.

Endpoint

GET /analytics/guest/genders

Rate Limit

This endpoint has a rate limit of 60 requests per minute.

Parameters

Name	Type	Required	Description
location_id	string	✔️	Location / venue ID
date_start	date		Returns entries started after the entered starting date (format: yyyy-mm-dd)
date_end	date		Returns entries ended before the entered ending date (format: yyyy-mm-dd)

Response

Tips

HTTP/1.1 200 OK

{
    "data": [
      {
          "Unknown": 1883,
          "Male": 2005,
          "Female": 1645
      }
   ]
}

Get Nationalities

By using this API endpoint, it is possible to get the list of guest nationalities. If date parameters aren't set, the API endpoint returns data from last week. If only one date parameter is set, the API endpoint returns again 1-week data.

Endpoint

GET /analytics/guest/nationalities

Rate Limit

This endpoint has a rate limit of 60 requests per minute.

Parameters

Name	Type	Required	Description
location_id	string	✔️	Location / venue ID
date_start	date		Returns entries started after the entered starting date (format: yyyy-mm-dd)
date_end	date		Returns entries ended before the entered ending date (format: yyyy-mm-dd)

Response

Tips

HTTP/1.1 200 OK

{
    "data": [
      {
          "German": 59,
          "British": 36,
          "Indonesian": 29,
          "Mexican": 20
      }
    ]
}

Get Total Traffic

By using this API endpoint, it is possible to get the list of total traffic. If date parameters aren't set, the API endpoint returns last week data. If only one date parameter is set, the API endpoint returns again 1-week data.

Notes

Numbers are calculated by using the data of both connected guests and anonymous visitors.

Endpoint

GET /analytics/visit/total-traffic

Rate Limit

This endpoint has a rate limit of 60 requests per minute.

Parameters

Name	Type	Description
location_id	string	Location / venue ID
date_start	date	Returns entries started after the entered starting date (format: yyyy-mm-dd)
date_end	date	Returns entries ended before the entered ending date (format: yyyy-mm-dd)

Response

Tips

HTTP/1.1 200 OK

{
    "data": [
      {
          "2020-01-01": {
              "passerby": 31847,
              "visit": 3523
          },
      
          "2020-01-02": {
              "passerby": 32329,
              "visit": 2850
          },
      
          "2020-01-03": {
              "passerby": 27367,
              "visit": 2789
          },
      
          "2020-01-04": {
              "passerby": 40558,
              "visit": 2238
          },
      
          "2020-01-05": {
              "passerby": 22869,
              "visit": 2416
          },
      
          "2020-01-06": {
              "passerby": 23064,
              "visit": 2469
          }
      }
    ]
}

Get Visit Frequencies

By using this API endpoint, it is possible to get the list of visit frequencies. If date parameters aren't set, the API endpoint returns last week data. If only one date parameter is set, the API endpoint returns again 1-week data.

Endpoint

GET /analytics/visit/frequencies

Rate Limit

This endpoint has a rate limit of 60 requests per minute.

Parameters

Name	Type	Description
location_id	string	Location / venue ID
date_start	date	Returns entries started after the entered starting date (format: yyyy-mm-dd)
date_end	date	Returns entries ended before the entered ending date (format: yyyy-mm-dd)

Response

Tips

HTTP/1.1 200 OK

{
    "data": [
      {
          "1 visit": 9563,
          "2 visits": 1008,
          "3-5 visits": 500,
          "6-10 visits": 9
      }
    ]
}

Get Top Location

By using this API endpoint, it is possible to get the list of visit top locations. If date parameters aren't set, the API endpoint returns last week data. If only one date parameter is set, the API endpoint returns again 1-week data.

Notes

Numbers are calculated using the data of the connected guests.

Endpoint

GET /analytics/visit/top-locations

Rate Limit

This endpoint has a rate limit of 60 requests per minute.

Parameters

Name	Type	Required	Description
location_id	string	✔️	Location / venue ID
date_start	date		Returns entries started after the entered starting date (format: yyyy-mm-dd)
date_end	date		Returns entries ended before the entered ending date (format: yyyy-mm-dd)

Response

Tips

HTTP/1.1 200 OK

{
    "data": [
      {
          "Main Lobby": {
              "Overall": 18739,
              "Female": 6524,
              "Male": 7535
          },
      
          "Gucci Zone": {
              "Overall": 3277,
              "Female": 1257,
              "Male": 1798
          },
      
          "Sephora": {
              "Overall": 3138,
              "Female": 2011,
              "Male": 1032
          },
      
          "Diesel": {
              "Overall": 2414,
              "Female": 970,
              "Male": 1352
          }
      }
    ]
}

Get Hourly Footfall

By using this API endpoint, it is possible to get hourly footfall.

Notes

Endpoint returns maximum 8 days of data. If the range is greater than 8 days, it will return data between start_date and start_date + 8 days.
Passerby's are not included.

Endpoint

GET /analytics/footfall

Rate Limit

This endpoint has a rate limit of 60 requests per minute.

Parameters

Name	Type	Required	Description
location_id	string		Location / venue ID
start_date	date	✔	Endpoint returns hourly footfall starting from this date (format: yyyy-mm-dd)
end_date	date		Endpoint returns hourly footfall until this date (format: yyyy-mm-dd)

Request

GET /analytics/footfall?start_date=2020-12-19&end_date=2020-12-21&location_id=XXXX

Response

Tips

HTTP/1.1 200 OK

{
  "data": {
    "2020-12-19": [
      59,
      50,
      52,
      44,
      42,
      44,
      47,
      48,
      51,
      57,
      58,
      75,
      77,
      87,
      101,
      111,
      105,
      87,
      85,
      73,
      72,
      73,
      70,
      69
    ],
    "2020-12-20": [
      67,
      62,
      52,
      49,
      43,
      45,
      55,
      71,
      83,
      96,
      105,
      119,
      122,
      140,
      136,
      151,
      159,
      126,
      96,
      90,
      87,
      82,
      75,
      75
    ]
  }
}