Informações e instruções das APIs dos produtos Locaweb.
Visualizando informações dos relatórios.
Resumo da mensagem.
GET: https://DOMINIO/api/v1/accounts/:id_conta/messages/:id_mensagem/overview
Retorno:
1
2
3
4
5
6
7
8
9
10
11
12
{
"status" : "Enviada",
"clicks" : 0,
"id" : "4fc8c0142c1e581227000003",
"uniq_openings" : 1,
"openings" : 1,
"contacts" : 5,
"bounces" : 0,
"deliveries" : 5,
"unsubscribes" : 0,
"name" : "Mensagem 1"
}
Listagem das visualizações da mensagem.
GET: https://DOMINIO/api/v1/accounts/:id_conta/messages/:id_mensagem/openings
Retorno de status HTTP: 200
Retorno:
1
2
3
4
5
6
7
8
9
10
11
12
[
{
"email" : "usuario1@locaweb.com.br",
"ip" : "127.0.0.1",
"access_at" : "12-01-01 00:00:00"
},
{
"email" : "usuario2@locaweb.com.br",
"ip" : "127.0.0.1",
"access_at" : "12-01-01 00:00:00"
}
]
Listagem das visualizações unicas da mensagem.
GET: https://DOMINIO/api/v1/accounts/:id_conta/messages/:id_mensagem/uniq_openings
Retorno de status HTTP: 200
Retorno:
1
2
3
4
5
6
7
8
9
10
11
12
[
{
"email" : "usuario1@locaweb.com.br",
"ip" : "127.0.0.1",
"access_at" : "12-01-01 00:00:00"
},
{
"email" : "usuario2@locaweb.com.br",
"ip" : "127.0.0.1",
"access_at" : "12-01-01 00:00:00"
}
]
Listagem de links da mensagem.
GET: https://DOMINIO/api/v1/accounts/:id_conta/messages/:id_mensagem/links
Retorno de status HTTP: 200
Retorno:
1
2
3
4
5
6
7
8
9
10
[
{
"href" : "http://locaweb.com.br",
"name" : "Mensagem 1"
},
{
"href" : "http://emkt.ocaweb.com.br",
"name" : "Mensagem 2"
},
]
Listagem de clicks da mensagem.
GET: https://DOMINIO/api/v1/accounts/:id_conta/messages/:id_mensagem/clicks
Retorno de status HTTP: 200
Retorno:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
[
{
"href" : "http://locaweb.com.br",
"email" : "email@locaweb.com.br",
"ip" : 127.0.0.1,
"access_at" : "12-01-01 00:00:00"
},
{
"href" : "http://DOMINIO",
"email" : "email@locaweb.com.br",
"ip" : 127.0.0.1,
"access_at" : "12-01-01 00:00:00"
}
]
Listagem de bounces da mensagem.
GET: https://DOMINIO/api/v1/accounts/:id_conta/messages/:id_mensagem/bounces
Retorno de status HTTP: 200
Retorno:
1
2
3
4
5
6
7
8
[
{
"status" : "5.1.7",
"email" : "email@locaweb.com.br",
"diagnostic" : "O endereço do remetente é sintaticamente inválido",
"access_at" : "12-01-01 00:00:00"
}
]