Class: Api

Api()

Node.js Client Binding API; representation of a Api server. Call instance methods upon this object to communicate with particular Api server endpoints.

Constructor

new Api()

Copyright:
  • 2016-2024 Basis Technology Corporation.
License:
  • http://www.apache.org/licenses/LICENSE-2.0
Source:
Example
var api = new API(userKey, serviceUrl);

Members

parameters :object

The Analytics API endpoint parameters
Type:
  • object
Source:

protocol :object

The HTTP(S) object
Type:
  • object
Source:

userKey :string

The Analytics API key used for authentication
Type:
  • string
Source:

Methods

rosette(endpoint)

Accepts an Analytics API endpoint name and forwards user parameters to the endpoint
Parameters:
Name Type Description
endpoint string The Analytics API endpoint to be utilized
Source: