Share Transactional Reports

Overview

You can use this request to share reports on a specific transactional email. Use the ID of the email you want the reports on, and specify which report you want the system to return.

The Method

API	-	Method
REST	GET	https://[Your URL]/api/2.0/trans_groups/shared_report/$id
XML-RPC	Call	transactional._groups.GetTransactionalShareReport

Your URL is the address of your install.

Your method must be structured as follows:

GetTransactionalShareReport(integer | string $id) : object

Parameters

Required Parameters

The following parameters are required for this request to work correctly:

Property	Type	Description	Default	Required
$id	integer/string	The identifier of the transactional mail group.	none	yes

Responses

Type	Description
object	Object with the URLs to share the report.

Code Samples

$url = '(Your URL)/api/2.0/trans_groups/shared_report/:group_id';
$method = 'GET';
$cSession = curl_init();
$headers = array();
$auth = base64_encode($username . ':' . $apikey);
$headers[] = 'Authorization: Basic ' . $auth;
curl_setopt($cSession, CURLOPT_URL, $url);
curl_setopt($cSession, CURLOPT_RETURNTRANSFER, true);
curl_setopt($cSession, CURLOPT_HEADER, false);
curl_setopt($cSession, CURLOPT_CUSTOMREQUEST, strtoupper($method));
curl_setopt($cSession, CURLOPT_HTTPHEADER, $headers);
$result = curl_exec($cSession);
curl_close($cSession);