Difference between revisions of "API Calls Log"
From LongJump Support Wiki
imported>Aeric m (Text replace - 'Setup > ' to 'Settings > ') |
imported>Aeric |
||
| (20 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
'''Settings > Monitor > API Calls Log'''{{ #if: {{ShowIsvInfo}} |<br>'''Settings > Monitor > Global API Calls Log''' }} | |||
Two types of logs are available: | 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 | __TOC__ | ||
:;[[#Global API | ==API Calls Log == | ||
{{ #if: {{ShowIsvInfo}} | |||
|Two types of logs are available: | |||
:;[[#API Calls Log|API Calls Log]]:Tracks the number and type of daily API Calls | |||
:;[[#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]] | |||
}} | |||
{{ #if: {{ShowIsvInfo}} | |||
| Both logs include these fields: | |||
| The API Call Log includes these fields: }} | |||
:*Date Created | |||
:*Number of API Calls | |||
:*Add | |||
:*Update | |||
:*Delete | |||
:*Get | |||
:*Search | |||
:*Mobile | |||
Additional information: | Additional information: | ||
*A log of the time (in ms) is also included 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.)}} | ||
== | ==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.<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]] | ||
: | |||
: | |||
*API Calls are logged from | |||
*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) | ||
::* | :* When a [[Web Form]] submits a record to the platform, it counts as one ADD call. | ||
*API Calls | :* 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}} | |||
|==View an API Call Log== | |||
#Click '''Settings > Monitor''' | #Click '''Settings > Monitor''' | ||
#Choose one of the following options: | #Choose one of the following options: | ||
#*API | #*API Calls Log | ||
#*Global API | #*Global API Calls Log}} | ||
<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
- Click Settings > Monitor
- Choose one of the following options:
- API Calls Log
- Global API Calls Log