Difference between revisions of "API Call Log"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
| Line 1: | Line 1: | ||
'''[[File:GearIcon.png]] > Administration > Monitoring > API Calls Log''' | '''[[File:GearIcon.png]] > Administration > Monitoring > API Calls Log'''<br> | ||
'''[[File:GearIcon.png]] > Administration > Monitoring > 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. | ||
__TOC__ | __TOC__ | ||
==API Calls Log == | ==API Calls Log == | ||
|Two types of logs are available: | |Two types of logs are available: | ||
:;[[#API Calls Log|API Calls 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 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]] | ||
| Both logs include these fields: | | Both logs include these fields: | ||
| The API Call Log includes these fields: }} | | The API Call Log includes these fields: }} | ||
| Line 29: | Line 28: | ||
::*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 (not included in the Global Calls Log.) | ||
==API Calls - Considerations== | ==API Calls - Considerations== | ||
| Line 43: | Line 42: | ||
::* A return of 0 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. | *Group Actions like Mass operations are not considered as API Calls. | ||
|==View an API Call Log== | |==View an API Call Log== | ||
#Choose one of the following options: | #Choose one of the following options: | ||
#*API Calls Log | #*API Calls Log | ||
#*Global API Calls Log | #*Global API Calls Log | ||
Revision as of 23:41, 7 April 2014
> Administration > Monitoring > API Calls Log
> Administration > Monitoring > 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: | 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 (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==
- Choose one of the following options:
- API Calls Log
- Global API Calls Log