AgileApps Support Wiki Pre Release

Difference between revisions of "API Call Log"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 32: Line 32:


==API Calls - Considerations==
==API Calls - Considerations==
*API Calls are logged from all platform elements: [[Classes]], [[Page]], [[Sites]], [[REST API]] <!--, [[SOAP Connect]]-->
*API Calls are reported daily
*Calls are logged and reported daily
*API Calls are logged and available for review within 1 hour (60 minutes)
*Calls are logged in the Pacific Time Zone. (So calls for a Customer in the European Time Zone have a time that occurs the following day.)
*API Calls are logged from platform elements: [[Classes]], [[Page]], [[Sites]], [[REST API]]  
*Each API Call (Add, Update, Delete, Get and Search) is logged
*Each API Call (Add, Update, Delete, Get and Search) is logged
:*A log entry is made each call, regardless of status (success or failure)
:* A log entry is made for each call, regardless of status (success or failure)
::*For Search calls, a return of 0 records is also logged
:* The [[WebForm]] API counts as one ADD call.
*API Calls are logged and available for review within 1 hour (60 minutes)
:* The count for the [[SearchRecords]] API depends on the number of records fetched.
 
::* Every 25 records counts as one search call.
::*  A return of 0 records counts as one search call.
*Group Actions like Mass operations are not considered as API Calls.
{{ #if: {{ShowIsvInfo}}
{{ #if: {{ShowIsvInfo}}
|==View an API Call Log==
|==View an API Call Log==

Revision as of 00:34, 8 March 2012

Settings > Monitor > API Calls Log

The API Calls Log tracks the number and type of API calls for each Tenant on a daily schedule. The API Call Log data is used to bill Tenants based on usage.

API Calls Log

The API Call Log includes these fields:

  • Date Created
  • Number of API Calls
  • Add
  • Update
  • Delete
  • Get
  • Search
  • Mobile

Additional information:

  • A log of the time (in ms) is also included for each call
  • Average Add Response Time
  • Average Delete Response Time
  • Average Get Response Time
  • Average Response Time
  • Average Search Response Time
  • Average Update Response Time
  • Average time for each call and total weighted average for all the calls

API Calls - Considerations

  • API Calls are reported daily
  • API Calls are logged and available for review within 1 hour (60 minutes)
  • Calls are logged in the Pacific Time Zone. (So calls for a Customer in the European Time Zone have a time that occurs the following day.)
  • API Calls are logged from platform elements: Classes, Page, Sites, REST API
  • Each API Call (Add, Update, Delete, Get and Search) is logged
  • A log entry is made for each call, regardless of status (success or failure)
  • The WebForm API counts as one ADD call.
  • The count for the SearchRecords API depends on the number of records fetched.
  • Every 25 records counts as one search call.
  • A return of 0 records counts as one search call.
  • Group Actions like Mass operations are not considered as API Calls.