Home » Recursos » API
  • REST Web API
  • JSON
  • Serviço de Relatórios XML
  • Webhooks
  • Pronto para CI/CD

Automatize Cada Parte do Seu Monitoramento com a API Dotcom-Monitor

Crie monitores programaticamente, gerencie dispositivos e tarefas, orquestre testes de carga e transmita dados de desempenho em tempo real para seus próprios dashboards, SIEMs e pipelines de CI/CD — com uma REST Web API documentada e o Serviço de Relatórios XML (XRS).
Inicie Seu Teste GRATUITO de 30 Dias
Agendar uma Demonstração
Three floating dark-mode cards on a deep navy background — a Web API JSON request creating a new HTTPS monitor, an XRS XML response with a timing breakdown, and a live API-surface KPI panel showing requests, devices, locations, sessions, and last deploy.
  • Nenhum cartão de crédito necessário
  • Configuração em menos de 5 minutos
  • Acesso completo à API incluído em todos os planos pagos
  • Suporte especializado 24×7
10.000+

Organizações em Todo o Mundo

99,99%

SLA de Disponibilidade da Plataforma

30+

Locais Globais de Monitoramento

Desde 1998

Líder em Monitoramento de Websites

Monitoramento Programático

O Que é a API Dotcom-Monitor?

A plataforma Dotcom-Monitor é totalmente scriptável. Tudo o que você pode fazer na interface web — desde criar um novo monitor HTTP até gerar um relatório de desempenho de três meses — pode ser feito programaticamente através de dois serviços complementares: a Web API baseada em REST para configuração e o Serviço de Relatórios XML (XRS) para extração de dados em tempo real.

A Web API é uma interface HTTP estruturada, baseada em JSON, que expõe operações de monitoramento e teste de carga para seus próprios sistemas. Use-a para provisionar novos monitores a cada implantação, configurar milhares de dispositivos com infraestrutura como código, integrar o monitoramento nas suas ferramentas de tickets existentes ou incorporar dados de desempenho ao vivo em páginas de status voltadas para clientes.

O Serviço de Relatórios XML (XRS) é um feed de dados gratuito sob demanda que retorna resultados de monitoramento como documentos XML. Aponte-o para qualquer painel de relatórios, ferramenta de BI, planilha do Excel ou banco de dados interno para criar visualizações personalizadas sem depender da engenharia.

Juntos, eles dão às suas equipes de plataforma, SRE e DevOps controle programático total — sem necessidade de cliques na interface.

  • Configure monitores HTTPS, REST, SOAP, GraphQL, WebSocket, ServerView, BrowserView, UserView e MetricsView via JSON
  • Importe, atualize e remova dispositivos, tarefas, grupos e agendadores em larga escala
  • Extraia dados de desempenho brutos ou agregados (resumos horários, diários, semanais, mensais, anuais)
  • Provisione monitoramento a partir do Jenkins, GitHub Actions, Azure DevOps, GitLab CI ou qualquer pipeline com capacidade HTTP

Web API — Referência Rápida

https://api.dotcom-monitor.com/config_api_v1/

Formato

Requisição JSON / Resposta JSON

Métodos

GET (leitura) · POST / PUT (escrever / atualizar)

Autenticação

Por requisição, sessão de 60 segundos; whitelist de IP opcional

Transporte

HTTP ou HTTPS

XRS — Referência Rápida

https://xmlreporter.dotcom-monitor.com/reporting/xml/

Formato

Resposta XML via HTTP(S) GET

Autenticação

UID da Conta (PID) gerado em Manage > Integrations

Profundidade de Dados

Respostas brutas de até 6 meses atrás

Custo

Grátis, incluído em todas as contas

1

Gerar uma Chave

Crie uma integração Web API ou XML Feed em sua conta.

2

Configurar

POST JSON para criar dispositivos, tarefas, grupos, cronogramas e alertas.
3

Monitorar

Executa de mais de 30 locais globais no seu cronograma definido.
4

Extrair

Obtenha resultados via XRS em dashboards, BI, Excel ou aplicativos internos.
Capacidades Principais da API

Tudo que a UI Pode Fazer — Como Código

Cada objeto de monitoramento na sua conta é um recurso API de primeira classe. Gerencie-os individualmente ou em massa em diferentes ambientes.

