PS: ProfitSword DataPortal API Guidelines

This document is intended to provide ProfitSword customers with best practices information when using the DataPortal API.  

API Calls:  

We recommend that you only make one request at a time. If you are using software that allows you to submit API requests in bulk, we recommend that you limit those requests to 50 calls at one time. By minimizing the number of calls in a single instance, this will improve your processing time, while still allowing you to efficiently execute your requests.  

Parameter Recommendations:  

For calls that you pass a beginning and end date/period, we recommend that you limit this time period to a 6-month window initially, please consult with the Actabl Technical Services team about longer date ranges. This smaller window still allows you to submit large chunks of data, while also enabling you to pass that data in almost an instantaneous manner.  

Time of Day Recommendations:  

When attempting to do heavy data pulls from the DataPortal API, we recommend that you run those data pulls either prior to 5:00am EST or after 12:00pm EST. These recommendations are based on the fact that between the hours of 5:00am-12:00pm EST, our servers are scheduled to automatically process large volumes of import data from our data sources. As a result, there is a higher probability that you might experience data submission/pulling slowness during that busy window.  

What to do if API queries are failing: 

Limitation: Industry standard firewall window of 100 seconds to complete the query. 

• Problem: Large Data calls. Larger COA’s take longer to run. Large property counts take longer to run.
• Possible Solutions: 
  • Limit the pull to the previous 7 days 
  • Do a sync once a week for 30 days + 
  • Limit to 3 months at a time for all 
  • Split properties into smaller site groups to create smaller multiple queries 
  • Request an export to be sent for longer queries to avoid the timeout. Actabl Technical Services can set one up for you through a request via a ticket in the Support Portal.