Difference between revisions of "API Call Log"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 27: Line 27:
*Average time for each call and total weighted average for all the calls
*Average time for each call and total weighted average for all the calls


==Global API Call Log==
{{ #if: {{ShowIsvInfo}}
|==Global API Call Log==
The Global API Call Log includes these fields:
The Global API Call Log includes these fields:
*Date Created
*Date Created
Line 46: Line 47:
:*Average Update Response Time
:*Average Update Response Time
<!--*Average time for each call and total weighted average for all the calls-->
<!--*Average time for each call and total weighted average for all the calls-->
 
}}
==Considerations==
==Considerations==
*API Calls are logged from all platform elements: [[Classes]], [[Page]], [[Sites]], [[REST API]] <!--, [[SOAP Connect]]-->
*API Calls are logged from all platform elements: [[Classes]], [[Page]], [[Sites]], [[REST API]] <!--, [[SOAP Connect]]-->
Line 56: Line 57:


==View an API Call Log==
==View an API Call Log==
#Click '''Settings > Monitor'''
{{ #if: {{ShowIsvInfo}}
|#Click '''Settings > Monitor'''
#Choose one of the following options:
#Choose one of the following options:
#*API Call Log
#*API Calls Log
#*Global API Call Log
#*Global API Call Log
 
|#Click '''Settings > Monitor > API Calls Log'''
}}
<noinclude>[[Category:Monitor| 7]]</noinclude>
<noinclude>[[Category:Monitor| 7]]</noinclude>
[[Category:Glossary]]
[[Category:Glossary]]

Revision as of 23:37, 2 June 2011

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.

Learn more: Subscriber Billing Management

API Calls Log

The API Call Log includes these fields:

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

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


Considerations

  • API Calls are logged from all platform elements: Classes, Page, Sites, REST API
  • Calls are logged and reported daily
  • Each API Call (Add, Update, Delete, Get and Search) is logged
  • A log entry is made each call, regardless of status (success or failure)
  • For Search calls, a return of 0 records is also logged
  • API Calls are logged and available for review within 1 hour (60 minutes)

View an API Call Log

  1. Click Settings > Monitor > API Calls Log