Configuração Completa do Monitor

  • Crie e edite monitores HTTPS, REST, SOAP, GraphQL e de múltiplas etapas
  • Configure dispositivos BrowserView, UserView, ServerView e MetricsView
  • Anexe autenticação: OAuth 2.0, chaves API, tokens Bearer, Basic, NTLM, mTLS
  • Defina assertivas JSONPath / XPath e validação personalizada de respostas

Gerenciamento de Dispositivos, Tarefas e Grupos

  • Provisionar dispositivos e as tarefas associadas a eles
  • Organizar monitores em grupos com alertas e filtros herdados
  • Aplicar alterações de configuração em massa através dos ambientes
  • Clonar dispositivos entre contas de staging, QA e produção

Locais e Agendas

  • Listar todas as localidades globais de monitoramento disponíveis
  • Atribuir verificações a regiões específicas ou aos seus Private Agents
  • Criar agendas baseadas em tempo (horário comercial, janelas de manutenção)
  • Aplicar Filtros programaticamente para suprimir ruídos conhecidos

Alertas e Integrações de Notificação

  • Criar, atualizar e encaminhar grupos de alerta via API
  • Gerenciar listas de destinatários, políticas de escalonamento e rodízios de plantão
  • Enviar notificações para Slack, PagerDuty, Teams, OpsGenie, webhooks
  • Automatizar o ajuste da escalada sem mexer na UI

Feed de Relatórios em Tempo Real XRS

  • Obter dados de uptime, tempo de resposta, TTFB e erros sob demanda
  • Retornar respostas brutas ou resumos (hora / dia / semana / mês / ano)
  • Filtrar por dispositivo, local, agenda, sucesso / falha, departamento
  • Transmitir para SQL, Excel, Power BI, Grafana ou dashboards personalizados
Como Funciona

Do Zero ao Monitoramento Automatizado em Quatro Passos

Não é necessário instalar SDK. Se o seu sistema pode fazer uma requisição HTTP, ele pode se comunicar com Dotcom-Monitor.

01

Crie uma Integração

Na sua conta Dotcom-Monitor, vá para Gerenciar > Integrações e crie uma nova integração Web API (para configuração) ou integração XML Feed (para relatórios). Opcionalmente, restrinja o acesso por endereço IP.

02

Autentique-se

Cada solicitação autentica contra sua integração. As sessões expiram após 60 segundos de inatividade, mantendo o acesso de curta duração e seguro. Solicitações XRS usam seu UID de Conta gerado (PID).

03

Envie Solicitações JSON

Use GET para leituras ou POST/PUT para gravações. Defina Content-Type: application/json ao enviar um corpo. Erros retornam JSON estruturado.

04

Automatize em Todos os Lugares

Conecte a API ao Terraform, Jenkins, GitHub Actions, Azure DevOps ou seus próprios scripts. Acione o provisionamento do monitor no deploy, puxe dados de desempenho para BI ou envie alertas automáticos em violações de SLA.

Especificações Técnicas

Duas APIs. Uma Conta. Controle Completo.

A Web API gerencia configuração; a XRS gerencia relatórios. Elas compartilham um único modelo de autenticação e funcionam com todas as soluções Dotcom-Monitor.

Web API (Configuração & Controle)

Gerencie sua infraestrutura de monitoramento programaticamente.

URL Base

api.dotcom-monitor.com/config_api_v1/

Protocolos

HTTP, HTTPS

Formato da solicitação

JSON (application/json)

Formato da resposta

JSON

Métodos

GET (ler) · POST, PUT (escrever / atualizar)

Autenticação

Chave de Integração Web API, sessão por requisição (timeout de 60s)

Controle de acesso

Whitelist de IP opcional

Cobre

Métodos de Monitoramento + LoadView

Objetos gerenciados

Dispositivos, tarefas, grupos, cronogramas, filtros, alertas, locais, testes de carga, usuários

Tratamento de erros

JSON estruturado com códigos de erro & mensagens

XML Reporting Service (XRS)

Transmita dados de monitoramento em tempo real para qualquer sistema que suporte XML.

URL Base

xmlreporter.dotcom-monitor.com/reporting/xml/

Protocolos

HTTP, HTTPS

Formato da solicitação

HTTP(S) GET com parâmetros na URL

Formato da resposta

Documento XML

Autenticação

UID da Conta (PID), gerado como uma integração de Feed XML

Escopo

Em toda a conta ou limitado a Departamentos específicos

Tipos de relatório

