Growth
Dados e histórico
Retrato atual dos módulos pedidos e o log da janela de days dias: as execuções do período (runs: data, status, módulo e créditos reservados/cobrados) e, por módulo, a série diária (history): seguidores e avaliação por concorrente e rede (competitors), anúncios ativos por concorrente e canal (ads), notas do site por página e dispositivo (performance), participação nas IAs por IA (ai_visibility) e ideias criadas por dia (inspirations). overview, keywords e changes só têm o retrato (history: null).
Granularidade diária: duas execuções no mesmo dia viram um ponto. Na série de IA, cada IA conta só as respostas do próprio dia (o retrato junta a IA semanal dos 7 dias anteriores). changes segue since_runs, não a janela.
Execução: run mostra a execução em andamento (ou a última), com as etapas, remaining_seconds e stale (travada: um novo disparo a fecha e cria outra); run_options mostra o preço fixo da execução completa e de cada módulo e se os módulos já estão liberados (modules_ready). Acompanhe um disparo de POST /api/v1/growth/run por aqui, nunca disparando de novo, salvo com run.stale: true.
Módulo não pedido não vem na resposta; bloco cuja leitura falhou vem null e aparece em meta.partial_failures (os outros seguem); se tudo o que foi pedido falhar, 503. A janela days conta em dias de Brasília, incluindo hoje.
Módulos (modules) — cada um vem como { latest, history } em data.<módulo>:
| Módulo | O que traz | Parâmetros |
|---|---|---|
overview | Diagnóstico contra os concorrentes (pontos fortes, fracos e ações priorizadas, com code estável), notas do site, participação nas IAs, as 5 maiores oportunidades de palavra-chave e a última execução | — |
competitors | Você e os concorrentes: seguidores, anúncios ativos, avaliação e matriz de features; série diária de seguidores e avaliação por rede | — |
ads | Anúncios ativos por concorrente e canal, com o texto; série diária por canal | — |
keywords | Palavras-chave suas e dos concorrentes por zona: opportunity (relevantes, buscas a partir da mediana, CPC até a mediana, concorrência baixa ou média, em que você não aparece; ordenadas por score 0–100), gap (só os concorrentes usam), relevant, all | keyword_zone, keyword_limit |
inspirations | Ideias de conteúdo (gancho, estrutura, formato, CTA e post de referência), os posts de referência e os temas da busca; ideias criadas por dia | — |
performance | Notas por página e o plano de ação do site no formato da tela; série diária por página e dispositivo | strategy |
ai_visibility | Participação nas IAs por IA e a matriz empresa × IA; trechos das respostas (até 50) só com include_excerpts | include_excerpts |
changes | Novidades das últimas N execuções (só leitura: não marca como lidas) | since_runs |
Substitui os GETs por módulo, obsoletos: /growth → overview, /growth/competitors → competitors, /growth/keywords → keywords (zone/limit viram keyword_zone/keyword_limit), /growth/performance → performance, /growth/ai-visibility → ai_visibility (excerpts vira include_excerpts), /growth/content-ideas → inspirations, /growth/changes → changes.
Grátis (não consome créditos) e só leitura. Exige o módulo Growth ativo no workspace.
Rate limit: 60 req/min
Testar ao vivo
Parâmetros
all (padrão) ou lista separada por vírgula de: overview, competitors, ads, keywords, inspirations, performance, ai_visibility, changes. O que cada um traz está na tabela da descrição.
Janela do log, em dias de Brasília incluindo hoje (1–90)
Zona das palavras-chave do módulo keywords: opportunity, gap, relevant ou all
Teto de palavras-chave do módulo keywords
Dispositivo do retrato do módulo performance (a série traz os dois)
Trechos das respostas das IAs no módulo ai_visibility (até 50)
Novidades das últimas N execuções no módulo changes
Autorização
Sua API key, gerada em /developer/api-keys. Gratuita para começar.
Sua requisição
curl -X GET 'https://tamz.ai/api/v1/growth/data' \
-H 'Authorization: Bearer tamz_SUA_API_KEY'Exemplo de retorno
{
"data": {
"run": {
"id": "string",
"trigger": "manual",
"status": "queued",
"module": "full",
"created_at": "string",
"started_at": "string",
"finished_at": "string",
"steps": [
{
"key": "sites",
"status": "pending",
"progress": {
"done": 0,
"total": 0
}
}
],
"remaining_seconds": 0,
"stale": true
},
"run_options": {
"full": 0,
"modules": {
"competitors": 0,
"ads": 0,
"keywords": 0,
"inspirations": 0,
"performance": 0,
"ai_visibility": 0
},
"modules_ready": true
},
"runs": [
{
"id": "string",
"created_at": "string",
"finished_at": "string",
"status": "queued",
"module": "full",
"credits_reserved": 0,
"credits_charged": 0
}
],
"overview": {
"latest": {
"diagnosis": {
"strengths": [
{
"axis": "string",
"code": "string",
"self": 0,
"leader": 0,
"leader_name": "string",
"values": {
"property1": "string",
"property2": "string"
}
}
],
"weaknesses": [
{
"axis": "string",
"code": "string",
"self": 0,
"leader": 0,
"leader_name": "string",
"values": {
"property1": "string",
"property2": "string"
}
}
],
"actions": [
{
"axis": "string",
"code": "string",
"self": 0,
"leader": 0,
"leader_name": "string",
"values": {
"property1": "string",
"property2": "string"
}
}
],
"narrative": [
"string"
],
"generated_at": "string"
},
"site_scores": {
"mobile": {
"performance": 0,
"seo": 0,
"accessibility": 0,
"best_practices": 0
},
"desktop": {
"performance": 0,
"seo": 0,
"accessibility": 0,
"best_practices": 0
}
},
"ai_share": {
"answered": 0,
"share": 0,
"by_engine": [
{
"engine": "chatgpt",
"label": "string",
"kind": "app",
"answered": 0,
"share": 0,
"avg_position": 0,
"as_source": 0,
"day": "string"
}
]
},
"top_opportunities": [
{
"keyword": "string",
"volume": 0,
"cpc": 0,
"competition": "LOW",
"category": "gap",
"relevance": "relevant",
"opportunity": true,
"score": 0,
"self_position": 0,
"competitors": 0,
"used_by": [
"string"
],
"sources": [
"organic"
],
"first_seen_at": "string"
}
],
"last_run": {
"id": "string",
"trigger": "manual",
"status": "queued",
"created_at": "string",
"started_at": "string",
"finished_at": "string"
}
},
"history": null
},
"competitors": {
"latest": {
"companies": [
{
"key": "string",
"name": "string",
"domain": "string",
"is_self": true,
"summary": "string",
"site_visits": 0,
"linkedin": {
"followers": 0,
"employees": 0
},
"instagram": {
"followers": 0,
"posts": 0
},
"ads_active": {
"meta": 0,
"linkedin": 0,
"google": 0
},
"ads_capped": true,
"maps": {
"rating": 0,
"reviews": 0
}
}
],
"feature_matrix": {
"features": [
"string"
],
"has": {
"property1": [
true
],
"property2": [
true
]
},
"updated_at": "string"
}
},
"history": [
{
"key": "string",
"network": "linkedin",
"metric": "followers",
"points": [
{
"day": "string",
"value": 0
}
]
}
]
},
"ads": {
"latest": {
"total": 0,
"truncated": true,
"ads": [
{
"key": "string",
"channel": "meta",
"text": "string",
"cta": "string",
"link": "string",
"started_at": "string",
"days_active": 0,
"variants": 0
}
]
},
"history": [
{
"key": "string",
"channel": "meta",
"points": [
{
"day": "string",
"active": 0,
"capped": true
}
]
}
]
},
"keywords": {
"latest": {
"zone": "opportunity",
"opportunity_zone": {
"min_volume": 0,
"max_cpc": 0
},
"updated_at": "string",
"total": 0,
"keywords": [
{
"keyword": "string",
"volume": 0,
"cpc": 0,
"competition": "LOW",
"category": "gap",
"relevance": "relevant",
"opportunity": true,
"score": 0,
"self_position": 0,
"competitors": 0,
"used_by": [
"string"
],
"sources": [
"organic"
],
"first_seen_at": "string"
}
]
},
"history": null
},
"inspirations": {
"latest": {
"ideas": [
{
"id": "string",
"batch_id": "string",
"created_at": "string",
"hook": "string",
"structure": [
"string"
],
"format": "carrossel",
"cta": "string",
"reference": {
"url": "string",
"label": "string",
"network": "linkedin"
}
}
],
"references": [
{
"origin": "competitor",
"network": "linkedin",
"label": "string",
"domain": "string",
"url": "string",
"text": "string",
"likes": 0,
"comments": 0,
"views": 0,
"published_at": "string"
}
],
"terms": [
"string"
]
},
"history": [
{
"day": "string",
"value": 0
}
]
},
"performance": {
"latest": {
"strategy": "mobile",
"status": "queued",
"day": "string",
"has_sites": true,
"companies": [
{
"key": "string",
"name": "string",
"domain": "string",
"is_self": true,
"pages": [
{
"path": "string",
"url": "string",
"measured": true,
"scores": {
"performance": 0,
"seo": 0,
"accessibility": 0,
"best_practices": 0
},
"metrics": {
"lab": {
"lcp_ms": 0,
"cls": 0,
"tbt_ms": 0,
"fcp_ms": 0
},
"field": {
"lcp_ms": 0,
"inp_ms": 0,
"cls": 0,
"category": "FAST"
}
}
}
]
}
],
"action_plan": [
{
"id": "string",
"category": "performance",
"title": "string",
"description": "string",
"savings_ms": 0,
"display_value": "string",
"impact": 1,
"difficulty": 1,
"priority": 1,
"pages": [
"string"
],
"rank": -9007199254740991,
"what_to_do": "string",
"estimated_gain": "string",
"impact_level": "high",
"difficulty_level": "high",
"priority_level": "high",
"page_urls": [
{
"path": "string",
"url": "string"
}
]
}
],
"action_plan_by_page": [
{
"path": "string",
"url": "string",
"label": "string",
"actions": [
{
"id": "string",
"category": "performance",
"title": "string",
"description": "string",
"savings_ms": 0,
"display_value": "string",
"impact": 1,
"difficulty": 1,
"priority": 1,
"pages": [
"string"
],
"rank": -9007199254740991,
"what_to_do": "string",
"estimated_gain": "string",
"impact_level": "high",
"difficulty_level": "high",
"priority_level": "high",
"page_urls": [
{
"path": "string",
"url": "string"
}
]
}
]
}
],
"fix_prompt": "string"
},
"history": [
{
"key": "string",
"device": "mobile",
"path": "string",
"points": [
{
"day": "string",
"performance": 0,
"seo": 0,
"accessibility": 0
}
]
}
]
},
"ai_visibility": {
"latest": {
"status": "queued",
"day": "string",
"answered": 0,
"questions": [
"string"
],
"by_engine": [
{
"engine": "chatgpt",
"label": "string",
"kind": "app",
"answered": 0,
"share": 0,
"avg_position": 0,
"as_source": 0,
"day": "string"
}
],
"matrix": {
"engines": [
"chatgpt"
],
"companies": [
{
"key": "string",
"name": "string",
"domain": "string",
"is_self": true,
"share": 0,
"by_engine": {
"property1": 0,
"property2": 0
}
}
]
},
"answers": [
{
"question": "string",
"engine": "chatgpt",
"kind": "app",
"day": "string",
"excerpt": "string",
"mentions": [
{
"key": "string",
"position": 0,
"in_sources": true
}
]
}
]
},
"history": [
{
"engine": "chatgpt",
"label": "string",
"points": [
{
"day": "string",
"answered": 0,
"share": 0
}
]
}
]
},
"changes": {
"latest": {
"since_runs": 0,
"runs": [
{
"id": "string",
"run_at": "string"
}
],
"events": [
{
"id": "string",
"run_id": "string",
"run_at": "string",
"kind": "concorrente",
"key": "string",
"title": "string",
"body": "string",
"link": "string",
"created_at": "string",
"read": true
}
],
"truncated": true
},
"history": null
}
},
"meta": {
"run_id": "string",
"run_status": "queued",
"finished_at": "string",
"days": -9007199254740991,
"since": "string",
"partial_failures": [
"string"
]
}
}{
"error": {
"code": "INVALID_PARAMS",
"message": "Invalid parameters"
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Missing API key. Use Authorization: Bearer tamz_xxx or X-API-Key header"
}
}{
"error": {
"code": "MODULE_NOT_ENABLED",
"message": "O módulo Growth não está ativo neste workspace."
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded",
"retry_after": 42
}
}{
"error": {
"code": "SERVICE_UNAVAILABLE",
"message": "Service temporarily unavailable"
}
}Respostas e códigos
Response Body
application/json
application/json
application/json
application/json
application/json
application/json