Methods

Objects

sendr/10/report

Report SENDR Service (v1.0). Get reports for your SENDR campaigns.

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

Methods

sendr/10/report.export_async

Description

Export a campaign report as a file

Signature

method: sendr/10/report.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)

sendr/10/report.get

Description

Get campaign report

Signature

method: sendr/10/report.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

sendr/10/report.search

Description

Search campaign reports

Signature

method: sendr/10/report.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