Olery Developer Portal logo Olery Developer Portal

Method Path
GET https://agora.olery.com/v3/companies/:id/gei

Returns the (average) Guest Experience Index (as times series)

You are limited to 1 request per second.

Output Format

The meta field contains general information about the property.

The aggregated data is returned as an Array of JSON objects in the data field. Each object has the following fields:

Field Data Types Description
gei Float Guest Experience Index value
date Date Start date of each time period, if per parameter is used

Parameters

Parameter Parameter Type Data Types Required Description
id path Integer true ID of the company
start_date query Date true Start date in ISO 8601 format
end_date query Date true End date in ISO 8601 format
per query String false Date grouping (day, month, quarter, year)

Grouping with the segment parameter is not possible for the GEI, because it is a wholistic value representing the experiences from all guests.

Example Call

https://agora.olery.com/v3/companies/38/gei?start_date=2018-01-01&end_date=2018-03-31&per=month&auth_token=XXX

Example Output

{  
   "meta":{  
      "company":{  
         "id":38,
         "name":"Hotel ABC"
      }
   },
   "data":[  
      {  
         "date":"2018-01-01",
         "gei":81.8382035145927
      },
      {  
         "date":"2018-02-01",
         "gei":82.837304103693
      },
      {  
         "date":"2018-03-01",
         "gei":83.5878121009877
      }
   ]
}

Response Statuses

Status Code Reason
200 OK
404 Company not found
403 No access, no authentication token
400 Missing or incorrect dates