GET /v1/analytics/whatsapp/costs
GET
/v1/analytics/whatsapp/costs
const url = 'https://seu-endereco-da-api/v1/analytics/whatsapp/costs?channelId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&start=1&end=1&granularity=DAY';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://seu-endereco-da-api/v1/analytics/whatsapp/costs?channelId=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&start=1&end=1&granularity=DAY' \ --header 'Authorization: Bearer <token>'Permissão que a Chave de acesso precisa: Relatórios de marketing (analytics:marketing).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Query Parameters
Seção intitulada “Query Parameters”channelId
required
string format: uuid
start
required
number
end
required
number
granularity
string
Responses
Seção intitulada “Responses”Media typeapplication/json
object
channelId
required
string
wabaId
required
string
kpis
required
object
realCost
required
number
sent
required
number
delivered
required
number
billableMessages
required
number
freeService
required
number
topCategory
required
string
byCategory
required
Array<object>
object
category
required
string
messages
required
number
billableMessages
required
number
realCost
required
number
costSeries
required
Array<object>
object
label
required
string
real
required
number
volumeSeries
required
Array<object>
object
label
required
string
sent
required
number
delivered
required
number
templates
required
Array<object>
object
name
required
string
category
required
string
sent
required
number
delivered
required
number
deliveredPct
required
number
available
required
False when Meta did not answer this template’s batch
boolean
meta
required
object
pricingAvailable
required
boolean
volumeAvailable
required
boolean
templatesAvailable
required
boolean
debited
required
O que de fato saiu do saldo, lido ao vivo do extrato (fora do cache da Meta)
object
total
required
Total debitado do saldo no período, só das mensagens do canal
number
byCategory
required
Array<object>
object
category
required
string
messages
required
Mensagens cobradas do saldo, já descontadas as devolvidas
number
amount
required
Valor debitado do saldo do cliente, em reais, com o acréscimo da plataforma
number
cachedAt
required
string format: date-time
Example
{ "kpis": { "topCategory": "marketing" }, "byCategory": [ { "category": "marketing" } ], "debited": { "byCategory": [ { "category": "marketing" } ] }}