Beta Test: Custom Reports API

OK, great. Please make sure the reports retrieved through API also contain the IDs (departments, teams...), otherwise the consistency collapses if for example team name is changed.

Hi @ammar - thanks for reaching out. The response will contain entity IDs as well to make sure such name changes don’t cause any issues. 

Hi.

I don’t quite understand the refresh policy of the reports. So I have a custom report which tracks all the changes (salary, department changes, team changes...). Will this report always have the most recent data, or will it get refreshed periodically (if so, how often)?

Hi @ammar 

The report always shows the most recent data - we refresh data in the report each time a change is tracked for an employee (given that the column/attribute is part of the report). The field data_refreshed_at should reflect that. 

Hope that helps. 

OK, nice. I was a bit confused, as in the front-end, there is a “refresh” button, I was never sure what it actually does.

2 more questions:

• Not sure about the paginations, The JSON result has a metadata block with , "current_page" and "total_pages", suggesting  pagination might kick in, but it doesn’t say when.

   

• And I'm not sure I understand why "data" is an array - suggesting there might be multiple data entities, but I don't understand in what scenario might it be the case.

Hi @ammar,

The refresh button in the UI is just a manual alternative to refresh data in the report, it should not be necessary to use regularly though. 

Not sure about the paginations, The JSON result has a metadata block with , "current_page" and "total_pages", suggesting  pagination might kick in, but it doesn’t say when.

Pagination is not yet implemented but will be in a later iteration. I’ll let you know once it is available to test. 

And I'm not sure I understand why "data" is an array - suggesting there might be multiple data entities, but I don't understand in what scenario might it be the case.

Depending on the endpoint, data entities or items are either a report (GetReports endpoint), a column (GetColumns endpoint) or an employee (GetReportData endpoint).

Hi Antonia, hi Personians,

First of all, big thank you to Personio team for releasing Custom Reports API. It's great to have this option.

Nevertheless, it seems like https://developer.personio.de/reference/listreportitems allows us to pass only one parameter (report id). 

For POINT IN TIME reports, what would give much more power to this, is adding another parameter for specifying date we want the data to be fetched for. This would make a huuuge difference (possibility to fetch data for a given date).

Should I submit this as new idea or is it enough to have it here?

Thank you,

Vida