Dashboard data api


#1

Is there a way to get dashboard type information using the api like there is in the keypay front end?

Key stats from:
https://keypay.yourpayroll.com.au/Widget/KeyStats

The chart data in:
https://{whitelabel}.yourpayroll.com.au/Business/{businessId}/Business/PaySummary
I had a look at https://{whitelabel}.yourpayroll.com.au/api/v2/business/{businessid}/payrun but it did not include the $ per payrun or the ability to only retrieve recent payruns.

Is there a way to get this dashboard type data from the api?


#2

Hi,

Unfortunately we don’t have APIs to provide the data in the same shape as the KeyStats dashboard.

You can retrieve recent pay runs using OData filters. For example:

GET https://{whitelabel}.yourpayroll.com.au/api/v2/business/{businessid}/payrun?$orderby=Id+desc&$top=5

or

GET https://{whitelabel}.yourpayroll.com.au/api/v2/business/{businessid}/payrun?$orderby=PayPeriodEnding+desc&$top=5

You could then pull down the pay run total information for those five pay runs.

GET https://{whitelabel}.yourpayroll.com.au/api/v2/business/{businessid}/payrun/{payrunid}/totals

So in short, it’s possible but, unfortunately, not super quick to do so.

cheers
Paul.


#3

Thanks. We will load the pay runs, and will try get the keyStats from the GL intergration.