Configuração do dispositivo, status, respostas brutas, resumos (hora / dia / semana / mês / ano), estatísticas de 3 meses

Janela de dados

Até os últimos 6 meses para respostas brutas

Filtros

Localização, programação, dispositivo, sucesso / falha, departamento, intervalo de datas

Destinos de saída

Dashboards, SQL, Excel, Power BI, apps personalizados

Amigável para Desenvolvedores

HTTP Simples.
Sem necessidade de SDKs.

Cada objeto de monitoramento — dispositivos, tarefas, alertas, grupos, agendas — é representado como um recurso JSON. Veja como é puxar dados de monitoramento do XRS e enviar um novo dispositivo via Web API. Insira isso em um curl, um script bash, um job Python ou uma etapa CI — o que sua equipe já usar.

Os campos retornados incluem DnsTime, SSLTime, ConnectionTime, RequestTime, FirstPacketTime (TTFB), DownloadTime e Duration, além de localização, status e timestamp de monitoramento — prontos para serem usados em qualquer visualização em cascata.

# Obter relatório XRS em tempo real — resumo por local
GET https://xmlreporter.dotcom-monitor.com/reporting/xml/responses.aspx
     ?PID=4229AF4F0FB545AEA75EAF2013E51BB7
     &Site=12345
     &Type=Overall
     &location=NY, USA

# Resposta (resumida)
<Response>
  <ID>3424533543</ID>
  <Name>Checkout API</Name>
  <URL>https://shop.example.com/api/checkout</URL>
  <Duration>114</Duration>
  <DnsTime>0</DnsTime>
  <SSLTime>18</SSLTime>
  <ConnectionTime>15</ConnectionTime>
  <FirstPacketTime>97</FirstPacketTime>
  <DownloadTime>2</DownloadTime>
  <Status>S</Status>
</Response>

# Criar um novo monitor HTTPS via Web API
POST https://api.dotcom-monitor.com/config_api_v1/devices
Content-Type: application/json

{
  "name": "Checkout API — Produção",
  "platform": "HTTPS",
  "tasks": [{
    "url": "https://shop.example.com/api/checkout",
    "method": "POST",
    "keyword": "order_id"
  }],
  "frequency": 60,
  "locations": ["NY-USA", "FR-PARIS", "SG"]
}

Comece a Automatizar Seu Monitoramento em 5 Minutos

Todos os planos pagos incluem acesso total ao Web API e XRS — sem complementos, sem medição por chamada, sem nível de cobrança extra.

Inicie Seu Teste GRATUITO de 30 Dias
Agendar uma Demonstração
  • Nenhum cartão de crédito necessário
  • Cancele a qualquer momento
  • Suporte especializado 24×7
Casos de Uso

O Que as Equipes Constroem com a API

Equipes de plataforma, SREs e engenheiros DevOps usam a API Dotcom-Monitor para trazer monitoramento aos fluxos de trabalho em que já atuam.

Monitoramento como Código

Versione cada monitor junto com o serviço que ele protege. Provisione, atualize e desative dispositivos através do seu pipeline Terraform ou Pulumi existente — sem desvios entre staging e produção.

Testes de Validação Pós-Deploy

Acione verificações HTTPS sob demanda e transações multi-etapas a partir do Jenkins, GitHub Actions ou Azure DevOps após cada deploy. Falhe a build quando uma nova versão quebrar um endpoint crítico.

Páginas de Status e Dashboards Personalizados

Alimente dados XRS em páginas de uptime voltadas para clientes, painéis internos de NOC ou relatórios executivos de SLA. Extraia apenas os campos que desejar, formatados exatamente da forma que precisar.

Evidências de SLA e Relatórios de Conformidade

Automatize exportações mensais de SLA (%, tempo de resposta P95 / P99, incidentes de downtime) diretamente do XRS para Excel ou PDF — documentado, com carimbo de data/hora e pronto para auditoria.

Provisão em Massa de Dispositivos

Configure centenas de monitores em uma única operação após uma aquisição, migração ou mudança de CDN. Clone templates de dispositivos existentes e atribua grupos, horários e rotas de alerta adequados em escala.

Incorporação de Dashboards de Terceiros

Envie dados de monitoramento para Grafana, Power BI, Tableau ou Datadog junto com sua outra telemetria — checagens sintéticas externas correlacionadas com rastreamentos internos APM.

Gerenciamento Multi-Inquilino de Contas

