API reference

Methods in this topic

• Methods for data reporting: api(), error(), sum(), avg(), reportBehavior(), and performance()
• Methods for SDK configuration modification: setConfig(), setPage(), and addBehavior()

api()

You can call the api() method to report the success rate of API calls on a page.

By default, the SDK listens to JavaScript and XML (AJAX) requests on the page and calls this method to report data. If data on the page is requested by using JSON with Padding (JSONP) or other custom tools such as the client SDK, you can call the api() method in the data request for manual reporting.

Syntax of api() :

__bl.api(api, success, time, code, msg)

Example of api():

var begin = Date.now(),
    url = '/data/getTodoList.json';

$.ajax({
    url: url,
    data: {id: 123456}
}).done(function (result) {
    var time = Date.now() - begin;
    // The call is successful. 
    window.__bl && __bl.api(url, true, time, result.code, result.msg);
}).fail(function (error) {
    var time = Date.now() - begin;
    // The call fails. 
    window.__bl && __bl.api(url, false, time, 'ERROR', error.message);
});            

[Back to the top]

error()

You can call the error() method to report JavaScript (JS) errors or exceptions you want to capture on a page.

Generally, the SDK listens to global errors on the page and calls this method to report exceptions. However, due to the same-origin policy of the browser, error details are usually out of reach. In this case, you must manually report such errors.

Syntax of error():

__bl.error(error, pos)

Example 1 of error(): Listen to and report JS errors on the page.

window.addEventListener('error', function (ex) {
    // Event parameters usually contain location information. 
    window.__bl && __bl.error(ex.error, ex);
});            

Example 2 of error(): Report a custom error.

window.__bl && __bl.error(new Error('A custom error occurs.'), {
    filename: 'app.js', 
    lineno: 10, 
    colno: 15
});            

[Back to the top]

sum()

Syntax of sum():

__bl.sum(key, value)

Example of sum():

__bl.sum('event-a');
__bl.sum('event-b', 3);

[Back to Top]

avg()

Syntax of avg():

__bl.avg(key, value)

Example of avg():

__bl.avg('event-a', 1);
__bl.avg('event-b', 3);

[Back to Top]

addBehavior()

You can call the addBehavior() method to add a custom user behavior to the end of the current behavior queue.

The SDK maintains a user behavior queue with a maximum of 100 records. You can call the addBehavior() method to add a custom user behavior to the end of the current behavior queue. When a JS error occurs, the method reports the current behavior queue and clears the queue.

Syntax of addBehavior():

__bl.addBehavior(behavior)

Example of addBehavior():

_bl.addBehavior({
  data:{name:'string',message:'sting'},
  page:'string'
})

[Back to Top]

reportBehavior()

You can call the reportBehavior() method to immediately report the current behavior queue.

If you do not manually call this method, when a JS error occurs, the current behavior queue is automatically reported. The maximum size of a queue is 100. If the queue contains more than 100 behavior records, behavior records are discarded from the header of the queue.

Syntax of reportBehavior():

__bl.reportBehavior()

The reportBehavior() method does not have request parameters.

[Back to Top]

performance()

After the onLoad method is called, the performance() method is called to report custom performance metrics other than the default performance metrics.

Usage of performance():

1. Set the autoSendPerf parameter to false to disable automatic reporting of performance metrics and wait for manual reporting.
2. Call the __bl.performance(Object) method to manually report custom performance metrics. In this process, the default performance metrics are automatically reported.

Example 1 of performance() (by using CDN):

window.onload = () => {
  setTimeout(()=>{
    __bl.performance({cfpt:100, ctti:200, t1:300, …});
  }, 1000); // Set a delay to ensure that the default performance data is collected. 
};

Example 2 of performance() (by using npm packages):

const BrowserLogger = require('alife-logger');
const __bl = BrowserLogger.singleton({pid:'Unique site ID'});
window.onload = () => {
  setTimeout(()=>{
    __bl.performance({cfpt:100, ctti:200, t1:300, …});
  }, 1000); // Set a delay to ensure that the default performance data is collected. 
};

[Back to Top]

setConfig()

You can call the setConfig() method to modify specific configuration items after the SDK initialization. For more information, see SDK reference.

Syntax of setConfig():

__bl.setConfig(next)

Example of setConfig(): Modify the value of the disableHook parameter to disable automatic API reporting.

__bl.setConfig({
    disableHook: true
});            

[Back to the top]

setPage()

You can call the setPage() method to reset the page name of a page. PV data is reported again by default. This method is typically used for single-page applications (SPAs). For more information, see Page data reporting of SPAs.

Syntax of setPage():

__bl.setPage(page, sendPv)

Example 1 of setPage(): Set the name of the current page to the current URL hash, and report PV data again.

__bl.setPage(location.hash);            

Example 2 of setPage(): Set the name of the current page to 'homepage' without triggering PV data reporting.

__bl.setPage('homepage', false);     

[Back to Top]

FAQ

Q: What do I do if I am not sure whether the SDK has been loaded when I call the __bl.performance() method?

A: For more information, see Page data reporting of SPAs.

[Back to Top]