6 API Performance

The API Performance page shows the following information for the Crunchtime! API, Business Intelligence API, Simphony Configuration and Content API, and Simphony Transaction Services Gen2 API:

• Requests

• Average Response Time

• Maximum Response Time

• Errors:

  • Authorization (for example, when a token is not renewed)

  • Internal (for example, when Simphony or Reporting and Analytics processes are disrupted)

  • Validation (for example, when a request has a field with an incorrect value type or the JSON is malformed)

The page shows graphs of API activity captured at 5-minute intervals. Telemetry retains API activity for 28 days. When each alerting threshold is met, an email is sent to subscribers based on the alert type (Warning or Critical).

Crunchtime! API

CrunchTime! software helps restaurants manage their inventory, labor, and food costs. It lets users track their sales, purchases, and inventory levels in real-time, helping them make informed decisions about ordering supplies, scheduling staff, and creating menus. Simphony uses these features through the Crunchtime! API.

Alerting thresholds for Crunctime! API:

• Average Response Time (milliseconds):

  • Longer than 10,000 is a warning alert

  • Longer than 30,000 is a critical alert

• Maximum Response Time (minutes)

  • Longer than 5 is a warning alert

  • Longer than 10 is a critical alert

• Error Count

  • More than 100 is a warning alert

  • More than 300 is a critical alert

Business Intelligence API

The Business Intelligence API lets users query the Reporting and Analytics database on demand for transactional, operational, and kitchen data.

Alerting thresholds for BI API:

• Average Response Time (milliseconds)

  • Longer than 30,000 is a warning alert

  • Longer than 120,000 is a critical alert

• Maximum Response Time (minutes)

  • Longer than 5 is a warning alert

  • Longer than 10 is a critical alert

• Error Count

  • Authorization

    • More than 2,500 is a warning alert

    • More than 7,500 is a critical alert

  • Internal

    • More than 100 is a warning alert

    • More than 300 is a critical alert

  • Validation

    • More than 5,000 is a warning alert

    • More than 10,000 is a critical alert

Simphony Configuration and Content API

The Configuration and Content API provides a standardized way to create, read, update, and delete Simphony EMC configuration elements.

Alerting thresholds for C&C API:

• Average Response Time (seconds):

  • Longer than 30 is a warning alert

  • Longer than 50 is a critical alert

• Maximum Response Time (seconds):

  • Longer than 30 is a warning alert

  • Longer than 50 is a critical alert

• Error Count:

  • Authorization

    • More than 50 is a warning alert

    • More than 300 is a critical alert

  • Internal

    • More than 100 is a warning alert

    • More than 300 is a critical alert

  • Validation

    • More than 300 is a warning alert

    • More than 1000 is a critical alert

Simphony Transaction Services Gen2 API

Simphony Transaction Services Gen2 (STSG2) is used to integrate third-party applications with the Simphony Point-Of-Sale (POS) system. The metrics for this API are separated into Cloud Services (services that function in the Oracle Cloud) and Check Services (services that are dependent Oracle-Micros Workstations).

Alerting thresholds for STSG2 Cloud Services:

• Average Response Time (milliseconds):

  • Longer than 5000 is a warning alert

  • Longer than 10000 is a critical alert

• Error Count

  • More than 500 is a warning alert

  • More than 1000 is a critical alert

Alerting thresholds for STSG2 Check Services:

• Average Response Time (milliseconds):

  • Longer than 10000 is a warning alert

  • Longer than 20000 is a critical alert

• Error Count

  • More than 500 is a warning alert

  • More than 1000 is a critical alert