MSPs e equipes empresariais podem gerenciar centenas de departamentos e milhares de dispositivos em um único processo programático, com feeds XRS com escopo por departamento para cada cliente.

Enriquecimento de Incidentes

Quando um monitor dispara, capture a cascata, cifra e detalhamento do tempo via XRS e anexe automaticamente ao incidente no PagerDuty ou ServiceNow — reduzindo o tempo de triagem.

Exploração Profunda do XRS

Relatórios em Tempo Real, Exatamente da Forma Que Você Precisa

O Serviço de Relatórios XML é um feed flexível, gratuito e sob demanda. Solicite dados resumidos ou respostas brutas. Filtre por local, programação ou estado de sucesso. Retorne apenas os campos que lhe interessam.

Tipo de relatório
O que você recebe
Uso típico
Utilização da conta
Recursos usados e disponíveis por solução de monitoramento
Planejamento de licença e capacidade, reconciliação de faturamento
Status do dispositivo
Estado e status atuais de dispositivos individuais ou conjuntos
Páginas de status ao vivo, painéis do mural do NOC
Detalhes da resposta
Temporização e conteúdo altamente personalizáveis por solicitação
Diagnósticos detalhados, cascatas personalizadas, enriquecimento de incidentes
Configuração de dispositivo e tarefa
Snapshots exportados da configuração de monitoramento
Backups, clonagem entre ambientes, trilhas de auditoria
Dados resumidos
Tempo ativo, tempo inativo, contagem de sucesso, contagem de falhas, desempenho, desvio padrão
Resumos executivos, relatórios de SLA
Respostas brutas
Cada resultado de verificação para um dispositivo, até 6 meses atrás
Análise forense, comparações históricas
Agregados horários
Dados de resposta agrupados em janelas de 1 hora
Identificação de carga máxima, análise de tendências horárias
Agregados diários
Dados de resposta agrupados em janelas de 24 horas
Revisões operacionais diárias, comparações entre dias úteis e fins de semana
Semanal / mensal / anual
Resumos em horizontes de tempo mais longos
Tendências em nível de diretoria, relatórios de desempenho ano a ano
Estatísticas de 3 meses
Dados estatísticos calculados em uma janela móvel de 3 meses
Alertas baseados em linha de base, detecção de anomalias

Cada relatório pode ser filtrado por local de monitoramento, cronograma, Filtro Dotcom-Monitor, estado de sucesso ou falha, departamento e intervalo de datas personalizado.

Por que as equipes usam a API

Construído para DevOps, SRE e Engenharia de Plataforma

A API do Dotcom-Monitor elimina cliques manuais na interface do usuário do seu fluxo de trabalho de monitoramento para que sua equipe possa ampliar a cobertura sintética sem aumentar o número de funcionários.

Elimine a deriva

Mantenha a configuração de monitoramento no controle de versão. Aplique os mesmos monitores em diferentes ambientes com confiança.

Desloque o monitoramento para a esquerda

Adicione verificações sintéticas no mesmo PR do serviço que elas cobrem. O monitoramento chega junto com o código, não semanas depois.

Escale sem cliques

Adicione centenas de novos domínios ou milhares de novos endpoints com um único script. Sem fadiga de cliques.

Segurança granular

Sessões de curta duração, lista branca opcional de IPs e chaves de integração com escopo departamental mantêm o acesso restrito.

Funciona em qualquer stack

HTTP simples + JSON (ou GET + XML para relatórios). Sem dependência de SDK. Funciona com todas as linguagens e ferramentas de CI/CD.

Tenha seus dados

Extraia seus dados de monitoramento para seu próprio data warehouse, plataforma BI ou arquivo de conformidade no seu ritmo.

Superfície unificada

Uma API abrange monitoramento e testes de carga LoadView — sem ferramenta separada, sem credenciais separadas.

Sem custo extra

O acesso à API e XRS está incluído em todos os planos pagos. Sem medição por chamada, sem cobrança adicional para automação.

O Que Nossos Clientes Dizem

"Uma das melhores características da Dotcom são as capacidades de API push/pull que nos fornecem dados de desempenho da rede. Usamos isso para monitorar problemas de desempenho, bem como estatísticas de carregamento de página. O Dotcom-Monitor nos permite monitorar múltiplos serviços em uma única interface e plataforma. Isso nos permitiu operar com mais eficiência."
Gregory S.
Gerente, Mídia de Radiodifusão · Avaliação verificada no Capterra

