Sending Data: Key Results API
Sync your guest experience data with your CRM or BI platform, via the HGEM key results API.
The API approach enables us to connect your CRM or BI platform with our API, allowing you to call the API to extract the required data to be stored in the relevant database.
What are the benefits?
Information where you need it
Where a guest has consented to receive marketing communications you can import their personal details directly into your CRM system ready to be used in your next campaign.
Integrated communications
Create a more detailed picture of your guests preferences and behaviours by feeding their feedback data (Guest ID , visit date/time, ‘recommend rating’ and any related comments) back into your CRM system. This data can then be used to inform your next campaign (eg, sending targeted marketing only to those guests who scored positively on the ‘recommend’ question).
Integrated analytics
Where appropriate, we can export your guest experience data to be integrated with data from other sources in your own BI systems.
Available information
- VisitID (unique, numerical, 7-8 digits)
- VisitDateTime (i.e. the date the guest visited)
- Client (client name)
- Brand (brand name, where relevant)
- BranchCode (the code you use to identify each restaurant)
- BranchName (the restaurant name)
- VisitType (type of feedback or social reviews)
- VisitSource (where the feedback came from e.g. reservation).
- VisitScore (the overall score for the visit expressed out of 100)
- NPS/RecommendScore (out of 10)
- NPS/RecommendComment (left by the guest against the NPS/recommend question)
- Section (name and score)
- Question Subject (name, category, score, analysis tag and dish – where applicable)
- Question Answer Option
- GuestID (the ID passed to us from your CRM, if applicable)
- MarketingConsent (Yes/No)
- ReplyConsent (Yes/No)
If guest consented:
-First name, last name and email.
Getting started
To get started:
- Confirm a CRM or BI contact who will be calling the API, and we can share an API key which is authenticated to return your data.