Accessing your data: Key Results API

Accessing your data: Key Results API

Use the HGEM Key Results API to pull your guest experience data into the systems you already use; for example, a CRM, BI platform, data lake, or partner platform.

Your systems call the API to retrieve the data you need and store it where you require.

What are the benefits?

  • Data where you need it
    Access visit and feedback results in the systems your teams already work in.
  • Richer guest and visit context
    Bring visit scores, recommend ratings, and related comments into your own tools so teams can track performance, support guests, or inform marketing.
  • Combine with your other data
    Use the API to feed guest experience data into your partner platform alongside data from other sources.

Standard and Plus access

Access to the visits endpoint is provided at one of two levels:

  • Standard: visit, site, score, and feedback detail (sections and questions).
  • Plus: everything in Standard, plus guest contact details and consent flags where the guest has consented, and the data was captured.

We can help to confirm which level applies for your account.

Available information

Here is a friendly overview of what can be returned. Full field definitions are in the technical data dictionary.

  • Visit ID
  • Visit date and time
  • Client name
  • Brand name (where relevant)
  • Branch code and branch name (your site identifiers)
  • Visit type and visit source
  • Overall visit score
  • Recommend / NPS score and comment
  • Section name and score
  • Question subject, category, score, analysis tag, and dish (where applicable)
  • Question answer

Guest contact (Plus, where consented)

  • Guest ID (where supplied to HGEM)
  • Marketing consent and reply consent
  • First name, last name, and email (only where consent allows)

Other endpoints

Depending on your setup, you may also want your access to include:

  • Branches: mappings between HGEM site identifiers and your own
  • Menus: menu and dish information

Getting started

  1. Review the API documentation for available endpoints and how to authenticate.
  2. Speak to your HGEM contact. We set up access and share the credentials your technical team (or partner) will use to call the API for your data.
  3. If your teams cannot support an API integration, a data export may be available; just ask your HGEM contact. The API is our preferred method.