AutomationsApi.md

Swagger\Client\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

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: BBOAuth2
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\AutomationsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$dripId = "dripId_example"; // string | The id of the drip
$dripDropId = "dripDropId_example"; // string | The id of the drip drop

try {
    $apiInstance->getDripDropStats($dripId, $dripDropId);
} catch (Exception $e) {
    echo 'Exception when calling AutomationsApi->getDripDropStats: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

void (empty response body)

Authorization

BBOAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDripStats

getDripStats($id)

Get Automation Stats

Get Automation Stats

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: BBOAuth2
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\AutomationsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = "id_example"; // string | The id of the automation

try {
    $apiInstance->getDripStats($id);
} catch (Exception $e) {
    echo 'Exception when calling AutomationsApi->getDripStats: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	The id of the automation

Return type

void (empty response body)

Authorization

BBOAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSchedulingStatus

getSchedulingStatus($id)

Get the number of pending scheduling calculations

Get the number of pending scheduling calculations

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: BBOAuth2
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Swagger\Client\Api\AutomationsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = "id_example"; // string | The id of the automation

try {
    $apiInstance->getSchedulingStatus($id);
} catch (Exception $e) {
    echo 'Exception when calling AutomationsApi->getSchedulingStatus: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	The id of the automation

Return type

void (empty response body)

Authorization

BBOAuth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]