LongJump Support Wiki

Difference between revisions of "API Calls Log"

From LongJump Support Wiki
imported>Aeric
imported>Aeric
 
(17 intermediate revisions by the same user not shown)
Line 1: Line 1:
'''Settings > Monitor > API Calls Log'''
'''Settings > Monitor > API Calls Log'''{{ #if: {{ShowIsvInfo}} |<br>'''Settings > Monitor > Global 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.  
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]]''
__TOC__
==API Calls Log ==
{{ #if: {{ShowIsvInfo}}
{{ #if: {{ShowIsvInfo}}
|Two types of logs are available:
|Two types of logs are available:
:;[[#API Call Log|API Call Log]]:Tracks the number and type of daily API Calls
:;[[#API Calls Log|API Calls Log]]:Tracks the number and type of daily API Calls
:;[[#Global API Call Log|Global API Call 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]]
}}
}}
==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
{{ #if: {{ShowIsvInfo}}
{{ #if: {{ShowIsvInfo}}
|==Global API Call Log==
| Both logs include these fields:
The Global API Call 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
:*Mobile
 
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==
==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.<br>So calls for a Customer in the European Time Zone could have a time that is shown as occurring the previous day, depending on when it was made. For example, London is 8 hours ahead of the Pacific Time Zone, so API calls are logged with a time 8 hours later. Calls made on March 13th, from 12:00 AM to 8:00 AM are logged with a date of March 12th. Calls from 8 AM to midnight are logged the same 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
:* When a [[Web Form]] submits a record to the platform, it 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.
==View an API Call Log==
::* 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}}
|#Click '''Settings > Monitor'''
|==View an API Call Log==
#Click '''Settings > Monitor'''
#Choose one of the following options:
#Choose one of the following options:
#*API Calls Log
#*API Calls Log
#*Global API Call Log
#*Global API Calls Log}}
|#Click '''Settings > Monitor > API Calls Log'''
<noinclude>
}}
 
<noinclude>[[Category:Monitor| 7]]</noinclude>
[[Category:Monitor| 7]]
[[Category:Glossary]]
[[Category:Glossary]]
</noinclude>

Latest revision as of 21:12, 12 April 2012

Settings > Monitor > API Calls Log
Settings > Monitor > Global 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

Two types of logs are available:

API Calls Log
Tracks the number and type of daily API Calls
Global API Calls Log
Available to ISVs, tracks the number and type daily API Calls for each Tenant managed by the ISV

Both logs include 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 (not included in the Global Calls Log.)

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 could have a time that is shown as occurring the previous day, depending on when it was made. For example, London is 8 hours ahead of the Pacific Time Zone, so API calls are logged with a time 8 hours later. Calls made on March 13th, from 12:00 AM to 8:00 AM are logged with a date of March 12th. Calls from 8 AM to midnight are logged the same 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)
  • When a Web Form submits a record to the platform, it 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.

View an API Call Log

  1. Click Settings > Monitor
  2. Choose one of the following options:
    • API Calls Log
    • Global API Calls Log
Retrieved from "https://agileappscloud.info/ljwiki-src/index.php?title=API_Calls_Log&oldid=7618"