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 Dotcom-Monitor API

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).
Comece Seu Teste GRATUITO de 30 Dias
Agende 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.
  • Não é necessário cartão de crédito
  • Configuração em menos de 5 minutos
  • Acesso total à 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 Sites

Monitoramento Programático

O que é a API Dotcom-Monitor?

A plataforma Dotcom-Monitor é totalmente scriptável. Qualquer coisa que você possa fazer na interface web — desde criar um novo monitor HTTP até gerar um relatório de desempenho de três meses — você pode fazer programaticamente através de dois serviços complementares: a Web API baseada em REST para configuração e o XML Reporting Service (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, gerenciar milhares de dispositivos sob configuração como código, integrar monitoramento nas suas ferramentas de tickets existentes ou incorporar dados de desempenho ao vivo em páginas de status voltadas para o cliente.

O XML Reporting Service (XRS) é um feed de dados sob demanda gratuito 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 construir visualizações personalizadas sem depender da engenharia.

Juntos, eles oferecem à sua plataforma, times de SRE e DevOps controle programático total — sem cliques na interface do usuário.

  • Configure monitores HTTPS, REST, SOAP, GraphQL, WebSocket, ServerView, BrowserView, UserView, e MetricsView via JSON
  • Importe, atualize e remova dispositivos, tarefas, grupos e agendadores em escala
  • Extraia dados de desempenho brutos ou agregados (resumos horários, diários, semanais, mensais, anuais)
  • Provisione monitoramento a partir de Jenkins, GitHub Actions, Azure DevOps, GitLab CI, ou qualquer pipeline compatível com 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 Gerenciar > Integrações

Profundidade dos 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 Feed XML na sua conta.

2

Configurar

Envie JSON via POST para criar dispositivos, tarefas, grupos, agendas e alertas.
3

Monitorar

Execuções rodando de mais de 30 locais globais no seu cronograma definido.
4

Extrair

Extraia resultados via XRS para dashboards, BI, Excel ou apps 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 diversos ambientes.

Configuração Completa de Monitoramento

  • Criar e editar monitores HTTPS, REST, SOAP, GraphQL e API multi-etapas
  • Configurar dispositivos BrowserView, UserView, ServerView e MetricsView
  • Anexar autenticação: OAuth 2.0, chaves de API, tokens Bearer, Basic, NTLM, mTLS
  • Definir afirmações JSONPath / XPath e validação personalizada de resposta

Gerenciamento de Dispositivo, Tarefa e Grupo

  • Provisionar dispositivos e as tarefas que ficam sob eles
  • Organizar monitores em grupos com alertas e filtros herdados
  • Aplicar alterações de configuração em massa entre ambientes
  • Clonar dispositivos entre contas de staging, QA e produção

Localizações e Agendamentos

  • Listar todas as localizações globais de monitoramento disponíveis
  • Atribuir verificações para regiões específicas ou para seus Agentes Privados
  • 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 direcionar grupos de alertas via API
  • Gerenciar listas de destinatários, políticas de escalonamento e rotações de plantão
  • Enviar notificações para Slack, PagerDuty, Teams, OpsGenie, webhooks
  • Automatizar ajuste de escalonamento sem acessar a interface

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
  • Transmita para SQL, Excel, Power BI, Grafana ou dashboards personalizados
Como Funciona

Do Zero ao Monitoramento Automatizado em Quatro Etapas

Não é necessário instalar SDK. Se 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

Cada requisição autentica contra sua integração. Sessões expiram após 60 segundos de inatividade, mantendo o acesso de curta duração e seguro. Requisições XRS usam seu Account UID (PID) gerado.

03

Envie Requisiçõ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

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

Especificações Técnicas

Duas APIs. Uma Conta. Controle Total.

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 requisição

JSON (application/json)

Formato da resposta

JSON

Métodos

GET (leitura) · POST, PUT (criar / atualizar)

Autenticação

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

Controle de acesso

Lista branca de IP opcional

Cobre

Métodos de Monitoramento + LoadView

Objetos gerenciados

Dispositivos, tarefas, grupos, agendas, filtros, alertas, localizações, testes de carga, usuários

Tratamento de erros

JSON estruturado com códigos e mensagens de erro

Serviço de Reporte XML (XRS)

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

URL Base

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

Protocolos

HTTP, HTTPS

Formato da requisiçã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órios

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, cronograma, dispositivo, sucesso / falha, departamento, intervalo de datas

Destinos de saída

Dashboards, SQL, Excel, Power BI, aplicativos personalizados

Amigável para Desenvolvedores

HTTP simples.
Não são necessários SDKs.

Cada objeto de monitoramento — dispositivos, tarefas, alertas, grupos, cronogramas — é representado como um recurso JSON. Veja como é buscar dados de monitoramento do XRS e criar um novo dispositivo através da Web API. Insira isso em um curl, script bash, tarefa Python ou passo CI — qualquer ferramenta que sua equipe já utilize.

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 inserir em qualquer visualização waterfall.

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

# Resposta (cortada)
<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

Todo plano pago inclui acesso completo à Web API e XRS — sem add-ons, sem medição por chamada, sem cobrança extra.

Comece Seu Teste GRATUITO de 30 Dias
Agende uma Demonstração
  • Não é necessário cartão de crédito
  • 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 integrar o monitoramento aos fluxos de trabalho que já utilizam.

Monitoramento-como-Código

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

Testes de Fumaça Pós-Implantação

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

Páginas de Status Personalizadas e Dashboards

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 desejados, formatados exatamente da maneira que você precisa.

Evidência de SLA e Relatórios de Conformidade

Automatize exportações mensais de SLA (percentual de uptime, 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.

Provisionamento em Massa de Dispositivos

Implemente centenas de monitores de uma só vez após uma aquisição, migração ou troca de CDN. Clone templates de dispositivos existentes e atribua os grupos, cronogramas e rotas de alerta corretos em escala.

Incorporação de Dashboard de Terceiros

Envie dados de monitoramento para Grafana, Power BI, Tableau ou Datadog junto com sua outra telemetria — verificações sintéticas externas correlacionadas com traces APM internos.

Gerenciamento de Contas Multi-Inquilino

MSPs e equipes corporativas podem gerenciar centenas de departamentos e milhares de dispositivos em uma única varredura programática, com feeds XRS delimitados por departamento para cada cliente.

Enriquecimento de Incidentes

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

XRS Análise Profunda

Relatórios em Tempo Real, Exatamente do Jeito 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 localização, agenda ou estado de sucesso. Retorne apenas os campos que importam para você.

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, quadros de parede NOC
Detalhes da resposta
Tempo e conteúdo altamente personalizáveis por solicitação
Diagnósticos detalhados, waterfalls personalizados, 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, StDev
Sumários executivos, relatórios 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 pico de carga, análise de tendências horárias
Agregados diários
Dados de resposta agrupados em janelas de 24 horas
Revisões diárias de operações, comparações entre dias úteis e fim de semana
Semanal / mensal / anual
Sumários ao longo de horizontes temporais 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 & Engenharia de Plataforma

A API Dotcom-Monitor remove cliques manuais da 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 colaboradores.

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 é entregue junto com o código, não semanas depois.

Escale Sem Cliques

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

Segurança Granular

Sessões de curta duração, whitelist opcional de IP e chaves de integração por departamento mantêm o acesso restrito.

Compatível com 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 Controle dos Seus Dados

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

Superfície Unificada

Uma API que abrange monitoramento e LoadView load testing — sem ferramenta separada, sem credenciais separadas.

Sem Custos Extras

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

"Um dos melhores recursos do Dotcom é a capacidade da API push/pull que nos fornece dados de desempenho de 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 Broadcast · Avaliação Verificada no Capterra

Pronto Para Colocar Seu Monitoramento no Piloto Automático?

Cada teste gratuito de 30 dias inclui acesso total à 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 Grátis
Leia a Documentação da API
  • Configure em menos de 5 minutos
  • Não é necessário cartão de crédito
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 da configuração de monitoramento — dispositivos, tarefas, grupos, agendas, alertas e testes de carga. O XML Reporting Service (XRS) é um feed gratuito separado que retorna resultados de monitoramento como XML via HTTP GET. A maioria das equipes usa ambos: Web API para configuração, 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). Toda 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 Account UID gerado como parâmetro de URL PID. Você também pode restringir o acesso por endereço IP.

A Web API é totalmente JSON — tanto nos corpos das requisições quanto nas respostas. Defina Content-Type: application/json ao enviar um corpo JSON. O XRS retorna documentos XML por HTTP(S) GET, então 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 LoadView.

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

O 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 de 3 meses) 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 no deploy, executar testes rápidos pós-lançamento e controlar rollouts de 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 IPs confiáveis. Veja o artigo Como colocar IPs na lista branca para acesso Web API na Base de Conhecimento para detalhes.

Sim. Usuários em uma conta root podem gerenciar departamentos programaticamente, e uma integração XML Feed pode ser delimitada a departamentos específicos. Usuários com acesso limitado a departamento só podem puxar relatórios XRS do seu próprio departamento, o que suporta separação limpa para MSPs e configurações multi-tenant.

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

Automatize o Monitoramento.Recupere o Tempo de Engenharia.

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

Comece Teste Grátis — Sem Cartão de Crédito
Veja os Preços
  • Teste gratuito completo de 30 dias
  • Plano gratuito disponível
  • Cancele a qualquer momento