Vista Social API

A Vista Social API permite ler e gravar dados do Vista Social a partir dos seus próprios sistemas. Leve as análises de perfis e publicações para uma ferramenta de BI, envie rascunhos a partir do lugar onde a sua equipe já planeja o conteúdo, gerencie a comunidade em um console personalizado ou conecte o Vista Social a um fluxo de trabalho interno.

A referência completa, com todos os endpoints, todos os campos e exemplos prontos para copiar e colar, está em vistasocial.com/api-docs.

Disponibilidade: a API está incluída nos planos Enterprise e no add-on de API. Se o seu plano não inclui a API, fale com o seu Customer Success Manager e nós a ativamos para você.

Esta API substitui a Vista Social API 1.0. A API 2.0 é a API REST atual e documentada. Se você ainda usa a API 1.0, migre agora. Todo o uso restante da 1.0 precisa migrar para a 2.0 até 1º de novembro de 2026. O endereço anterior da documentação, apidocs.vistasocial.com, agora redireciona para cá.

Resumo rápido

• URL base: https://api.vistasocial.com
• Todos os endpoints são POST com corpo JSON. Não há parâmetros de caminho nem query strings para montar.
• Autentique-se com a chave de API do seu workspace no cabeçalho x-api-key.
• 76 endpoints que cobrem publicação, análises, inbox, tarefas, tendências, gerenciamento de equipe e Vista Pages.
• Todas as respostas usam o mesmo envelope, então o tratamento de erros é escrito uma única vez.

Como obter a sua chave de API

1. Acesse Settings → Integrations no Vista Social.
2. Encontre o card Vista Social API e gere uma chave.
3. Guarde a chave em um lugar seguro. Gerar uma nova chave desativa a anterior.

Só os gerentes da conta podem gerar uma chave de API. A chave vale para todo o workspace, então ela pode ver e alterar tudo o que o workspace pode. Trate a chave como uma senha: mantenha-a no servidor e nunca a inclua em um app móvel ou no código do navegador.

A sua primeira chamada

POST /v2/me confirma a qual conta a chave pertence. É o jeito mais rápido de comprovar que a configuração funciona.

curl -X POST https://api.vistasocial.com/v2/me \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

{
  "ok": true,
  "data": {
    "name": "Jordan Reyes",
    "email": "jordan@example.com"
  }
}

A partir daí, o POST /v2/profiles/search retorna os IDs dos perfis que a maioria dos outros endpoints usa como entrada.

O que você pode fazer

Leitura de dados

Os endpoints de análises retornam os mesmos números do Social Media Performance Report e do Post Performance Report, então um painel personalizado e o relatório do app sempre batem.

POST /v2/reports/profile-metrics é o endpoint principal. Informe os IDs dos perfis e um período, e ele retorna seguidores, alcance, impressões e engajamento diários:

curl -X POST https://api.vistasocial.com/v2/reports/profile-metrics \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "profile_ids": [12345], "from_date": "2026-06-01", "to_date": "2026-06-30" }'

As linhas voltam em formato de colunas (um array columns mais um array rows ) com um bloco summary de totais, o que deixa respostas de períodos longos pequenas o bastante para trafegar rápido.

Gravação de dados

POST /v2/posts/save cria rascunhos, agenda ou edita uma publicação em um ou mais perfis. POST /v2/media/create envia imagens, vídeos e GIFs para a sua biblioteca. POST /v2/ideas/save e POST /v2/calendar/notes/create cuidam da parte de planejamento. Ações no inbox, atualizações de tarefas e o gerenciamento de membros da equipe também podem ser gravados.

Formato das respostas

Sucesso:

{ "ok": true, "data": { } }

Falha:

{ "ok": false, "error": { "code": "unauthorized", "message": "Invalid API key" } }

Confira o campo ok antes de ler data. Uma chamada com falha também retorna códigos de status HTTP, então você pode tratar qualquer um dos dois.

Limites de requisições