Pronto para Colocar Seu Monitoramento no Piloto Automático?

Cada teste gratuito de 30 dias inclui acesso completo à Web API e XRS — além de todas as soluções de monitoramento, todas as localidades e todas as integrações. Veja como é o monitoramento automatizado.

Comece o Teste Gratuito
Leia a Documentação da API
  • Configuração em menos de 5 minutos
  • Nenhum cartão de crédito necessário
Perguntas Frequentes

Perguntas Comuns Sobre a API Dotcom-Monitor

A Web API (config_api_v1) é uma interface REST baseada em JSON para criação e gerenciamento de configurações de monitoramento — dispositivos, tarefas, grupos, agendas, alertas e testes de carga. O Serviço de Relatórios XML (XRS) é um feed gratuito separado que retorna resultados de monitoramento em XML via HTTP GET. A maioria das equipes usa ambos: Web API para configurar e XRS para extrair resultados.

Na sua conta Dotcom-Monitor, vá para Gerenciar > Integrações > Nova Integração e crie uma integração Web API (para configuração) ou uma integração XML Feed (para XRS). Cada requisição da Web API autentica contra essa integração e as sessões expiram após 60 segundos de inatividade. O XRS usa o UID da Conta gerado como parâmetro URL PID. Você também pode restringir o acesso por endereço IP.

A Web API é completamente JSON — tanto para corpos de requisição quanto para respostas. Defina Content-Type: application/json ao enviar um corpo JSON. O XRS retorna documentos XML via HTTP(S) GET, portanto a requisição é apenas uma URL com parâmetros de consulta.

A Web API cobre todas as plataformas de monitoramento Dotcom-Monitor: HTTPS, REST, SOAP, GraphQL, WebSocket, ServerView, BrowserView, UserView (scripts EveryStep), e MetricsView — além de todos os monitores de protocolo (DNS, SSL, Email, FTP, ICMP Ping, TCP Port, Traceroute, VoIP e mais). Também cobre toda a superfície de testes de carga do LoadView.

O acesso à API e XRS está incluído em todos os planos pagos — não há medição por chamada nem taxa adicional. As sessões expiram após 60 segundos de inatividade, o que naturalmente limita scripts de longa execução. Se precisar de acesso restrito por IP ou throughput em nível empresarial, contate Vendas sobre opções Enterprise.

XRS pode retornar dados brutos de resposta dos últimos 6 meses. Relatórios resumidos e estatísticos (agregados por hora / dia / semana / mês / ano e estatísticas trimestrais) estão disponíveis para períodos mais longos. Você especifica a data/hora de início e fim para cada relatório.

Sim — qualquer ferramenta que possa fazer uma chamada HTTP pode usar a API. Equipes geralmente integram com Jenkins, GitHub Actions, GitLab CI, Azure DevOps, CircleCI e Terraform para provisionar monitores na implantação, executar testes rápidos pós-lançamento e controlar liberações em produção com base na saúde do monitoramento.

Sim. Ao criar uma Integração Web API, você pode permitir acesso de todas as requisições autenticadas ou restringir o acesso a uma lista de endereços IP confiáveis. Veja o artigo Como Colocar IPs na Lista Branca para Acesso à Web API na Base de Conhecimento para mais detalhes.

Sim. Usuários em uma conta raiz podem gerenciar departamentos programaticamente, e uma integração de Feed XML pode ser delimitada a departamentos específicos. Usuários limitados a departamentos só podem extrair relatórios XRS de seu próprio departamento, o que suporta separação limpa para MSPs e configurações multi-inquilino.

A documentação completa está na Base de Conhecimento do Dotcom-Monitor, incluindo o guia Introdução à API, as referências de métodos de Monitoramento e LoadView com exemplos JSON, e a referência de parâmetros de solicitação do XRS. Modelos de código prontos para uso estão disponíveis na seção Exemplos de Código.

Automatize o Monitoramento.Recupere Tempo de Engenharia.

Junte-se a mais de 10.000 organizações usando Dotcom-Monitor para detectar falhas antes dos clientes — e usando a API e XRS para tornar essa cobertura fácil de gerenciar.

Iniciar Teste Gratuito — Sem Cartão de Crédito
Ver Preços
  • Teste completo de 30 dias
  • Plano gratuito disponível
  • Cancele a qualquer momento