egoisdk.AdvancedReportsApi

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

Method	HTTP request	Description
generateByModelReport	POST /reports/advanced/model	Generate report by model
generateContactActivityReport	POST /reports/advanced/contact-activity	Generate contact activity report
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
getAllAdvancedReportsModels	GET /reports/advanced/models	Get all advanced reports models

generateByModelReport

AcceptedResponse generateByModelReport(generateByModelReport)

Generate report by model

Generates a new report by model Id

Example

import egoisdk from 'egoisdk';
let defaultClient = egoisdk.ApiClient.instance;
// Configure API key authorization: Apikey
let Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix = 'Token';

let apiInstance = new egoisdk.AdvancedReportsApi();
let generateByModelReport = new egoisdk.GenerateByModelReport(); // GenerateByModelReport | Parameters for the report by model Id
apiInstance.generateByModelReport(generateByModelReport, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
generateByModelReport	GenerateByModelReport	Parameters for the report by model Id

Return type

AcceptedResponse

Authorization

Apikey

HTTP request headers

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

generateContactActivityReport

AcceptedResponse generateContactActivityReport(generateContactActivityReport)

Generate contact activity report

Generates a new contact activity report

Example

import egoisdk from 'egoisdk';
let defaultClient = egoisdk.ApiClient.instance;
// Configure API key authorization: Apikey
let Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix = 'Token';

let apiInstance = new egoisdk.AdvancedReportsApi();
let generateContactActivityReport = new egoisdk.GenerateContactActivityReport(); // GenerateContactActivityReport | Parameters for the contact activity report
apiInstance.generateContactActivityReport(generateContactActivityReport, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
generateContactActivityReport	GenerateContactActivityReport	Parameters for the contact activity report

Return type

AcceptedResponse

Authorization

Apikey

HTTP request headers

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

generateEmailBouncesReport

AcceptedResponse generateEmailBouncesReport(generateEmailBouncesReport)

Generate email bounces report

Generates a new email bounces report

Example

import egoisdk from 'egoisdk';
let defaultClient = egoisdk.ApiClient.instance;
// Configure API key authorization: Apikey
let Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix = 'Token';

let apiInstance = new egoisdk.AdvancedReportsApi();
let generateEmailBouncesReport = new egoisdk.GenerateEmailBouncesReport(); // GenerateEmailBouncesReport | Parameters for the email bounces report
apiInstance.generateEmailBouncesReport(generateEmailBouncesReport, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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

generateEmailClicksByContactReport

AcceptedResponse generateEmailClicksByContactReport(generateEmailClicksByContactReport)

Generate email clicks by contact report

Generates a new email clicks by contact report

Example

import egoisdk from 'egoisdk';
let defaultClient = egoisdk.ApiClient.instance;
// Configure API key authorization: Apikey
let Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix = 'Token';

let apiInstance = new egoisdk.AdvancedReportsApi();
let generateEmailClicksByContactReport = new egoisdk.GenerateEmailClicksByContactReport(); // GenerateEmailClicksByContactReport | Parameters for the email clicks by contact report
apiInstance.generateEmailClicksByContactReport(generateEmailClicksByContactReport, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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

generateEmailClicksByUrlReport

AcceptedResponse generateEmailClicksByUrlReport(generateEmailClicksByUrlReport)

Generate email clicks by URL report

Generates a new email clicks by URL report

Example

import egoisdk from 'egoisdk';
let defaultClient = egoisdk.ApiClient.instance;
// Configure API key authorization: Apikey
let Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix = 'Token';

let apiInstance = new egoisdk.AdvancedReportsApi();
let generateEmailClicksByUrlReport = new egoisdk.GenerateEmailClicksByUrlReport(); // GenerateEmailClicksByUrlReport | Parameters for the email clicks by URL report
apiInstance.generateEmailClicksByUrlReport(generateEmailClicksByUrlReport, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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

generateEmailEventsReport

AcceptedResponse generateEmailEventsReport(generateEmailEventsReport)

Generate email events report

Generates a new email events report

Example

import egoisdk from 'egoisdk';
let defaultClient = egoisdk.ApiClient.instance;
// Configure API key authorization: Apikey
let Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix = 'Token';

let apiInstance = new egoisdk.AdvancedReportsApi();
let generateEmailEventsReport = new egoisdk.GenerateEmailEventsReport(); // GenerateEmailEventsReport | Parameters for the email events report
apiInstance.generateEmailEventsReport(generateEmailEventsReport, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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

generateEmailUnsubscriptionsReport

AcceptedResponse generateEmailUnsubscriptionsReport(generateEmailUnsubscriptionsReport)

Generate email unsubscriptions report

Generates a new email unsubscriptions report

Example

import egoisdk from 'egoisdk';
let defaultClient = egoisdk.ApiClient.instance;
// Configure API key authorization: Apikey
let Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix = 'Token';

let apiInstance = new egoisdk.AdvancedReportsApi();
let generateEmailUnsubscriptionsReport = new egoisdk.GenerateEmailUnsubscriptionsReport(); // GenerateEmailUnsubscriptionsReport | Parameters for the email unsubscriptions report
apiInstance.generateEmailUnsubscriptionsReport(generateEmailUnsubscriptionsReport, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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

generateFormAnswersReport

AcceptedResponse generateFormAnswersReport(generateFormAnswersReport)

Generate form answers report

Generates a new form answers report

Example

import egoisdk from 'egoisdk';
let defaultClient = egoisdk.ApiClient.instance;
// Configure API key authorization: Apikey
let Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix = 'Token';

let apiInstance = new egoisdk.AdvancedReportsApi();
let generateFormAnswersReport = new egoisdk.GenerateFormAnswersReport(); // GenerateFormAnswersReport | Parameters for the form answers report
apiInstance.generateFormAnswersReport(generateFormAnswersReport, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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

generateSendsReport

AcceptedResponse generateSendsReport(generateSendsReport)

Generate sends report

Generates a new sends report

Example

import egoisdk from 'egoisdk';
let defaultClient = egoisdk.ApiClient.instance;
// Configure API key authorization: Apikey
let Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix = 'Token';

let apiInstance = new egoisdk.AdvancedReportsApi();
let generateSendsReport = new egoisdk.GenerateSendsReport(); // GenerateSendsReport | Parameters for the sends report
apiInstance.generateSendsReport(generateSendsReport, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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

generateSmsBouncesReport

AcceptedResponse generateSmsBouncesReport(generateSmsBouncesReport)

Generate SMS bounces report

Generates a new SMS bounces report

Example

import egoisdk from 'egoisdk';
let defaultClient = egoisdk.ApiClient.instance;
// Configure API key authorization: Apikey
let Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix = 'Token';

let apiInstance = new egoisdk.AdvancedReportsApi();
let generateSmsBouncesReport = new egoisdk.GenerateSmsBouncesReport(); // GenerateSmsBouncesReport | Parameters for the SMS bounces report
apiInstance.generateSmsBouncesReport(generateSmsBouncesReport, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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

generateSmsEventsReport

AcceptedResponse generateSmsEventsReport(generateSmsEventsReport)

Generate SMS events report

Generates a new SMS events report

Example

import egoisdk from 'egoisdk';
let defaultClient = egoisdk.ApiClient.instance;
// Configure API key authorization: Apikey
let Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix = 'Token';

let apiInstance = new egoisdk.AdvancedReportsApi();
let generateSmsEventsReport = new egoisdk.GenerateSmsEventsReport(); // GenerateSmsEventsReport | Parameters for the SMS events report
apiInstance.generateSmsEventsReport(generateSmsEventsReport, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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

generateSubscriptionsReport

AcceptedResponse generateSubscriptionsReport(generateSubscriptionsReport)

Generate subscriptions report

Generates a new subscriptions report

Example

import egoisdk from 'egoisdk';
let defaultClient = egoisdk.ApiClient.instance;
// Configure API key authorization: Apikey
let Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix = 'Token';

let apiInstance = new egoisdk.AdvancedReportsApi();
let generateSubscriptionsReport = new egoisdk.GenerateSubscriptionsReport(); // GenerateSubscriptionsReport | Parameters for the subscriptions report
apiInstance.generateSubscriptionsReport(generateSubscriptionsReport, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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

generateUnsubscriptionsReport

AcceptedResponse generateUnsubscriptionsReport(generateUnsubscriptionsReport)

Generate unsubscriptions report

Generates a new unsubscriptions report

Example

import egoisdk from 'egoisdk';
let defaultClient = egoisdk.ApiClient.instance;
// Configure API key authorization: Apikey
let Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix = 'Token';

let apiInstance = new egoisdk.AdvancedReportsApi();
let generateUnsubscriptionsReport = new egoisdk.GenerateUnsubscriptionsReport(); // GenerateUnsubscriptionsReport | Parameters for the unsubscriptions report
apiInstance.generateUnsubscriptionsReport(generateUnsubscriptionsReport, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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

getAllAdvancedReports

AdvancedReportsCollection getAllAdvancedReports(opts)

Get all advanced reports

Returns all advanced reports

Example

import egoisdk from 'egoisdk';
let defaultClient = egoisdk.ApiClient.instance;
// Configure API key authorization: Apikey
let Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix = 'Token';

let apiInstance = new egoisdk.AdvancedReportsApi();
let opts = {
  'status': "status_example", // String | Advanced report status
  'title': "title_example", // String | Advanced report title
  'createdMin': new Date("2013-10-20T19:20:30+01:00"), // Date | Created initial date
  'createdMax': new Date("2013-10-20T19:20:30+01:00"), // Date | Created finish
  'offset': 56, // Number | Element offset (starting at zero for the first element)
  'limit': 10, // Number | Number of items to return
  'order': "'desc'", // String | Type of order
  'orderBy': "'advanced_report_id'" // String | Reference attribute to order the advanced reports
};
apiInstance.getAllAdvancedReports(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
status	String	Advanced report status	[optional]
title	String	Advanced report title	[optional]
createdMin	Date	Created initial date	[optional]
createdMax	Date	Created finish	[optional]
offset	Number	Element offset (starting at zero for the first element)	[optional]
limit	Number	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

getAllAdvancedReportsModels

AdvancedReportsModelsCollection getAllAdvancedReportsModels(opts)

Get all advanced reports models

Returns all advanced reports

Example

import egoisdk from 'egoisdk';
let defaultClient = egoisdk.ApiClient.instance;
// Configure API key authorization: Apikey
let Apikey = defaultClient.authentications['Apikey'];
Apikey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.apiKeyPrefix = 'Token';

let apiInstance = new egoisdk.AdvancedReportsApi();
let opts = {
  'title': "title_example", // String | Advanced report model title
  'offset': 56, // Number | Element offset (starting at zero for the first element)
  'limit': 10, // Number | Number of items to return
  'order': "'desc'", // String | Type of order
  'orderBy': "'model_id'" // String | Reference attribute to order the advanced reports
};
apiInstance.getAllAdvancedReportsModels(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
title	String	Advanced report model title	[optional]
offset	Number	Element offset (starting at zero for the first element)	[optional]
limit	Number	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 'model_id']

Return type

AdvancedReportsModelsCollection

Authorization

Apikey

HTTP request headers

Content-Type: Not defined
Accept: application/json

FilesExpand file tree

AdvancedReportsApi.md

Latest commit

History

AdvancedReportsApi.md

File metadata and controls

egoisdk.AdvancedReportsApi

generateByModelReport

Example

Parameters

Return type

Authorization

HTTP request headers

generateContactActivityReport

Example

Parameters

Return type

Authorization

HTTP request headers

generateEmailBouncesReport

Example

Parameters

Return type

Authorization

HTTP request headers

generateEmailClicksByContactReport

Example

Parameters

Return type

Authorization

HTTP request headers

generateEmailClicksByUrlReport

Example

Parameters

Return type

Authorization

HTTP request headers

generateEmailEventsReport

Example

Parameters

Return type

Authorization

HTTP request headers

generateEmailUnsubscriptionsReport

Example

Parameters

Return type

Authorization

HTTP request headers

generateFormAnswersReport

Example

Parameters

Return type

Authorization

HTTP request headers

generateSendsReport

Example

Parameters

Return type

Authorization

HTTP request headers

generateSmsBouncesReport

Example

Parameters

Return type

Authorization

HTTP request headers

generateSmsEventsReport

Example

Parameters

Return type

Authorization

HTTP request headers

generateSubscriptionsReport

Example

Parameters

Return type

Authorization

HTTP request headers

generateUnsubscriptionsReport