Guides
  1. Getting Started
  2. CharityTracker and Oasis Insight API Documentation
  3. How-To Tutorials

API Limitations

Are there any rate limits?

Currently the API BETA enforces a rate limit of 3 requests per second and 100 records per request at maximum.

Requests default the pagination size to 10 records per request, but more may be requested by passing the following query parameter in your request: ?page_size=100

Can these rate limits be removed?

This limit is enforced systemically in order to prevent severe performance degradation to all networks by excessive requests. While we can adjust rate limits, we cannot remove them entirely.

In order to have your rate limits adjusted, you will need to contact [email protected] with the following information:

  • Your current use case and the access challenges you are facing
  • The API endpoints you are accessing
  • The requested increase of your rate quota

Our team will review your request and either increase your rate limit, or will discuss ways to optimize your queries for more efficient data returns.

Can I use the API for Data Visualization / Business Intelligence?

While the API can be used for pulling datasets into a data warehouse for visualization, you will want to be aware of your rate limits and the impact of large data set requests on your network.

Also, please be aware that the API is intended for programmatic access and is based on a REST API. It is not direct database access and you may need to configure your DV or BI client to view the datasets accordingly.

We recommend that if you wish to use the API to assist in Data Visualization / Business Intelligence projects that you first pull the data you need via an ETL solution where you can configure the structure of your data and access it as often as needed.

Please note that with the release of API Version 1.2, we have added several new tools to help you maintain data parity with external data warehouses! You can read more about these improvements here - https://help.simonsolutions.com/en/articles/15424032-api-beta-release-version-1-2

Can I set up webhooks / post-actions to be notified of API activity?

Unfortunately we don’t support post-action events or webhooks at this time. We do have a number of implementations we want to support in the future. If there is a use case that is critical to your application, please reach out to support and let us know about it!

Can I email a customer an ID card via the API?

We do not have this functionality tied to the API at this time but intend to support this in the future.

Can I have CharityTracker / Oasis Insight send data to a specific url?

We do not support this post-action at this time but intend to support this in the future.

Can I create barcode images via the API?

We do not allow this functionality via the API at this time. We are collecting information on specific use cases to determine the best approach to this, so if your implementation would benefit from the ability to create barcodes via the API, please reach out and let us know!

If you are interested in generating barcodes that align with the system barcodes used by CharityTracker and Oasis Insight, please reach out to API support for guidance on the Code-128 string template.