Growth
Configuração de concorrentes
Ler a configuração
"Você" (sua empresa) e os concorrentes configurados (até 5): chave, nome, CNPJ, domínio, se o site já foi lido (site_context.read) e o perfil de cada rede (linkedin, instagram, meta, google_ads, maps, facebook, youtube, tiktok) com status confirmed (em uso na coleta), suggested (encontrado, aguardando confirmação) ou absent. É configuração, não dado de execução: os números ficam em GET /api/v1/growth/data?modules=competitors.
Grátis (não consome créditos). Exige o módulo Growth ativo no workspace. Mesmo núcleo da tela Growth > Concorrentes e das tools MCP tamz_growth_competitors_config*.
Rate limit: 60 req/min
Testar ao vivo
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/competitors/config' \
-H 'Authorization: Bearer tamz_SUA_API_KEY'Exemplo de retorno
{
"data": {
"max_competitors": 0,
"self": {
"key": "string",
"name": "string",
"domain": "string",
"cnpj": "string",
"is_self": true,
"site_context": {
"read": true,
"status": "queued",
"updated_at": "string"
},
"profiles": {
"linkedin": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"instagram": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"meta": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"google_ads": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"maps": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"facebook": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"youtube": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"tiktok": {
"status": "confirmed",
"value": "string",
"url": "string"
}
}
},
"competitors": [
{
"key": "string",
"name": "string",
"domain": "string",
"cnpj": "string",
"is_self": true,
"site_context": {
"read": true,
"status": "queued",
"updated_at": "string"
},
"profiles": {
"linkedin": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"instagram": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"meta": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"google_ads": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"maps": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"facebook": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"youtube": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"tiktok": {
"status": "confirmed",
"value": "string",
"url": "string"
}
}
}
]
}
}{
"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
Incluir concorrente
Inclui um concorrente por name, domain (site) ou cnpj (pelo menos um). Só cnpj: nome e site vêm do cadastro da empresa. Só domain: a empresa dona do domínio, quando o casamento é único; senão o próprio domínio vira o nome. Os dados do concorrente novo só aparecem depois de uma execução completa do Growth.
Grátis (não consome créditos). Exige o módulo Growth ativo no workspace. A mudança vale a partir da próxima execução do Growth; não inicia execução. Mesmo núcleo da tela Growth > Concorrentes e das tools MCP tamz_growth_competitors_config*.
Rate limit: 30 req/min (escritas)
Testar ao vivo
Autorização
Sua API key, gerada em /developer/api-keys. Gratuita para começar.
Sua requisição
curl -X POST 'https://tamz.ai/api/v1/growth/competitors/config' \
-H 'Authorization: Bearer tamz_SUA_API_KEY' \
-H 'Content-Type: application/json' \
-d '{}'Corpo da requisição
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Exemplo de retorno
{
"data": {
"max_competitors": 0,
"self": {
"key": "string",
"name": "string",
"domain": "string",
"cnpj": "string",
"is_self": true,
"site_context": {
"read": true,
"status": "queued",
"updated_at": "string"
},
"profiles": {
"linkedin": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"instagram": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"meta": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"google_ads": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"maps": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"facebook": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"youtube": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"tiktok": {
"status": "confirmed",
"value": "string",
"url": "string"
}
}
},
"competitors": [
{
"key": "string",
"name": "string",
"domain": "string",
"cnpj": "string",
"is_self": true,
"site_context": {
"read": true,
"status": "queued",
"updated_at": "string"
},
"profiles": {
"linkedin": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"instagram": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"meta": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"google_ads": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"maps": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"facebook": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"youtube": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"tiktok": {
"status": "confirmed",
"value": "string",
"url": "string"
}
}
}
]
},
"meta": {
"key": "string"
}
}{
"error": {
"code": "INVALID_PARAMS",
"message": "CNPJ inválido"
}
}{
"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": "CNPJ_NOT_FOUND",
"message": "CNPJ não encontrado na base. Envie também o name (e o domain, se tiver)."
}
}{
"error": {
"code": "COMPETITOR_LIMIT_REACHED",
"message": "Limite de 5 concorrentes atingido. Remova um antes de incluir outro."
}
}{
"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
application/json
application/json
Editar perfis
Edita os perfis de um alvo, inclusive self. Cada rede aceita o link do perfil ou o @ da conta; null (ou "") limpa ("não é esse"). Toda rede enviada fica travada: a busca automática não mexe mais nela. Para confirmar um perfil suggested, envie o valor dele. google_ads e maps a execução resolve sozinha (não editáveis). Para trocar o site de um concorrente, remova e inclua de novo.
Grátis (não consome créditos). Exige o módulo Growth ativo no workspace. A mudança vale a partir da próxima execução do Growth; não inicia execução. Mesmo núcleo da tela Growth > Concorrentes e das tools MCP tamz_growth_competitors_config*.
Rate limit: 30 req/min (escritas)
Testar ao vivo
Parâmetros
Chave do alvo devolvida pelo GET: self (sua empresa), o domínio (ex.: concorrente.com.br) ou name:<slug> para concorrente sem site (use encodeURIComponent, ex.: name%3Aacme).
Autorização
Sua API key, gerada em /developer/api-keys. Gratuita para começar.
Sua requisição
curl -X PATCH 'https://tamz.ai/api/v1/growth/competitors/config/{key}' \
-H 'Authorization: Bearer tamz_SUA_API_KEY' \
-H 'Content-Type: application/json' \
-d '{}'Corpo da requisição
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Exemplo de retorno
{
"data": {
"max_competitors": 0,
"self": {
"key": "string",
"name": "string",
"domain": "string",
"cnpj": "string",
"is_self": true,
"site_context": {
"read": true,
"status": "queued",
"updated_at": "string"
},
"profiles": {
"linkedin": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"instagram": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"meta": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"google_ads": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"maps": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"facebook": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"youtube": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"tiktok": {
"status": "confirmed",
"value": "string",
"url": "string"
}
}
},
"competitors": [
{
"key": "string",
"name": "string",
"domain": "string",
"cnpj": "string",
"is_self": true,
"site_context": {
"read": true,
"status": "queued",
"updated_at": "string"
},
"profiles": {
"linkedin": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"instagram": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"meta": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"google_ads": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"maps": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"facebook": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"youtube": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"tiktok": {
"status": "confirmed",
"value": "string",
"url": "string"
}
}
}
]
},
"meta": {
"key": "string"
}
}{
"error": {
"code": "INVALID_PROFILE",
"message": "Perfil inválido em instagram: envie o link do perfil ou o @ da conta."
}
}{
"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": "TARGET_NOT_FOUND",
"message": "Concorrente não encontrado neste workspace."
}
}{
"error": {
"code": "CONFIG_UNREADABLE",
"message": "A lista de concorrentes salva está ilegível; nada foi alterado. Fale com o suporte."
}
}{
"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
application/json
application/json
Remover concorrente
Remove o concorrente da lista e o histórico coletado dele (como remover na tela). self não pode ser removido.
Grátis (não consome créditos). Exige o módulo Growth ativo no workspace. A mudança vale a partir da próxima execução do Growth; não inicia execução. Mesmo núcleo da tela Growth > Concorrentes e das tools MCP tamz_growth_competitors_config*.
Rate limit: 30 req/min (escritas)
Testar ao vivo
Parâmetros
Chave do alvo devolvida pelo GET: self (sua empresa), o domínio (ex.: concorrente.com.br) ou name:<slug> para concorrente sem site (use encodeURIComponent, ex.: name%3Aacme).
Autorização
Sua API key, gerada em /developer/api-keys. Gratuita para começar.
Sua requisição
curl -X DELETE 'https://tamz.ai/api/v1/growth/competitors/config/{key}' \
-H 'Authorization: Bearer tamz_SUA_API_KEY'Exemplo de retorno
{
"data": {
"max_competitors": 0,
"self": {
"key": "string",
"name": "string",
"domain": "string",
"cnpj": "string",
"is_self": true,
"site_context": {
"read": true,
"status": "queued",
"updated_at": "string"
},
"profiles": {
"linkedin": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"instagram": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"meta": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"google_ads": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"maps": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"facebook": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"youtube": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"tiktok": {
"status": "confirmed",
"value": "string",
"url": "string"
}
}
},
"competitors": [
{
"key": "string",
"name": "string",
"domain": "string",
"cnpj": "string",
"is_self": true,
"site_context": {
"read": true,
"status": "queued",
"updated_at": "string"
},
"profiles": {
"linkedin": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"instagram": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"meta": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"google_ads": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"maps": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"facebook": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"youtube": {
"status": "confirmed",
"value": "string",
"url": "string"
},
"tiktok": {
"status": "confirmed",
"value": "string",
"url": "string"
}
}
}
]
},
"meta": {
"key": "string"
}
}{
"error": {
"code": "INVALID_KEY",
"message": "Invalid competitor key"
}
}{
"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": "TARGET_NOT_FOUND",
"message": "Concorrente não encontrado neste workspace."
}
}{
"error": {
"code": "SELF_NOT_REMOVABLE",
"message": "O \"Você\" (sua empresa) não pode ser removido."
}
}{
"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
application/json
application/json