Skip to content

Latest commit

 

History

History
202 lines (150 loc) · 5.3 KB

AutomationsApi.md

File metadata and controls

202 lines (150 loc) · 5.3 KB

IO.Swagger.Api.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

void GetDripDropStats (string dripId, string dripDropId)

Get Automation Email Stats

Get Automation Email Stats

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class GetDripDropStatsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: BBOAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AutomationsApi();
            var dripId = dripId_example;  // string | The id of the drip
            var dripDropId = dripDropId_example;  // string | The id of the drip drop

            try
            {
                // Get Automation Email Stats
                apiInstance.GetDripDropStats(dripId, dripDropId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AutomationsApi.GetDripDropStats: " + e.Message );
            }
        }
    }
}

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

void GetDripStats (string id)

Get Automation Stats

Get Automation Stats

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class GetDripStatsExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: BBOAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AutomationsApi();
            var id = id_example;  // string | The id of the automation

            try
            {
                // Get Automation Stats
                apiInstance.GetDripStats(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AutomationsApi.GetDripStats: " + e.Message );
            }
        }
    }
}

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

void GetSchedulingStatus (string id)

Get the number of pending scheduling calculations

Get the number of pending scheduling calculations

Example

using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class GetSchedulingStatusExample
    {
        public void main()
        {
            // Configure OAuth2 access token for authorization: BBOAuth2
            Configuration.Default.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AutomationsApi();
            var id = id_example;  // string | The id of the automation

            try
            {
                // Get the number of pending scheduling calculations
                apiInstance.GetSchedulingStatus(id);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AutomationsApi.GetSchedulingStatus: " + e.Message );
            }
        }
    }
}

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]