Backupify for Salesforce API FAQ

Follow

Index

  1. API FAQ
  2. Calculating API calls needed for Backupify

 

1. API FAQ

What kinds of Salesforce APIs does Backupify use?

Since moving to our new Backupify for Salesforce platform, we use REST APIs to perform the daily backups.

 

What is the default API limit and how do I change it?

The default API limit for new accounts is 25,000 calls per day. You can change this at any time by navigating to Settings (the 'gear' icon) > Account Settings > Salesforce Settings. We don’t recommend setting this limit below 750, but you can set it to 0 to effectively pause backups if you desire.

When you change the maximum daily API limit the next backup to run (whether that is a scheduled daily backup or a manually forced backup) will respect the new API limit you set.

 

Is there a way to configure how many API calls are used for the daily backup?

Yes, you can configure an API limit in Backupify (either through Customer Support or in the Backupify application). The default API limit is 25,000. The next backup to run (whether that is a scheduled daily backup or a manually forced backup) will respect the new API limit you set.

 

Why does the amount of API calls needed to do my Salesforce backup change daily?

The number of API calls needed to back up your Salesforce data can vary day to day (i.e., from backup to backup). It could increase for the following reasons:

If there is a large amount of data turnover in a given day, across many objects. Due to the way our backups work (we check if an object has changed, and if it has we download the entire object), if you edit ALL your objects one day, then we effectively need to re-fetch all the objects when we run our backup.

If you add a bunch of new objects. For example, if you install a 3rd party integration that creates 20 new Salesforce objects, we will have to download these entirely during the next backup.

 

How do I know what to set my limit to?

This varies a lot, depending on how much data you have in your Salesforce account and how frequently and prolifically you are updating the data in your account. (Other third-party applications also use these APIs, so you may need to balance your Backupify access with those programs’ API loads.) Backupify recommends you use the default API limit to start and watch the activity log for any warning message about hitting your API limit. We don’t recommend lowering the limit below 750 API calls per day in general.

 

How do I purchase additional API calls?

You will need to get in touch with your Salesforce account representative in order to request additional API calls.

2. Calculating API calls needed for Backupify

We use API calls on both records and on files. For files, the math is pretty simple: it’s a 1 call to 1 file ratio.

For records, it’s a bit more complex. The basic ratio is 150 records per API call. So, an object with 150,000 records would need 1,000 API calls. However, this assumes that the Salesforce API is responsive. Salesforce can be non-responsive for a few reasons... the API can time out if there's too much data to back up. If the API does that, then we will back off and ask for fewer records, so, in this example scenario, we could now take up to 2,000 API calls. The API could respond again with a timeout, so we would back off again, and might use 4,000 API calls for that backup.

There’s also a case where the Salesforce records themselves are too long. If you think of a record like a row in a table, this is a row with lots of columns. If that’s the case, we have to break the rows up, asking for the first few columns in the first request, and the latter columns in the next request.

So, all in all, the best case for the number of API calls you need is the number of records divided by 150 plus any calls reserved for your files.

Please use the following steps to determine how many API calls that are in use/available. Please note that this calculation is meant to be used as a guide and is not precise.  

How To Find the Number of API Calls In Use/Available

1) In the dropdown under the username in the top right hand of the Salesforce interface select "Setup"

2) On the lefthand margin of the screen under "Administration Setup", expand "Data Management" and select "Storage Usage"

3) In the "Current Data Storage Usage" section, total up the "Record Count" column.

4) Divide that total by 1000 (It may be closer to the number if you divide by 2000, but 1000 will be more conservative).

5) Add that number to the total number of attachments found below in the "Current File Storage Usage" section.



In this case, the total from #3 (815,229) divided by 1000 (equaling ~815) plus the 2,659 attachments equal a total of 3,474 API calls needed.

 

How To Find the Number of API Calls In Use/Available

1) In the dropdown under the username in the top right hand of the Salesforce interface select "Setup"

2) On the lefthand margin of the screen under "System Overview" near the top of the page.

3) The "API Usage" box should be on the right and will have a summary of the API calls currently used with a % of the maximum number of calls allowed.

In this case, 22,671 out of 127,000 API calls are being used.


Was this article helpful?

0 out of 0 found this helpful

You must sign in before voting on this article.

Want to talk about it? Head on over to our Community Forum!