Campaigns
Get consolidated campaign result
GET
/
campaigns
/
{id}
/
report
Get consolidated campaign result
curl --request GET \
--url https://api.connectadesk.com/api/v1/campaigns/{id}/report \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.connectadesk.com/api/v1/campaigns/{id}/report"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.connectadesk.com/api/v1/campaigns/{id}/report', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.connectadesk.com/api/v1/campaigns/{id}/report",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.connectadesk.com/api/v1/campaigns/{id}/report"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.connectadesk.com/api/v1/campaigns/{id}/report")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.connectadesk.com/api/v1/campaigns/{id}/report")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"rows": [
{
"campaign_id": 33,
"campaign_name": "Promoção de inverno",
"channel_id": 11,
"channel_name": "Instagram Loja",
"channel_type": "whatsapp",
"campaigns_count": 12,
"channels_count": 3,
"contacts_imported": 5400,
"contacts_waiting": 120,
"contacts_sent": 5100,
"contacts_failed": 180,
"contacts_delivered": 4890,
"contacts_read": 3120,
"contacts_answered": 640,
"contacts_chat_opened": 410,
"contacts_wrapped_up": 300
}
],
"totals": {
"campaigns_count": 12,
"channels_count": 3,
"contacts_imported": 5400,
"contacts_waiting": 120,
"contacts_sent": 5100,
"contacts_failed": 180,
"contacts_delivered": 4890,
"contacts_read": 3120,
"contacts_answered": 640,
"contacts_chat_opened": 410,
"contacts_wrapped_up": 300
},
"page": 1,
"perPage": 20,
"total": 12,
"totalPages": 1
}
}{
"error": {
"code": "ERR_API_NOT_FOUND",
"message": "Registro não encontrado."
}
}Authorizations
API token in the sk_live_… format.
Path Parameters
Response
OK
Consolidated campaign results, grouped according to the groupBy parameter.
The fields that identify each row depend on the grouping: campaign returns campaign_id, campaign_name and channel_name; channel.id returns channel_id and channel_name; channel.type returns channel_type. The counters are always the same.
Show child attributes
Show child attributes
⌘I
Get consolidated campaign result
curl --request GET \
--url https://api.connectadesk.com/api/v1/campaigns/{id}/report \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.connectadesk.com/api/v1/campaigns/{id}/report"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.connectadesk.com/api/v1/campaigns/{id}/report', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.connectadesk.com/api/v1/campaigns/{id}/report",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.connectadesk.com/api/v1/campaigns/{id}/report"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.connectadesk.com/api/v1/campaigns/{id}/report")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.connectadesk.com/api/v1/campaigns/{id}/report")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": {
"rows": [
{
"campaign_id": 33,
"campaign_name": "Promoção de inverno",
"channel_id": 11,
"channel_name": "Instagram Loja",
"channel_type": "whatsapp",
"campaigns_count": 12,
"channels_count": 3,
"contacts_imported": 5400,
"contacts_waiting": 120,
"contacts_sent": 5100,
"contacts_failed": 180,
"contacts_delivered": 4890,
"contacts_read": 3120,
"contacts_answered": 640,
"contacts_chat_opened": 410,
"contacts_wrapped_up": 300
}
],
"totals": {
"campaigns_count": 12,
"channels_count": 3,
"contacts_imported": 5400,
"contacts_waiting": 120,
"contacts_sent": 5100,
"contacts_failed": 180,
"contacts_delivered": 4890,
"contacts_read": 3120,
"contacts_answered": 640,
"contacts_chat_opened": 410,
"contacts_wrapped_up": 300
},
"page": 1,
"perPage": 20,
"total": 12,
"totalPages": 1
}
}{
"error": {
"code": "ERR_API_NOT_FOUND",
"message": "Registro não encontrado."
}
}
