org.egoi.client.api.Api.AdvancedReportsApi

All URIs are relative to https://api.egoiapp.com

Method	HTTP request	Description
GenerateEmailBouncesReport	POST /reports/advanced/email-bounces	Generate email bounces report
GenerateEmailClicksByContactReport	POST /reports/advanced/email-clicks-by-contact	Generate email clicks by contact report
GenerateEmailClicksByUrlReport	POST /reports/advanced/email-clicks-by-url	Generate email clicks by URL report
GenerateEmailEventsReport	POST /reports/advanced/email-events	Generate email events report
GenerateEmailUnsubscriptionsReport	POST /reports/advanced/email-unsubscriptions	Generate email unsubscriptions report
GenerateFormAnswersReport	POST /reports/advanced/form-answers	Generate form answers report
GenerateSendsReport	POST /reports/advanced/sends	Generate sends report
GenerateSmsBouncesReport	POST /reports/advanced/sms-bounces	Generate SMS bounces report
GenerateSmsEventsReport	POST /reports/advanced/sms-events	Generate SMS events report
GenerateSubscriptionsReport	POST /reports/advanced/subscriptions	Generate subscriptions report
GenerateUnsubscriptionsReport	POST /reports/advanced/unsubscriptions	Generate unsubscriptions report
GetAllAdvancedReports	GET /reports/advanced	Get all advanced reports

GenerateEmailBouncesReport

AcceptedResponse GenerateEmailBouncesReport (GenerateEmailBouncesReport generateEmailBouncesReport)

Generate email bounces report

Generates a new email bounces report

Example

using System.Collections.Generic;
using System.Diagnostics;
using org.egoi.client.api.Api;
using org.egoi.client.api.Client;
using org.egoi.client.api.Model;

namespace Example
{
    public class GenerateEmailBouncesReportExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.egoiapp.com";
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Apikey", "Bearer");

            var apiInstance = new AdvancedReportsApi(Configuration.Default);
            var generateEmailBouncesReport = new GenerateEmailBouncesReport(); // GenerateEmailBouncesReport | Parameters for the email bounces report

