PLEASE NOTE: Platform reports are not available via the API.
Reports generated via the CharityTracker or Oasis Insight platforms are one of two classes.
On-Demand Report:
These reports are web-view based reports (list and table) and generated upon request by the server hosting the application. With the current system, longer-running reports will not generate and result in a time out error for exceeding the connection's time-to-live setting.
There is currently no mechanism to have a platform report served via the API or to construct API queries for reports you have previously requested via the application.
CSV Report:
CSV reports are large-scale reports for larger requests in the system, eg. a month's worth of Assistance records and the related Cases and Households.
These report files are not available via the API.
How can I get report data from the API then?
While you cannot send a single request to a data endpoint to mimic a report request, data used to generate reports is generally available via the various endpoints in the API. For example, Case reports, which usually handle Case records, Demographic details, and Assistance records have their respective data models available via the API.
We will be introducing tutorials on how to fetch data related to similar reports within the application in the future.
What about Form Reports?
Form Reports are much different and are custom development. For guidance on how to extract data from Form implementations, please contact [email protected]
Why do you have Custom Report Templates listed in the API documentation?
We do plan to expand what is offered in the future via the Reports endpoint, this is the only model that will carry over to our new developments.