A API permite 60 requisições por minuto por integração. Todas as respostas trazem X-RateLimit-Limit, X-RateLimit-Remaining e X-RateLimit-Reset para você saber sempre em que ponto está, e um 429 volta com Retry-After.

Workspaces Enterprise podem ter o limite aumentado. Confira Como funcionam os limites de requisições da Vista Social API para ver todos os detalhes.

Vai conectar um assistente de IA? Use o MCP

Se o seu objetivo é deixar o Claude, o ChatGPT ou o Cursor trabalharem dentro do Vista Social, provavelmente você nem precisa escrever código REST. O nosso servidor MCP oferece esses mesmos recursos como ferramentas que o assistente encontra e usa sozinho.

Confira Como conectar o seu assistente de IA ao Vista Social.

Para automações sem código, as integrações com Zapier, Make e n8n cobrem os gatilhos e ações mais comuns sem nenhum trabalho com a API.

Ideias para se inspirar

• Painéis de bastidores. Um festival de música puxa o engajamento das publicações dos artistas a cada poucos minutos e mostra os dados em telas para a equipe.
• Relatórios com a identidade da marca. Uma agência coleta dados de perfis e publicações e monta os relatórios no próprio modelo, em vez de usar o nosso.
• KPIs personalizados. Uma rede de academias combina compartilhamentos, comentários e cliques em uma única pontuação de "engajamento da comunidade" para avaliar o desempenho da equipe.
• Entrega de conteúdo. Uma equipe de marketing escreve os rascunhos na sua ferramenta de projetos e envia para o Vista Social para aprovação e agendamento.
• Alertas de benchmark. Uma marca puxa os benchmarks do setor toda semana e avisa no Slack quando o seu percentil de engajamento cai.

O que a API não cobre

• Relatórios de anúncios pagos. Você pode listar as configurações de impulsionamento de um perfil, mas o investimento e o desempenho dos anúncios não ficam disponíveis.
• Relatórios de análise de concorrentes.
• Cobrança, assinatura e gerenciamento de planos.
• Dados de conteúdo do X (Twitter) além do que os termos da API do X permitem.

Perguntas frequentes

Existe um ambiente de testes (sandbox)?

Não. As chamadas vão direto para o seu workspace real. Teste as gravações em um grupo de perfis que você não usa para publicar ou use o status de rascunho nas publicações.

Posso limitar uma chave a um grupo de perfis?

Por enquanto, não. As chaves dão acesso a todo o workspace. Se você precisa de um acesso mais restrito, rode a integração por uma conta de usuário do Vista Social com permissões limitadas.

Como paginar resultados grandes?

Não existe um padrão único de cursor. A maioria dos endpoints de listagem e busca aceita um limit no corpo, e alguns também aceitam um offset. A referência mostra exatamente quais campos cada um aceita. Quando a resposta inclui um bloco meta, leia os totais nele em vez de contar as linhas recebidas, porque a página retornada costuma ser menor que o total de correspondências.

Na prática, os filtros resolvem mais do que a paginação. Filtrar por perfil, período ou status costuma ser mais rápido do que percorrer um conjunto grande de resultados.

O que aconteceu com a API 1.0?

A API 2.0 substitui completamente a API 1.0. A 1.0 ainda funciona para integrações existentes, mas não é mais publicada nem documentada, e não recebe novidades. Migre para os endpoints deste artigo. Todos os workspaces precisam estar na API 2.0 até 1º de novembro de 2026. Depois dessa data, a 1.0 deixa de ser compatível.

Favoritos que apontam para apidocs.vistasocial.com agora redirecionam para vistasocial.com/api-docs.

A referência está sempre atualizada?

Sim. A especificação em vistasocial.com/api-docs é gerada a partir do catálogo da plataforma em produção a cada versão, então não tem como ficar diferente do que a API realmente faz. O documento OpenAPI bruto está em vistasocial.com/openapi.json se você quiser gerar um cliente.

Precisa de mais ajuda?

Se tiver dúvidas ou precisar de ajuda, é só falar com a nossa incrível equipe de suporte. Estamos aqui para ajudar! 💙