Relatórios
Consultar relatório de automações
Lista as execuções de automação em andamento.
GET
/
reports
/
automations
Consultar relatório de automações
curl --request GET \
--url https://api.connectadesk.com/api/v1/reports/automations \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.connectadesk.com/api/v1/reports/automations"
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/reports/automations', 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/reports/automations",
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/reports/automations"
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/reports/automations")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.connectadesk.com/api/v1/reports/automations")
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": [
{
"sessionId": "9f2c1a70-31bd-4a4e-b0f2-17c6d3a91b55",
"automationId": "<string>",
"publicAutomationId": "aut_7d21c9",
"automationName": "Boas-vindas do site",
"triggerType": "message_received",
"triggerLabel": "Mensagem recebida",
"startedAt": "2023-11-07T05:31:56Z",
"durationLabel": "2 h 14 min",
"executionStatus": "running",
"contactId": "842",
"contactName": "Maria Silva",
"contactNumber": "5511987654321",
"ticketId": "<string>",
"protocolId": "<string>",
"conversationStatus": "<string>",
"blockId": "<string>",
"blockLabel": "Aguarda resposta",
"situation": "Aguardando resposta do contato",
"waitingFor": "<string>",
"pausedBlockType": "<string>",
"resumeAt": "2023-11-07T05:31:56Z",
"source": "<string>",
"lastProgressAt": "2023-11-07T05:31:56Z",
"isOverdue": false
}
],
"meta": {
"page": 1,
"perPage": 20,
"hasMore": true
}
}Autorizações
Token da API no formato sk_live_….
Parâmetros de consulta
Número da página, começando em 1. Um valor inválido é tratado como 1.
Intervalo obrigatório:
x >= 1Quantidade de itens por página. O máximo depende do ambiente (padrão 100).
Intervalo obrigatório:
1 <= x <= 100Início do período analisado. O dia começa no fuso da sua empresa.
Fim do período analisado. O dia termina às 23:59:59 no fuso da sua empresa.
Busca por nome ou número do contato.
Ids das automações, separados por vírgula.
Tipos de gatilho, separados por vírgula.
Situações da conversa, separadas por vírgula.
Origem da execução.
⌘I
Consultar relatório de automações
curl --request GET \
--url https://api.connectadesk.com/api/v1/reports/automations \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.connectadesk.com/api/v1/reports/automations"
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/reports/automations', 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/reports/automations",
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/reports/automations"
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/reports/automations")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.connectadesk.com/api/v1/reports/automations")
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": [
{
"sessionId": "9f2c1a70-31bd-4a4e-b0f2-17c6d3a91b55",
"automationId": "<string>",
"publicAutomationId": "aut_7d21c9",
"automationName": "Boas-vindas do site",
"triggerType": "message_received",
"triggerLabel": "Mensagem recebida",
"startedAt": "2023-11-07T05:31:56Z",
"durationLabel": "2 h 14 min",
"executionStatus": "running",
"contactId": "842",
"contactName": "Maria Silva",
"contactNumber": "5511987654321",
"ticketId": "<string>",
"protocolId": "<string>",
"conversationStatus": "<string>",
"blockId": "<string>",
"blockLabel": "Aguarda resposta",
"situation": "Aguardando resposta do contato",
"waitingFor": "<string>",
"pausedBlockType": "<string>",
"resumeAt": "2023-11-07T05:31:56Z",
"source": "<string>",
"lastProgressAt": "2023-11-07T05:31:56Z",
"isOverdue": false
}
],
"meta": {
"page": 1,
"perPage": 20,
"hasMore": true
}
}
