PeopleXD Insight now supports a new report type called Web Services. A web service report works like a standard Insight report, but instead of viewing the results in the Portal, the report is set up as an API endpoint. When you call the endpoint, the report runs and returns your data as a JavaScript Object Notation (JSON) response.
This means you can expose PeopleXD data to other internal systems or external third parties without building an interface. The endpoint sits within the existing B2B API framework at api.corehr.com and uses the same authentication methods.
📌Note: Creating and managing Web Service reports requires the appropriate Web Services permissions in PeopleXD Portal. Contact your HR Systems team if you do not have access.
What you can use it for
Web Service reports are suited to situations where another system or team needs regular access to a defined set of XD data. Common use cases include:
Sharing employee, payroll, or workforce data with a third-party application.
Providing a data feed to an internal system without building a full interface.
Replacing a manual export process with an automated API call at regular intervals.
Giving an external vendor controlled access to a specific subset of PeopleXD data.
🤓 Tip: Web Service reports are not intended for high-volume or data warehouse-style feeds. For high-volume requirements, consider using the B2B APIs alongside Insight Web Services and interface files.
How it works
Creating and using a web service report involves four steps.
Create the report
An HR Systems user creates the Web Service report in the dedicated Web Services area of Insight. Build the report in the same way as a standard Insight report — adding columns, filters, and calculations — with some restrictions on complexity. See the limitations section below for details.
Add parameters (optional)
WS Params can be added to the report to allow the calling system to filter the data it retrieves at the point of calling — for example, by employee reference, date range, or pay group. This avoids the need for separate endpoints for each data subset.
Generate the endpoint
Once the report is tested and ready, the HR Systems user generates an API endpoint from the Web Services screen. The endpoint is immediately available to call. The Endpoint Details screen gives the calling system's developers everything they need:
The endpoint path.
The expected JSON response format.
Any parameters required.
Call the endpoint
The calling system authenticates using credentials from the PeopleXD-Access Evo-Insight Web App in the PeopleXD Security area, obtains a bearer token, and calls the endpoint. The report runs and returns the data as a JSON array.
Key limitations
Web Service reports have restrictions in place to protect the performance and integrity of the live PeopleXD environment. The main ones to be aware of are:
Report complexity: Each report is limited to 50 columns, three Business Intelligence (BI) views, and 10 calculations. Some Structured Query Language (SQL) aggregation functions are not permitted.
Row limits: When called via the API, a maximum of 250,000 rows can be returned. The Portal view is limited to 250 rows and is for testing purposes only.
Active endpoints: You can have a maximum of 20 active endpoints at any time. This means you can have a maximum of 20 active web service reports.
Call frequency: Endpoints have rate limits — for example, a maximum of 10 executions in any five-minute window.
Restricted views: A number of views aren't available for Web Service reports, including all audit and security views.
No scheduling: Web Service reports are called on demand by the consuming system. The calling system must manage scheduling, not PeopleXD.
⚠️ Important: An endpoint is automatically disabled after three consecutive failed executions. Monitor the Web Services History screen regularly to catch and resolve failures promptly.
Security
Web Service report security works differently depending on how the report is run.
When run via the PeopleXD Portal, the report uses the logged-in user's security. When called via the API, the report runs under a Back Office system user called CI User. Ensure the CI User’s security profile is up to date — if new workgroups or teams are added to the system, update CI User access to match.
📌 Note: If the data returned in the Portal differs from what the API returns, this is usually due to a difference between the logged-in user's security and the CI User's security profile.
What your IT team or vendor needs
Once the report is created and the endpoint generated, the calling team only needs:
The Web App credentials (Application ID and Secret) from the PeopleXD-Access Evo-Insight Web App.
The UAT and Production API endpoint paths.
The endpoint details, including the response format and any required parameters.
Go to the Endpoint Details screen in Insight and the Web Service Apps area in PeopleXD Security for this information.
📌 Note: For a full technical guide to creating Web Service reports, generating endpoints, and calling the API, refer to our user guides collection on the PeopleXD help centre.