Estatísticas da campanha
curl --request GET \
--url https://api.notifique.dev/v1/campaigns/{campaignId}/stats \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.notifique.dev/v1/campaigns/{campaignId}/stats', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.notifique.dev/v1/campaigns/{campaignId}/stats"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.notifique.dev/v1/campaigns/{campaignId}/stats"
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))
}{
"success": true,
"data": {
"campaign": {
"id": "clxx...",
"name": "Exemplo",
"status": "string",
"audienceCount": 1,
"startedAt": "2025-02-10T14:00:00.000Z",
"completedAt": "2025-02-10T14:00:00.000Z",
"lastRunAt": "2025-02-10T14:00:00.000Z",
"scheduledFor": "2025-02-10T14:00:00.000Z"
},
"run": {
"id": "clxx...",
"status": "SCHEDULED",
"trigger": "MANUAL",
"scheduledFor": "2025-02-10T14:00:00.000Z",
"startedAt": "2025-02-10T14:00:00.000Z",
"completedAt": "2025-02-10T14:00:00.000Z",
"audienceCount": 1,
"errorMessage": "string",
"errorLabel": "string"
},
"funnel": {
"whatsapp": {
"queued": 1,
"sent": 1,
"delivered": 1,
"read": 1,
"clicked": 1,
"responded": 1,
"failed": 1,
"total": 1
},
"sms": {
"queued": 1,
"sent": 1,
"delivered": 1,
"read": 1,
"clicked": 1,
"responded": 1,
"failed": 1,
"total": 1
},
"email": {
"queued": 1,
"sent": 1,
"delivered": 1,
"read": 1,
"clicked": 1,
"responded": 1,
"failed": 1,
"total": 1
},
"telegram": {
"queued": 1,
"sent": 1,
"delivered": 1,
"read": 1,
"clicked": 1,
"responded": 1,
"failed": 1,
"total": 1
}
},
"totals": {
"queued": 1,
"sent": 1,
"delivered": 1,
"read": 1,
"clicked": 1,
"responded": 1,
"failed": 1,
"total": 1
},
"rates": {
"deliveryRate": 1,
"readRate": 1,
"clickRate": 1,
"failureRate": 1
},
"timeline": [
{
"hour": "string",
"sent": 1,
"delivered": 1,
"read": 1,
"failed": 1
}
],
"cost": {
"byChannel": [
{
"channel": "whatsapp",
"count": 1,
"credits": 1,
"cents": 1,
"chargedAs": "string"
}
],
"totalCredits": 1,
"totalCents": 1
},
"clicks": 1,
"topErrors": [
{
"message": "string",
"rawMessage": "string",
"count": 1
}
]
}
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}Campanhas
Estatísticas da campanha
Mostra números de envio e desempenho da campanha.
GET
/
v1
/
campaigns
/
{campaignId}
/
stats
Estatísticas da campanha
curl --request GET \
--url https://api.notifique.dev/v1/campaigns/{campaignId}/stats \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.notifique.dev/v1/campaigns/{campaignId}/stats', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.notifique.dev/v1/campaigns/{campaignId}/stats"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.notifique.dev/v1/campaigns/{campaignId}/stats"
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))
}{
"success": true,
"data": {
"campaign": {
"id": "clxx...",
"name": "Exemplo",
"status": "string",
"audienceCount": 1,
"startedAt": "2025-02-10T14:00:00.000Z",
"completedAt": "2025-02-10T14:00:00.000Z",
"lastRunAt": "2025-02-10T14:00:00.000Z",
"scheduledFor": "2025-02-10T14:00:00.000Z"
},
"run": {
"id": "clxx...",
"status": "SCHEDULED",
"trigger": "MANUAL",
"scheduledFor": "2025-02-10T14:00:00.000Z",
"startedAt": "2025-02-10T14:00:00.000Z",
"completedAt": "2025-02-10T14:00:00.000Z",
"audienceCount": 1,
"errorMessage": "string",
"errorLabel": "string"
},
"funnel": {
"whatsapp": {
"queued": 1,
"sent": 1,
"delivered": 1,
"read": 1,
"clicked": 1,
"responded": 1,
"failed": 1,
"total": 1
},
"sms": {
"queued": 1,
"sent": 1,
"delivered": 1,
"read": 1,
"clicked": 1,
"responded": 1,
"failed": 1,
"total": 1
},
"email": {
"queued": 1,
"sent": 1,
"delivered": 1,
"read": 1,
"clicked": 1,
"responded": 1,
"failed": 1,
"total": 1
},
"telegram": {
"queued": 1,
"sent": 1,
"delivered": 1,
"read": 1,
"clicked": 1,
"responded": 1,
"failed": 1,
"total": 1
}
},
"totals": {
"queued": 1,
"sent": 1,
"delivered": 1,
"read": 1,
"clicked": 1,
"responded": 1,
"failed": 1,
"total": 1
},
"rates": {
"deliveryRate": 1,
"readRate": 1,
"clickRate": 1,
"failureRate": 1
},
"timeline": [
{
"hour": "string",
"sent": 1,
"delivered": 1,
"read": 1,
"failed": 1
}
],
"cost": {
"byChannel": [
{
"channel": "whatsapp",
"count": 1,
"credits": 1,
"cents": 1,
"chargedAs": "string"
}
],
"totalCredits": 1,
"totalCents": 1
},
"clicks": 1,
"topErrors": [
{
"message": "string",
"rawMessage": "string",
"count": 1
}
]
}
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}{
"success": false,
"error": "Bad Request",
"code": "VALIDATION_ERROR",
"message": "Campo inválido ou ausente."
}Autorizações
ntfContactBearerAuthntfContactApiKeyHeader
Authorization: Bearer sk_live_xxxxx
Parâmetros de caminho
Parâmetros de consulta
Resposta
OK
Estatísticas da campanha (últimos 4 canais de create)
Show child attributes
Show child attributes
Exemplo:
{
"campaign": {
"id": "clxx...",
"name": "Exemplo",
"status": "string",
"audienceCount": 1,
"startedAt": "2025-02-10T14:00:00.000Z",
"completedAt": "2025-02-10T14:00:00.000Z",
"lastRunAt": "2025-02-10T14:00:00.000Z",
"scheduledFor": "2025-02-10T14:00:00.000Z"
},
"run": {
"id": "clxx...",
"status": "SCHEDULED",
"trigger": "MANUAL",
"scheduledFor": "2025-02-10T14:00:00.000Z",
"startedAt": "2025-02-10T14:00:00.000Z",
"completedAt": "2025-02-10T14:00:00.000Z",
"audienceCount": 1,
"errorMessage": "string",
"errorLabel": "string"
},
"funnel": {
"whatsapp": {
"queued": 1,
"sent": 1,
"delivered": 1,
"read": 1,
"clicked": 1,
"responded": 1,
"failed": 1,
"total": 1
},
"sms": {
"queued": 1,
"sent": 1,
"delivered": 1,
"read": 1,
"clicked": 1,
"responded": 1,
"failed": 1,
"total": 1
},
"email": {
"queued": 1,
"sent": 1,
"delivered": 1,
"read": 1,
"clicked": 1,
"responded": 1,
"failed": 1,
"total": 1
},
"telegram": {
"queued": 1,
"sent": 1,
"delivered": 1,
"read": 1,
"clicked": 1,
"responded": 1,
"failed": 1,
"total": 1
}
},
"totals": {
"queued": 1,
"sent": 1,
"delivered": 1,
"read": 1,
"clicked": 1,
"responded": 1,
"failed": 1,
"total": 1
},
"rates": {
"deliveryRate": 1,
"readRate": 1,
"clickRate": 1,
"failureRate": 1
},
"timeline": [
{
"hour": "string",
"sent": 1,
"delivered": 1,
"read": 1,
"failed": 1
}
],
"cost": {
"byChannel": [
{
"channel": "whatsapp",
"count": 1,
"credits": 1,
"cents": 1,
"chargedAs": "string"
}
],
"totalCredits": 1,
"totalCents": 1
},
"clicks": 1,
"topErrors": [
{
"message": "string",
"rawMessage": "string",
"count": 1
}
]
}
Esta página foi útil?

