Role Restrictions for Reporting API

This article provides details on the role restrictions available for the Reporting API.

Summary

From late December 2023, when creating a User to provide access via API, it is possible to restrict access to particular reports or groups of reports.

This is possible by enabling the configuration listed below.

• Configuration | System | Enforce Roles on Reporting API

Please check with your Redcat contact to ensure that you have the Polygon Central deployment that supports this functionality.  They may also need to have the configuration setting applied as these are not usually exposed to Admin Users.

Reporting Roles

When Enforce Roles on Reporting API is enabled, the following roles become available.

All Reports

To provide access to all reports, assign this role.

• Access to Reports

Report Groups

These roles will provide access to all the reports within a selected reporting group.

• Access to Data Reports
• Access to Loyalty Reports
• Access to KPI Reports
• Access to Free KPI Reports
• Access to Ordering Reports

Individual Report Roles
Data Reports

• Access to Data Report - COFA
• Access to Data Report - PLU Categories
• Access to Data Report - Locations
• Access to Data Report - PLU Classes
• Access to Data Report - PLUs
• Access to Data Report - Departments
• Access to Data Report - Work Types
• Access to Data Report - Payroll Rate
• Access to Data Report - POS Areas
• Access to Data Report - Brands
• Access to Data Report - Global POS Areas
• Access to Data Report - Employees
• Access to Data Report - Coupons
• Access to Data Report - Groups
• Access to Data Report - SMS Delivery Receipt
• Access to Data Report - POS Users
• Access to Data Report - Global POS Users
• Access to Data Report - Auditing
• Access to Data Report - Sale Types
• Access to Data Report - Ordering Providers
• Access to Data Report - Web Input Types

Individual Report Roles
KPI Reports

• Access to KPI Report - Summary Free
• Access to KPI Report - Summary
• Access to KPI Report - Exceptions Free
• Access to KPI Report Exceptions
• Access to KPI Report Accounts Free
• Access to KPI Report Accounts
• Access to KPI Report Sales Free
• Access to KPI Report Sales
• Access to KPI Report Sales By Free
• Access to KPI Report Sales By Web Sale Type
• Access to KPI Report Sales By
• Access to KPI Report Stocks
• Access to KPI Report Prodmon Log
• Access to KPI Report Payroll
• Access to KPI Report SYS Log
• Access to KPI Report Sales Media
• Access to KPI Report IPD Log
• Access to KPI Report Stock Map
• Access to KPI Report Stock Txns
• Access to KPI Report Stock Levels
• Access to KPI Report Smart Report KPIs
• Access to KPI Report Location Sales

Individual Report Roles
Loyalty Reports

• Access to Loyalty Report - Member Details
• Access to Loyalty Report - Member Sales By
• Access to Loyalty Report - Member Sales
• Access to Loyalty Report - Member Reconciliation
• Access to Loyalty Report - Coupon Sales
• Access to Loyalty Report - Coupon Count
• Access to Loyalty Report - Coupon Sales Summary
• Access to Loyalty Report - Coupon Sales By
• Access to Loyalty Report - Coupon Hashes
• Access to Loyalty Report - Group Sales
• Access to Loyalty Report - Member Comments

Individual Report Roles
Ordering Reports

• Access to Ordering Report - Summary
• Access to Ordering Report - Breakdown
• Access to Ordering Report - Sales
• Access to Ordering Report - Sales By
• Access to Ordering Report - Upcoming Catering

Custom Reports

Access via API to Custom Reports will require the same user role that is required to view the report in Polygon Central.

Related Articles

You can learn more about Users and User Roles in Polygon Central in this article.