API Nation
You are using an unsupported browser. Please update your browser to the latest version on or before July 31, 2020.
close
Home > Common Questions > General > How are records measured in API Nation?
How are records measured in API Nation?
print icon

In API Nation, only the successful action of creating, reading, updating, or deleting a "record" is counted towards your record-based plan. This means that the number of records that trigger the workflow, or the number of records processed by each workflow step, are not counted until the workflow takes an action
 

What are workflows, triggers, and actions? 

  • A workflow is the automation of a process. For example, "When a new lead arrives, add or update the lead contact record to my CRM."
  • A trigger is the first application in a workflow, which either receives a new task, event, or new record to process. In the example above, the trigger is "When a new lead arrives."
  • The action happens when a workflow affects the record in an application. This could mean (Add, Update, Delete) or returning status (Success, Fail, etc.). In the example above the action is "add or update the lead contact record in my CRM."

 

What counts toward RECORDS usage?

Here are some additional examples 

 

  • RECORD is used when a workflow action CREATES a new contact, transaction, document, invoice, or row in a worksheet.
  • RECORD is used when a workflow action UPDATES a contact, transaction, document, invoice, or row in a worksheet.
  • RECORD is used when a workflow action DELETES a contact, transaction, document, invoice, or row in a worksheet.

 

Record Counting

A RECORD is the same or equivalent to one contact, transaction, document, invoice, or row in a worksheet.

 

 

What happens when I exceed the number of RECORDS included in my plan?

If you exceed the allotted number of records, the status of your workflow will change to "Over Limit." In this situation, you have two options:

 

  1. Upgrade Your Plan: You can upgrade your plan to increase the record transfer limit. Once the upgrade is complete, your workflow will resume, and the remaining records will continue to transfer until the process is complete or the new limit is reached. You can view our plans here.
  2. Maintain Your Current Plan: If you choose not to upgrade, your record count will reset to zero at the start of the next billing cycle, and your workflows will continue to transfer data until the process is complete or the limit is reached again.

 

 

What doesn't count toward RECORDS usage?

 

  • When a record is retrieved by the trigger, it is not counted.
    For example: 
    • Your workflow received some data to process, but because you added a filter to the workflow, no data was sent to the action application. In this case, no records were used by the workflow. 
    • Your workflow received some data; no filters are in place. However, the workflow did not find any updates to make. Therefore, it took no action. In this case, no records were used by the workflow. 
Feedback
0 out of 2 found this helpful

Need Additional Assistance?
Submit a ticket by clicking here and an API Nation Success Specialist will reach you with a solution
 
scroll to top icon