            try
            {
                // Generate email bounces report
                AcceptedResponse result = apiInstance.GenerateEmailBouncesReport(generateEmailBouncesReport);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AdvancedReportsApi.GenerateEmailBouncesReport: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
generateEmailBouncesReport	GenerateEmailBouncesReport	Parameters for the email bounces report

Return type

AcceptedResponse

Authorization

Apikey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Accepted	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

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

GenerateEmailClicksByContactReport

AcceptedResponse GenerateEmailClicksByContactReport (GenerateEmailClicksByContactReport generateEmailClicksByContactReport)

Generate email clicks by contact report

Generates a new email clicks by contact report

Example

using System.Collections.Generic;
using System.Diagnostics;
using org.egoi.client.api.Api;
using org.egoi.client.api.Client;
using org.egoi.client.api.Model;

namespace Example
{
    public class GenerateEmailClicksByContactReportExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.egoiapp.com";
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Apikey", "Bearer");

            var apiInstance = new AdvancedReportsApi(Configuration.Default);
            var generateEmailClicksByContactReport = new GenerateEmailClicksByContactReport(); // GenerateEmailClicksByContactReport | Parameters for the email clicks by contact report

            try
            {
                // Generate email clicks by contact report
                AcceptedResponse result = apiInstance.GenerateEmailClicksByContactReport(generateEmailClicksByContactReport);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AdvancedReportsApi.GenerateEmailClicksByContactReport: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
generateEmailClicksByContactReport	GenerateEmailClicksByContactReport	Parameters for the email clicks by contact report

Return type

AcceptedResponse

Authorization

Apikey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Accepted	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
408	Request Timeout	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

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

GenerateEmailClicksByUrlReport

AcceptedResponse GenerateEmailClicksByUrlReport (GenerateEmailClicksByUrlReport generateEmailClicksByUrlReport)

Generate email clicks by URL report

Generates a new email clicks by URL report

Example

using System.Collections.Generic;
using System.Diagnostics;
using org.egoi.client.api.Api;
using org.egoi.client.api.Client;
using org.egoi.client.api.Model;

namespace Example
{
    public class GenerateEmailClicksByUrlReportExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.egoiapp.com";
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Apikey", "Bearer");

            var apiInstance = new AdvancedReportsApi(Configuration.Default);
            var generateEmailClicksByUrlReport = new GenerateEmailClicksByUrlReport(); // GenerateEmailClicksByUrlReport | Parameters for the email clicks by URL report

            try
            {
                // Generate email clicks by URL report
                AcceptedResponse result = apiInstance.GenerateEmailClicksByUrlReport(generateEmailClicksByUrlReport);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AdvancedReportsApi.GenerateEmailClicksByUrlReport: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
generateEmailClicksByUrlReport	GenerateEmailClicksByUrlReport	Parameters for the email clicks by URL report

Return type

AcceptedResponse

Authorization

Apikey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Accepted	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
408	Request Timeout	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

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

GenerateEmailEventsReport

AcceptedResponse GenerateEmailEventsReport (GenerateEmailEventsReport generateEmailEventsReport)

Generate email events report

Generates a new email events report

Example

using System.Collections.Generic;
using System.Diagnostics;
using org.egoi.client.api.Api;
using org.egoi.client.api.Client;
using org.egoi.client.api.Model;

namespace Example
{
    public class GenerateEmailEventsReportExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.egoiapp.com";
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Apikey", "Bearer");

            var apiInstance = new AdvancedReportsApi(Configuration.Default);
            var generateEmailEventsReport = new GenerateEmailEventsReport(); // GenerateEmailEventsReport | Parameters for the email events report

            try
            {
                // Generate email events report
                AcceptedResponse result = apiInstance.GenerateEmailEventsReport(generateEmailEventsReport);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AdvancedReportsApi.GenerateEmailEventsReport: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
generateEmailEventsReport	GenerateEmailEventsReport	Parameters for the email events report

Return type

AcceptedResponse

Authorization

Apikey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Accepted	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
408	Request Timeout	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

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

GenerateEmailUnsubscriptionsReport

AcceptedResponse GenerateEmailUnsubscriptionsReport (GenerateEmailUnsubscriptionsReport generateEmailUnsubscriptionsReport)

Generate email unsubscriptions report

Generates a new email unsubscriptions report

Example

using System.Collections.Generic;
using System.Diagnostics;
using org.egoi.client.api.Api;
using org.egoi.client.api.Client;
using org.egoi.client.api.Model;

namespace Example
{
    public class GenerateEmailUnsubscriptionsReportExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.egoiapp.com";
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Apikey", "Bearer");

            var apiInstance = new AdvancedReportsApi(Configuration.Default);
            var generateEmailUnsubscriptionsReport = new GenerateEmailUnsubscriptionsReport(); // GenerateEmailUnsubscriptionsReport | Parameters for the email unsubscriptions report

            try
            {
                // Generate email unsubscriptions report
                AcceptedResponse result = apiInstance.GenerateEmailUnsubscriptionsReport(generateEmailUnsubscriptionsReport);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AdvancedReportsApi.GenerateEmailUnsubscriptionsReport: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
generateEmailUnsubscriptionsReport	GenerateEmailUnsubscriptionsReport	Parameters for the email unsubscriptions report

Return type

AcceptedResponse

Authorization

Apikey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Accepted	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
408	Request Timeout	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

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

GenerateFormAnswersReport

AcceptedResponse GenerateFormAnswersReport (GenerateFormAnswersReport generateFormAnswersReport)

Generate form answers report

Generates a new form answers report

Example

using System.Collections.Generic;
using System.Diagnostics;
using org.egoi.client.api.Api;
using org.egoi.client.api.Client;
using org.egoi.client.api.Model;

namespace Example
{
    public class GenerateFormAnswersReportExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.egoiapp.com";
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Apikey", "Bearer");

            var apiInstance = new AdvancedReportsApi(Configuration.Default);
            var generateFormAnswersReport = new GenerateFormAnswersReport(); // GenerateFormAnswersReport | Parameters for the form answers report

            try
            {
                // Generate form answers report
                AcceptedResponse result = apiInstance.GenerateFormAnswersReport(generateFormAnswersReport);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AdvancedReportsApi.GenerateFormAnswersReport: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
generateFormAnswersReport	GenerateFormAnswersReport	Parameters for the form answers report

Return type

AcceptedResponse

Authorization

Apikey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Accepted	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
408	Request Timeout	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

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

GenerateSendsReport

AcceptedResponse GenerateSendsReport (GenerateSendsReport generateSendsReport)

Generate sends report

Generates a new sends report

Example

using System.Collections.Generic;
using System.Diagnostics;
using org.egoi.client.api.Api;
using org.egoi.client.api.Client;
using org.egoi.client.api.Model;

namespace Example
{
    public class GenerateSendsReportExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.egoiapp.com";
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Apikey", "Bearer");

            var apiInstance = new AdvancedReportsApi(Configuration.Default);
            var generateSendsReport = new GenerateSendsReport(); // GenerateSendsReport | Parameters for the sends report

            try
            {
                // Generate sends report
                AcceptedResponse result = apiInstance.GenerateSendsReport(generateSendsReport);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AdvancedReportsApi.GenerateSendsReport: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
generateSendsReport	GenerateSendsReport	Parameters for the sends report

Return type

AcceptedResponse

Authorization

Apikey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Accepted	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
408	Request Timeout	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

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

GenerateSmsBouncesReport

AcceptedResponse GenerateSmsBouncesReport (GenerateSmsBouncesReport generateSmsBouncesReport)

Generate SMS bounces report

Generates a new SMS bounces report

Example

using System.Collections.Generic;
using System.Diagnostics;
using org.egoi.client.api.Api;
using org.egoi.client.api.Client;
using org.egoi.client.api.Model;

namespace Example
{
    public class GenerateSmsBouncesReportExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.egoiapp.com";
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Apikey", "Bearer");

            var apiInstance = new AdvancedReportsApi(Configuration.Default);
            var generateSmsBouncesReport = new GenerateSmsBouncesReport(); // GenerateSmsBouncesReport | Parameters for the SMS bounces report

            try
            {
                // Generate SMS bounces report
                AcceptedResponse result = apiInstance.GenerateSmsBouncesReport(generateSmsBouncesReport);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AdvancedReportsApi.GenerateSmsBouncesReport: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
generateSmsBouncesReport	GenerateSmsBouncesReport	Parameters for the SMS bounces report

Return type

AcceptedResponse

Authorization

Apikey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Accepted	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
408	Request Timeout	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

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

GenerateSmsEventsReport

AcceptedResponse GenerateSmsEventsReport (GenerateSmsEventsReport generateSmsEventsReport)

Generate SMS events report

Generates a new SMS events report

Example

using System.Collections.Generic;
using System.Diagnostics;
using org.egoi.client.api.Api;
using org.egoi.client.api.Client;
using org.egoi.client.api.Model;

namespace Example
{
    public class GenerateSmsEventsReportExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.egoiapp.com";
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Apikey", "Bearer");

            var apiInstance = new AdvancedReportsApi(Configuration.Default);
            var generateSmsEventsReport = new GenerateSmsEventsReport(); // GenerateSmsEventsReport | Parameters for the SMS events report

            try
            {
                // Generate SMS events report
                AcceptedResponse result = apiInstance.GenerateSmsEventsReport(generateSmsEventsReport);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AdvancedReportsApi.GenerateSmsEventsReport: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
generateSmsEventsReport	GenerateSmsEventsReport	Parameters for the SMS events report

Return type

AcceptedResponse

Authorization

Apikey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Accepted	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
408	Request Timeout	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

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

GenerateSubscriptionsReport

AcceptedResponse GenerateSubscriptionsReport (GenerateSubscriptionsReport generateSubscriptionsReport)

Generate subscriptions report

Generates a new subscriptions report

Example

using System.Collections.Generic;
using System.Diagnostics;
using org.egoi.client.api.Api;
using org.egoi.client.api.Client;
using org.egoi.client.api.Model;

namespace Example
{
    public class GenerateSubscriptionsReportExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.egoiapp.com";
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Apikey", "Bearer");

            var apiInstance = new AdvancedReportsApi(Configuration.Default);
            var generateSubscriptionsReport = new GenerateSubscriptionsReport(); // GenerateSubscriptionsReport | Parameters for the subscriptions report

            try
            {
                // Generate subscriptions report
                AcceptedResponse result = apiInstance.GenerateSubscriptionsReport(generateSubscriptionsReport);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AdvancedReportsApi.GenerateSubscriptionsReport: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
generateSubscriptionsReport	GenerateSubscriptionsReport	Parameters for the subscriptions report

Return type

AcceptedResponse

Authorization

Apikey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Accepted	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
408	Request Timeout	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

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

GenerateUnsubscriptionsReport

AcceptedResponse GenerateUnsubscriptionsReport (GenerateUnsubscriptionsReport generateUnsubscriptionsReport)

Generate unsubscriptions report

Generates a new unsubscriptions report

Example

using System.Collections.Generic;
using System.Diagnostics;
using org.egoi.client.api.Api;
using org.egoi.client.api.Client;
using org.egoi.client.api.Model;

namespace Example
{
    public class GenerateUnsubscriptionsReportExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.egoiapp.com";
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Apikey", "Bearer");

            var apiInstance = new AdvancedReportsApi(Configuration.Default);
            var generateUnsubscriptionsReport = new GenerateUnsubscriptionsReport(); // GenerateUnsubscriptionsReport | Parameters for the unsubscriptions report

            try
            {
                // Generate unsubscriptions report
                AcceptedResponse result = apiInstance.GenerateUnsubscriptionsReport(generateUnsubscriptionsReport);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AdvancedReportsApi.GenerateUnsubscriptionsReport: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
generateUnsubscriptionsReport	GenerateUnsubscriptionsReport	Parameters for the unsubscriptions report

Return type

AcceptedResponse

Authorization

Apikey

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
202	Accepted	-
400	Bad Request	-
401	Unauthorized	-
403	Forbidden	-
408	Request Timeout	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

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

GetAllAdvancedReports

AdvancedReportsCollection GetAllAdvancedReports (string status = null, string title = null, DateTime? createdMin = null, DateTime? createdMax = null, int? offset = null, int? limit = null, string order = null, string orderBy = null)

Get all advanced reports

Returns all advanced reports

Example

using System.Collections.Generic;
using System.Diagnostics;
using org.egoi.client.api.Api;
using org.egoi.client.api.Client;
using org.egoi.client.api.Model;

namespace Example
{
    public class GetAllAdvancedReportsExample
    {
        public static void Main()
        {
            Configuration.Default.BasePath = "https://api.egoiapp.com";
            // Configure API key authorization: Apikey
            Configuration.Default.AddApiKey("Apikey", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Apikey", "Bearer");

            var apiInstance = new AdvancedReportsApi(Configuration.Default);
            var status = status_example;  // string | Advanced report status (optional) 
            var title = title_example;  // string | Advanced report title (optional) 
            var createdMin = 2013-10-20T19:20:30+01:00;  // DateTime? | Created initial date (optional) 
            var createdMax = 2013-10-20T19:20:30+01:00;  // DateTime? | Created finish (optional) 
            var offset = 56;  // int? | Element offset (starting at zero for the first element) (optional) 
            var limit = 56;  // int? | Number of items to return (optional)  (default to 10)
            var order = order_example;  // string | Type of order (optional)  (default to desc)
            var orderBy = orderBy_example;  // string | Reference attribute to order the advanced reports (optional)  (default to advanced_report_id)

            try
            {
                // Get all advanced reports
                AdvancedReportsCollection result = apiInstance.GetAllAdvancedReports(status, title, createdMin, createdMax, offset, limit, order, orderBy);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AdvancedReportsApi.GetAllAdvancedReports: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
status	string	Advanced report status	[optional]
title	string	Advanced report title	[optional]
createdMin	DateTime?	Created initial date	[optional]
createdMax	DateTime?	Created finish	[optional]
offset	int?	Element offset (starting at zero for the first element)	[optional]
limit	int?	Number of items to return	[optional] [default to 10]
order	string	Type of order	[optional] [default to desc]
orderBy	string	Reference attribute to order the advanced reports	[optional] [default to advanced_report_id]

Return type

AdvancedReportsCollection

Authorization

Apikey

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
408	Request Timeout	-
422	Unprocessable Entity	-
429	Too Many Requests	-
500	Internal Server Error	-
503	Service Unavailable	-

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

Files

AdvancedReportsApi.md

Latest commit

History

AdvancedReportsApi.md

File metadata and controls

org.egoi.client.api.Api.AdvancedReportsApi

GenerateEmailBouncesReport

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GenerateEmailClicksByContactReport

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GenerateEmailClicksByUrlReport

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GenerateEmailEventsReport

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GenerateEmailUnsubscriptionsReport

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GenerateFormAnswersReport

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GenerateSendsReport

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GenerateSmsBouncesReport

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GenerateSmsEventsReport

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GenerateSubscriptionsReport

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

GenerateUnsubscriptionsReport

Example

Parameters