Skip to content

Latest commit

 

History

History
167 lines (111 loc) · 3.99 KB

AutomationsApi.md

File metadata and controls

167 lines (111 loc) · 3.99 KB
Raw

Bombbomb.AutomationsApi

All URIs are relative to https://api.bombbomb.com/v2

Method HTTP request Description
getDripDropStats GET /automation/{dripId}/dripdrop/{dripDropId}/stats Get Automation Email Stats
getDripStats GET /automation/{id}/stats Get Automation Stats
getSchedulingStatus GET /automation/{id}/scheduling/status Get the number of pending scheduling calculations

getDripDropStats

getDripDropStats(dripId, dripDropId)

Get Automation Email Stats

Get Automation Email Stats

Example

var Bombbomb = require('bombbomb');
var defaultClient = Bombbomb.ApiClient.instance;

// Configure OAuth2 access token for authorization: BBOAuth2
var BBOAuth2 = defaultClient.authentications['BBOAuth2'];
BBOAuth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new Bombbomb.AutomationsApi();

var dripId = "dripId_example"; // String | The id of the drip

var dripDropId = "dripDropId_example"; // String | The id of the drip drop


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.getDripDropStats(dripId, dripDropId, callback);

Parameters

Name Type Description Notes
dripId String The id of the drip
dripDropId String The id of the drip drop

Return type

null (empty response body)

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

getDripStats

getDripStats(id)

Get Automation Stats

Get Automation Stats

Example

var Bombbomb = require('bombbomb');
var defaultClient = Bombbomb.ApiClient.instance;

// Configure OAuth2 access token for authorization: BBOAuth2
var BBOAuth2 = defaultClient.authentications['BBOAuth2'];
BBOAuth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new Bombbomb.AutomationsApi();

var id = "id_example"; // String | The id of the automation


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.getDripStats(id, callback);

Parameters

Name Type Description Notes
id String The id of the automation

Return type

null (empty response body)

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json

getSchedulingStatus

getSchedulingStatus(id)

Get the number of pending scheduling calculations

Get the number of pending scheduling calculations

Example

var Bombbomb = require('bombbomb');
var defaultClient = Bombbomb.ApiClient.instance;

// Configure OAuth2 access token for authorization: BBOAuth2
var BBOAuth2 = defaultClient.authentications['BBOAuth2'];
BBOAuth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new Bombbomb.AutomationsApi();

var id = "id_example"; // String | The id of the automation


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.getSchedulingStatus(id, callback);

Parameters

Name Type Description Notes
id String The id of the automation

Return type

null (empty response body)

Authorization

BBOAuth2

HTTP request headers

  • Content-Type: application/x-www-form-urlencoded
  • Accept: application/json