Difference between revisions of "API Call Log"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 11: Line 11:
:;[[#Global API Calls Log|Global API Calls Log]]:Available to [[ISV]]s, tracks the number and type daily API Calls for each [[Tenant]] managed by the [[ISV]]
:;[[#Global API Calls Log|Global API Calls Log]]:Available to [[ISV]]s, tracks the number and type daily API Calls for each [[Tenant]] managed by the [[ISV]]
}}
}}
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
{{ #if: {{ShowIsvInfo}}
{{ #if: {{ShowIsvInfo}}
|==Global API Calls Log==
| Both logs include these fields:
The Global API Calls Log includes these fields:
| The API Call Log includes these fields: }}
*Date Created
:*Date Created
*Customer ([[Tenant]])
:*Number of API Calls
*Number of API Calls
:*Add
*Add
:*Update
*Update
:*Delete
*Delete
:*Get
*Get
:*Search
*Search
Β 
Additional information:
Additional information:
*A log of the time (in ms) is also available for each call
:*A log of the time (in ms) is also included for each call
:*Average Add Response Time
::*Average Add Response Time
:*Average Delete Response Time
::*Average Delete Response Time
:*Average Get Response Time
::*Average Get Response Time
:*Average Response Time
::*Average Response Time
:*Average Search Response Time
::*Average Search Response Time
:*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 {{#if: {{ShowIsvInfo}}|(not included in the Global Calls Log.)}}
}}


==Considerations==
==Considerations==

Revision as of 18:09, 19 July 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.

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)