Pular para o conteúdo

POST /v1/analytics/campaigns/search

POST
/v1/analytics/campaigns/search
curl --request POST \
--url https://seu-endereco-da-api/v1/analytics/campaigns/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "window": "current", "period": "7", "filter": {} }'

Permissão que a Chave de acesso precisa: Relatórios de marketing (analytics:marketing).

Media typeapplication/json
object
window
string
Allowed values: current previous
period
string
Allowed values: 7 30 90
filter
object
key
additional properties
any
Media typeapplication/json
object
kpis
required
object
sent
required
number
deliveryPct
required
number
readPct
required
number
replyPct
required
number
optOut
required
number
cost
required
number
series
required
Array<object>
object
label
required
string
value
required
number
byChannel
required
Array<object>
object
key
required
string
label
required
string
value
required
number
color
required
string
byCategory
required
Array<object>
object
key
required
string
label
required
string
value
required
number
color
required
string
campaigns
required
Array<object>
object
name
required
string
channel
required
string
sent
required
number
deliveryPct
required
number
readPct
required
number
replyPct
required
number
cost
required
number
templates
required
Array<object>
object
name
required
string
category
required
string
uses
required
number
readPct
required
number
replyPct
required
number

Example generated

{
"kpis": {
"sent": 1,
"deliveryPct": 1,
"readPct": 1,
"replyPct": 1,
"optOut": 1,
"cost": 1
},
"series": [
{
"label": "example",
"value": 1
}
],
"byChannel": [
{
"key": "example",
"label": "example",
"value": 1,
"color": "example"
}
],
"byCategory": [
{
"key": "example",
"label": "example",
"value": 1,
"color": "example"
}
],
"campaigns": [
{
"name": "example",
"channel": "example",
"sent": 1,
"deliveryPct": 1,
"readPct": 1,
"replyPct": 1,
"cost": 1
}
],
"templates": [
{
"name": "example",
"category": "example",
"uses": 1,
"readPct": 1,
"replyPct": 1
}
]
}