Methods

Objects

Method Description
.export_async Export a campaign report as a file
.get Get campaign report
.search Search campaign reports

Methods

.export_async

Description

Export a campaign report as a file

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: .export_async

params: [string hash, string format, object options, object webhook]

Parameters

Parameter Type Description NULL
hash string Campaign ID
Format: hash (Unique object identifier)
NO
format string File format wanted. For now can only be CSV_UTF8. NO
options object UNUSED. NULL or {} YES
webhook object Dynamic webhook for this export. Status updates (e.g. when the export is available) will be sent to this specific webhook. You only need to set 'endpoint' and optionally 'options'. The job result will contain a url pointing to the generated CSV file.
Object: Webhook
YES

Result

Type Description Format/Object
string Job ID Format: hid (Unique object identifier)

.get

Description

Get campaign report

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: .get

params: [string hash]

Parameters

Parameter Type Description NULL
hash string Report ID
Format: hash (Unique object identifier)
NO

Result

Type Description Format/Object
object Report object Object: Sendr.10.Report

.search

Description

Search campaign reports

This method is DEPRECATED and may be removed in the future.
Relying on this method is highly discouraged.

Signature

method: .search

params: [object filters, object options]

Parameters

Parameter Type Description NULL
filters object Search filters
Object: Sendr.10.Report.SearchFilters
NO
options object Search options
Object: Search.Options
NO

Result

Type Description Format/Object
object Results Object: Search.Results