Synup
Criar chave
v1Recursos/Análise de perfil/getObter o relatório de funil

Obter o relatório de funil

O relatório de funil completo da página Relatórios: o que as pessoas fizeram depois de encontrar seus clientes, por canal (Business Profile, site, pesquisa do Google, redes sociais e convites de avaliação), nas últimas 4 ou 12 semanas completas em comparação com o mesmo número de semanas anteriores. Também retorna novas avaliações, ações em todos os canais, um ranking por cliente e detalhamentos ordenados. Cada número vem de uma plataforma, e null significa não informado ou histórico insuficiente, nunca zero.

get/api/v1/analytics/funnel
analytics:read
Parâmetros de consulta
clientIdstringopcional
Limita a um cliente. Omita para gerar o relatório de todos os clientes que sua chave pode ler.
weeksinteger (4 | 12)opcional
Quantas semanas completas o período abrange: 4 ou 12. Padrão: 12.
Resposta
dataobjectopcional
weeksinteger (4 | 12)opcional
periodobjectopcional
O período do relatório, de segunda a domingo, como datas YYYY-MM-DD.
startstringopcional
endstringopcional
previousPeriodobjectopcional
startstringopcional
endstringopcional
weekStartsarray of stringopcional
scopeobjectopcional
clientIdstringopcional
clientNamestringopcional
clientsnumberopcional
foodbooleanopcional
channelsarray of objectopcional
keystring (profile | website | search | social | invites)opcional
O canal: profile, website, search, social ou invites.
periodobjectopcional
O período próprio deste canal, de segunda a domingo, presente quando termina antes do período do relatório (os dados do Search Console chegam com atraso).
startstringopcional
endstringopcional
availablebooleanopcional
Se este canal tem números para exibir.
reasonstring (not_connected | no_data | denied)opcional
Por que o canal não tem números: not_connected (nenhum cliente no escopo tem a fonte conectada), no_data (conectada, mas nada informado no período ainda) ou denied (seu acesso não inclui este canal).
coverageobjectopcional
Quais clientes os números do canal cobrem: clientes que o informam (clients), dos clientes no escopo (of), quantos precisam ser reconectados (reconnect), quantos ficam fora da variação (leftOut), a última semana com dados (through) e as plataformas por trás dos números (providers).
clientsnumberopcional
ofnumberopcional
reconnectnumberopcional
leftOutnumberopcional
throughstringopcional
providersarray of stringopcional
metricsarray of objectopcional
keystringopcional
A métrica, por exemplo profileViews, visits ou searchClicks.
currentnumberopcional
O total deste período em todos os clientes que o informam. Null quando ninguém o informou.
previousnumberopcional
O total do período anterior nos clientes comparáveis. Null quando não há histórico suficiente.
changenumberopcional
Variação em relação ao período anterior nos clientes comparáveis (0.12 = +12%). Null quando previous é null ou 0.
seriesarray of numberopcional
Os valores deste período, um por semana, do mais antigo ao mais recente. Null em uma semana que ninguém informou.
rateBasenumberopcional
O denominador da taxa desta etapa quando não é o valor da etapa anterior. Por exemplo, os eventos principais do site vêm apenas do GA4, então a taxa deles é calculada apenas sobre as visitas do GA4.
reviewsobjectopcional
Novas avaliações públicas no período: quantidade, variação, série semanal, nota média, respostas e distribuição de estrelas.
availablebooleanopcional
reasonstringopcional
currentnumberopcional
previousnumberopcional
changenumberopcional
seriesarray of numberopcional
avgRatingnumberopcional
previousAvgRatingnumberopcional
repliednumberopcional
starsarray of numberopcional
actionsobjectopcional
Ações em Business Profile, site, redes sociais e convites de avaliação, contadas por ação, não por pessoa. Os cliques da pesquisa do Google não estão incluídos: eles já estão nas visitas ao site.
currentnumberopcional
previousnumberopcional
changenumberopcional
seriesarray of numberopcional
excludedFromChangearray of stringopcional
byClientarray of objectopcional
Uma linha por cliente com algum número, para classificar os clientes. Vazio em um relatório de um único cliente.
clientIdstringopcional
publicIdstringopcional
namestringopcional
actionsnumberopcional
previousnumberopcional
changenumberopcional
topChannelstringopcional
channelsarray of stringopcional
detailsarray of objectopcional
keystring (listingPlatforms | websiteSources | landingPages | goals | events | queries | searchPages | socialPlatforms | reviewPlatforms)opcional
availablebooleanopcional
totalnumberopcional
providersarray of stringopcional
rowsarray of objectopcional
keystringopcional
valuesobjectopcional
kindstringopcional
countedbooleanopcional
providerstringopcional
notRankedbooleanopcional
lastSyncedAtstringopcional
generatedAtstringopcional
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
404O recurso não foi encontrado, ou não pertence à sua agência.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/analytics/funnel
Sua chave de API
clientId
weeks
{}

Guias que usam este recurso