Skip to main content
GET
https://api.centralcart.com.br
/
v1
/
app
/
report
/
utms
UTMs
curl --request GET \
  --url https://api.centralcart.com.br/v1/app/report/utms
[
  {
    "utm_type": "utm_source",
    "utm_value": "google",
    "sales": 20,
    "revenue": 1500.00,
    "gross_revenue": 1750.00
  },
  {
    "utm_type": "utm_source",
    "utm_value": "instagram",
    "sales": 12,
    "revenue": 800.00,
    "gross_revenue": 950.00
  }
]
​
from
string
Data de início do período (formato: YYYY-MM-DD)
​
to
string
Data de fim do período (formato: YYYY-MM-DD)
​
utm_type
string
Tipo de UTM para filtrar: utm_source, utm_medium, utm_campaign, utm_term ou utm_content (padrão: utm_source)
​
filter_by_visit_date
string
Se true, filtra pela data de visita ao invés da data do pedido
O período máximo é de 60 dias. Períodos maiores serão ajustados automaticamente.

​
Response

Retorna um array com os top 5 UTMs.
​
utm_type
string
Tipo de UTM consultado
​
utm_value
string
Valor do UTM
​
sales
number
Quantidade de vendas com esse UTM
​
revenue
number
Receita líquida gerada por esse UTM
​
gross_revenue
number
Receita bruta gerada por esse UTM
[
  {
    "utm_type": "utm_source",
    "utm_value": "google",
    "sales": 20,
    "revenue": 1500.00,
    "gross_revenue": 1750.00
  },
  {
    "utm_type": "utm_source",
    "utm_value": "instagram",
    "sales": 12,
    "revenue": 800.00,
    "gross_revenue": 950.00
  }
]