Український
English
ItalianМетод getVisitedLinks
Получить отчёт по посещенным пользователями ссылкам в указанной email рассылке.
Принцип использования
| Синтаксис и URL для вызова метода |
| getVisitedLinks (int campaign_id[, bool group]) |
| http://api.unisender.com/ru/api/getVisitedLinks?format=json&api_key=KEY&campaign_id=ID &group=1 |
| Аргументы | |
|---|---|
| api_key * | Ключ доступа к API |
| campaign_id * | Идентификатор кампании, полученный при вызове метода createCampaign. |
| group | Группировать результаты по посещенным ссылкам. Если пользователь посетил ссылку несколько раз, в результатах это будет представлено одной записью, с указанием количества посещений в поле count. |
| Возвращаемое значение | |
|---|---|
| JSON-объект со следующим полями: | |
| fields | Массив имен полей. Включает поля email (адрес пользователя), url (посещённая ссылка), request_time (время посещения), ip (ip адрес пользователя) и count (количество посещений ссылки, если указан параметр group). |
| data | Массив результатов посещенных ссылок. Каждый результат представляет собой массив полей, описанный в fields. |
|
Если были ошибки или предупреждения, они возвращаются в полях error/warnings
в соответствии с описанием.
Пример возвращаемого значения:
{
"result":{
"fields":["email","url","request_time","ip"] ,
"data":[
["one@gmail.com","http://yandex.ru","2011-01-27 09:38:01","127.0.0.1"]
["two@hotmail.com","http://google.com","2011-01-27 09:38:02","127.0.0.1"]
["three@yandex.ru","http://gmail.com","2011-01-27 09:38:03","127.0.0.1"]
]
}
}
|
|
Смотрите также
Примеры на PHP
Мы настоятельно рекомендуем использовать POST-запросы, так как это более безопасный метод передачи данных, нежели GET. Более того, по возможности используйте SSL-соединение с UniSender. Подробнее о методах соединения здесь.
Пример с использованием POST-запроса
// Ваш ключ доступа к API (из Личного Кабинета)
$api_key = "xxxxxxxxxxxxxxx";
// Параметры для отправки сообщения
$id = "932498";
// Создаём POST-запрос
$POST = array (
'api_key' => $api_key,
'campaign_id' => $id,
);
// Устанавливаем соединение
$ch = curl_init();
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $POST);
curl_setopt($ch, CURLOPT_TIMEOUT, 10);
curl_setopt($ch, CURLOPT_URL,
'http://api.unisender.com/ru/api/getVisitedLinks?format=json');
$result = curl_exec($ch);
if ($result) {
// Раскодируем ответ API-сервера
$jsonObj = json_decode($result);
if(null===$jsonObj) {
// Ошибка в полученном ответе
echo "Invalid JSON";
}
elseif(!empty($jsonObj->error)) {
// Ошибка получения статистики
echo "An error occured: " . $jsonObj->error . "(code: " . $jsonObj->code . ")";
} else {
// Статистика получена, отображаем в виде таблицы
echo "<table border='1'>";
echo "<tr><td>E-mail address</td><td>Url</td><td>Date/time</td></tr>";
foreach ($jsonObj->result->data as $one) {
echo "<tr><td>" . $one[0] . "</td><td>" . $one[1] .
"</td><td>" . $one[2] . "</td></tr>";
}
echo "</table>";
}
} else {
// Ошибка соединения с API-сервером
echo "API access error";
}
Пример с использованием GET-запроса
// Ваш ключ доступа к API (из Личного Кабинета)
$api_key = "xxxxxxxxxxxxxxxxxxxx";
// ID кампании, по которой надо получить статистику
$email_id = "932498";
// Создаём GET-запрос
$api_url = "http://api.unisender.com/ru/api/getVisitedLinks?format=json".
"&api_key=$api_key&campaign_id=$email_id";
// Делаем запрос на API-сервер
$result = file_get_contents($api_url);
if ($result) {
// Раскодируем ответ API-сервера
$jsonObj = json_decode($result);
if(null===$jsonObj) {
// Ошибка в полученном ответе
echo "Invalid JSON";
}
elseif(!empty($jsonObj->error)) {
// Ошибка получения статистики
echo "An error occured: " . $jsonObj->error . "(code: " . $jsonObj->code . ")";
} else {
// Статистика получена, отображаем в виде таблицы
echo "<table border='1'>";
echo "<tr><td>E-mail address</td><td>Url</td><td>Date/time</td></tr>";
foreach ($jsonObj->result->data as $one) {
echo "<tr><td>" . $one[0] . "</td><td>" . $one[1] .
"</td><td>" . $one[2] . "</td></tr>";
}
echo "</table>";
}
} else {
// Ошибка соединения с API-сервером
echo "API access error";
}
Правила использования | Политика конфиденциальности
| Анти-спам политика
© UniSender 2008-2011