Difference between revisions of "API Call Log"

From AgileApps Support Wiki
imported>Aeric
m (Text replace - 'Setup > ' to 'Settings > ')
 
imported>Aeric
Line 1: Line 1:
[[File:apicalllog.gif|right|thumb]]The API Call Log feature 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.  
'''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]]''
:''Learn more: [[Subscriber Billing Management]]''
 
{{ #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 Call Log|API Call 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 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]]
 
}}
==API Call Log ==
==API Calls Log ==
The API Call Log includes these fields:
The API Call Log includes these fields:
*Date Created
*Date Created

Revision as of 23:33, 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

Global API Call Log

The Global API Call Log includes these fields:

  • Date Created
  • Customer (Tenant)
  • Number of API Calls
  • Add
  • Update
  • Delete
  • Get
  • Search

Additional information:

  • A log of the time (in ms) is also available 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

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
  2. Choose one of the following options:
    • API Call Log
    • Global API Call Log