API de SEO
A API de SEO do Screpy é uma API REST para levar dados de projetos, rastreamentos, Rank Tracker, AI Visibility armazenada, páginas, monitoramento e oportunidades para seus próprios produtos, painéis e automações. Use respostas JSON estruturadas para criar fluxos de SEO com os dados que sua conta Screpy pode acessar.
Autentique a SEO API
Crie uma chave REST em Configurações → Aplicativos conectados e envie-a como token bearer pelo seu servidor. Escolha as permissões necessárias para a integração.
- Chaves somente leitura obtêm dados; chaves de leitura e escrita também permitem alterações compatíveis.
- Copie o segredo ao criá-lo: ele aparece uma única vez. Não o exponha em código público do navegador.
- Revogue chaves em Aplicativos conectados. São permitidas até 20 chaves ativas, com validade de um ano.
/projectsJSONAuthorization: Bearer
••••••••••••••••••••••••Verifique o acesso API
REST exige uma conta de membro paga. A participação no projeto e sua elegibilidade para cada recurso também determinam os registros e ações disponíveis.
- Endpoints de conta mostram seu plano, recursos e quantidade de projetos acessíveis.
- Relatórios de uso incluem limites dos recursos, mas valores usados e restantes são calculados atualmente apenas para projetos próprios.
- Valores de uso null estão indisponíveis; não significam consumo zero.
/projects200{
"data": [
{ "domain": "example.com" }
]
}Gerencie projetos SEO
Liste projetos próprios e compartilhados, obtenha uma visão geral ou crie projetos dentro da sua cota de projetos próprios. Use os UIDs retornados nas próximas requisições.
- Atualize nomes, preferências de mercado e fuso horário e configurações de rastreamento ou monitoramento compatíveis.
- Mudar o domínio exige um novo projeto; alterar configurações não reescreve resultados concluídos.
- A criação verifica a capacidade e valida o site.
- A exclusão é restrita ao proprietário do projeto.
Inicie rastreamentos do site
Inicie um rastreamento com acesso de escrita e guarde seu UID. Ele roda em segundo plano: acompanhe o status antes de obter os resultados.
- Um rastreamento em andamento ou o rastreador desativado pode impedir um novo início.
- Resumos e conjuntos de dados exigem um rastreamento concluído com sucesso; resultados inacabados retornam conflito.
- Mantenha referências de projeto e rastreamento juntas ao relatar ou comparar registros de um momento específico.
- 1RevisãoAberto
/guides - 2GeradoAberto
/shop - ConcluídoPendente
example.com
Obtenha dados de rastreamento SEO
Crie relatórios de SEO técnico a partir de um rastreamento concluído selecionado. Consulte detalhes das páginas e encontre as páginas de origem dos links e imagens.
- As páginas incluem status HTTP, títulos, descrições, cabeçalhos, canonicals, profundidade de rastreamento e tempos.
- Registros de links mostram destinos, textos âncora, status nofollow e contexto da página de origem.
- Registros de imagens incluem texto alternativo, dimensões, status de obtenção e páginas de origem.
- Use filtros de campos compatíveis e registros paginados; não é uma exportação completa de HTML nem uma interface SQL.
/guides/seo200
Compare projetos e rastreamentos
Compare resumos de SEO técnico entre projetos ou registros de rastreamentos concluídos. Guarde referências explícitas para reproduzir comparações.
- Comparações aceitam de dois a cinco projetos acessíveis, com os últimos rastreamentos concluídos ou registros selecionados.
- Comparar dois rastreamentos retorna mudanças de saúde, páginas e problemas como segundo valor menos primeiro.
- São comparações de resumos; obtenha registros de rastreamento separadamente para investigar URLs individuais.
Obtenha SEO Quick Wins
Leve oportunidades priorizadas ao seu fluxo com fonte e período do relatório. Uma referência de rastreamento concluído verifica o acesso, mas não transforma toda oportunidade em registro daquele rastreamento.
- Com dados conectados disponíveis, Search Console oferece oportunidades sobre consultas próximas das primeiras posições, CTR, canibalização, quedas e mudanças de visibilidade.
- Achados de links internos podem usar o rastreamento mais recente do projeto, identificado nos metadados.
- Achados derivados do tráfego exigem a conexão correspondente, permissões e dados suficientes.
- Preserve tipos de relatório, datas, avisos e disponibilidade; um relatório vazio não prova ausência de problemas.
linen shirt#11
Impressões
2.860Gerencie o acompanhamento de posições
Leia visibilidade de palavras-chave, histórico de análises e resultados armazenados com seu mercado e dispositivo. Gerencie as palavras acompanhadas em vez de solicitar buscas arbitrárias ao vivo.
- Filtre palavras por busca, dispositivo e segmento baseado em URL, incluindo palavras sem correspondência.
- Adicione até 100 palavras por requisição; a análise inicial entra na fila, sem resultado imediato.
- Exclua palavras acompanhadas e visualize, crie, atualize ou remova segmentos com acesso de escrita.
- REST não oferece SERP ao vivo, nova análise manual nem exportação CSV/XLSX do Rank Tracker.
Classificações
+24 Posição
Acesse AI Visibility
Relacione respostas de IA armazenadas a menções da marca, citações e evidências das fontes. Preserve prompt, país, idioma e plataforma nos seus relatórios.
- Leia visões gerais, menções, respostas, citações, prompts acompanhados e atividade de domínios ou URLs de origem.
- Adicione até 20 prompts por requisição dentro da capacidade do projeto ou remova prompts acompanhados com acesso de escrita.
- Sugestões de prompts, nova análise manual e exportações AI Visibility não são operações REST.
example.com [1]
example.org [2]
example.org/guidesexample.net/researchAnalise backlinks
Consulte o perfil de backlinks de um projeto ou de um concorrente já adicionado, escolhido nas opções disponíveis. Relacione links aos domínios de referência para seus relatórios de autoridade.
- Obtenha métricas gerais, domínios de referência e backlinks de um domínio selecionado.
- Examine lacunas de backlinks e conjuntos compatíveis de domínios perdidos ou com links quebrados.
- Preserve alvo, filtros, ordenação e cursor; não é uma consulta irrestrita de qualquer domínio.
- Exportações CSV/XLSX de tabelas cobrem a página atual. Continue usando X-Next-Cursor.
- example.org
- example.net
- example.edu
Gerencie registros disavow
Guarde entradas revisadas de domínios ou URLs com notas no projeto e prepare um arquivo de texto no formato Google. As decisões de rejeição são suas.
- O acesso de escrita permite adicionar até 100 entradas por requisição ou excluir registros existentes.
- Exporte o texto disavow do projeto separadamente das tabelas paginadas.
- Revise e envie o arquivo manualmente; salvar um registro não o envia ao Google nem remove um backlink.
disavow.txtRevisãodomain:example.org
https://example.net/links- Domínioexample.org
- URLexample.net/links
Consulte a saúde do site
Separe desempenho das páginas e disponibilidade do site nos relatórios. Estes endpoints retornam verificações existentes, não uma nova medição sob demanda.
- Desempenho retorna a última página inicial verificada com FCP, LCP, CLS, TTFB, TBT e Speed Index, não todas as páginas nem um histórico completo.
- Uptime resume os últimos 30 dias e retorna até as 160 verificações mais recentes com status, tempo de resposta e data.
- Sem desempenho, retorna data:null; sem verificações uptime, os valores do resumo ficam null e a lista vazia.
example.comLaboratório
LCP2,1 s
TBT180 ms
CLS0,04
Pagine os dados SEO
Obtenha grandes conjuntos em páginas gerenciáveis e preserve o contexto da requisição no processamento. Verifique a disponibilidade antes de transformar respostas em métricas.
- Listas compatíveis retornam 50 registros por padrão e até 100; siga links de continuação ou cursores opacos.
- Mantenha filtros, alvos e períodos consistentes entre páginas. Parâmetros inválidos são rejeitados.
- Trate explicitamente erros de autorização, rastreamento inacabado, dados indisponíveis e limite de requisições, sem substituir resultados ausentes por zero.
Converse sobre API de SEO. Com SEO MCP.
Conecte seu assistente ao projeto Screpy via SEO MCP. Escolha um projeto, revise seu resumo e investigue dados compatíveis de rastreamento, posições e busca com acesso delimitado.
- Screpy: Olá! Vamos analisar API de SEO para example.com. O que você quer saber?
- Você: Liste meus projetos Screpy e abra o resumo de example.com.
- Screpy: Escolha example.com e confira o último rastreamento concluído e os dados disponíveis. O assistente só acessa projetos que sua conta Screpy pode acessar. Contexto do projeto: Projeto: example.com. Rastreamento: Última execução concluída.
- Você: Transforme isso em um breve plano de ação.
- Screpy: Vou separar os resultados das recomendações. Revise as evidências, escolha uma mudança e confira os resultados depois. Seus próximos passos: Revise: Confira a fonte e a data de cada resultado.. Decida: Escolha a primeira mudança.. Verifique: Compare os resultados após a mudança..
- Você: Você pode explicar as evidências em linguagem simples?
- Screpy: Sim. Pergunte sobre um resultado compatível e explicarei o que mostra, de onde vem e o que continua incerto. Dados ausentes continuam indisponíveis; recomendações não são correções automáticas.
Perguntas sobre a API de SEO.
Saiba como a API REST do Screpy autentica solicitações, delimita projetos e rastreamentos e expõe dados para produtos e automações de SEO personalizados.
Posso usar a AI Visibility pela API?
Sim. A API lê dados armazenados de resumo, menções, respostas, citações, prompts e fontes e pode adicionar ou excluir logicamente prompts rastreados. As exportações CSV e Excel continuam exclusivas do painel; sugestões e nova análise manual não estão disponíveis na API.
Posso gerenciar o Rank Tracker pela API?
Sim. A API oferece resumo do Rank Tracker, listagem e gerenciamento de palavras-chave, histórico e resultados armazenados e visualização ou gerenciamento de segmentos. Não oferece exportação CSV/XLSX, consulta SERP ao vivo nem nova análise manual.
Quais dados a API de SEO do Screpy pode retornar?
Para um rastreamento concluído selecionado, a API REST pode retornar páginas, links, imagens, resultados on-page e Quick Wins. Mantenha o escopo do projeto e do rastreamento unido ao criar relatórios ou automações.
Posso obter Core Web Vitals e disponibilidade pela API?
Sim. Core Web Vitals e disponibilidade são expostos por endpoints de saúde separados porque são sinais diferentes. Uma resposta data: null pode indicar que ainda não há uma verificação correspondente disponível.
Qual é a diferença entre a API de SEO do Screpy e o SEO MCP?
A API de SEO do Screpy é uma API REST para produtos, painéis e automações personalizados, autenticada com uma chave REST. O Screpy SEO MCP expõe ferramentas estruturadas do Screpy a assistentes de IA compatíveis por OAuth e pelo Model Context Protocol.
Quem pode usar a API de SEO do Screpy?
A API REST do Screpy está disponível para contas de membros pagantes. Cada solicitação verifica a elegibilidade, os limites de recursos e o acesso ao projeto solicitado.
Como crio uma chave da API de SEO do Screpy?
Crie uma chave de API REST em Configurações → Aplicativos conectados e envie-a como token Bearer em cada solicitação. As credenciais OAuth do MCP não autenticam a API REST do Screpy.
A API de SEO do Screpy pode comparar rastreamentos?
Sim. A API de comparações aceita duas referências de rastreamentos concluídos e retorna uma comparação estruturada para investigar mudanças entre as referências.
Como encontro um UID de projeto e um UID de rastreamento?
Comece com GET /projects para listar os projetos disponíveis para a chave. Use o UID do projeto selecionado com sua lista de rastreamentos, que retorna o UID para solicitações de dados específicas.