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

Automatize Todas as Partes 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 painéis, SIEMs e pipelines 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 Demo
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 no Mundo Todo

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. 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 por meio 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 aos 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 às suas ferramentas de ticketing 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 sob demanda gratuito que retorna resultados de monitoramento como documentos XML. Aponte-o para qualquer painel de relatórios, ferramenta de BI, planilha Excel ou banco de dados interno para criar visualizações personalizadas sem depender da engenharia.

Juntos, eles oferecem controle programático total para suas equipes de plataforma, SRE e DevOps — 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 escala
  • Extraia dados de desempenho brutos ou agregados (sumários horários, diários, semanais, mensais, anuais)
  • Provisionamento de monitoramento a partir de Jenkins, GitHub Actions, Azure DevOps, GitLab CI ou qualquer pipeline capaz de 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 (escrita / atualização)

Autenticação

Por requisição, sessão de 60 segundos; lista branca 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 XML Feed na sua conta.

2

Configurar

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

Monitorar

Executa a execução a partir de mais de 30 localizações globais no seu cronograma definido.
4

Extrair

Obtenha resultados via XRS em painéis, 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 entre ambientes.

Configuração Completa do Monitor

  • Criar e editar monitores API HTTPS, REST, SOAP, GraphQL e multi-etapas
  • Configurar dispositivos BrowserView, UserView, ServerView e MetricsView
  • Anexar autenticação: OAuth 2.0, chaves API, tokens Bearer, Basic, NTLM, mTLS
  • Definir 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 todos os locais globais de monitoramento disponíveis
  • Atribuir verificações a regiões específicas ou aos seus Agentes Privados
  • Criar agendas baseadas em tempo (horário comercial, janelas de manutenção)
  • Aplicar Filtros programaticamente para suprimir ruídos conhecidos

Integrações de Alertas e Notificações

  • Criar, atualizar e direcionar 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 a configuração de escalonamento sem mexer na 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
  • Transmitir para SQL, Excel, Power BI, Grafana ou painéis personalizados
Como Funciona

Do Zero ao Monitoramento Automatizado em Quatro Passos

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

01

Criar 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

Autenticar

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

03

Enviar Solicitações JSON

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

04

Automatize em Todos os Lugares

Integre a API com Terraform, Jenkins, GitHub Actions, Azure DevOps ou seus próprios scripts. Acione o provisionamento de monitor via deploy, puxe dados de performance 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 lida com configuração; XRS lida com 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 (leitura) · POST, PUT (escrever / 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

Coberturas

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 e mensagens de erro

Serviço de Relatórios 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 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

Para 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

Local, 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.
Sem SDKs Necessários.

Cada objeto de monitoramento — dispositivos, tarefas, alertas, grupos, cronogramas — é representado como um recurso JSON. Veja como é puxar dados de monitoramento do XRS e enviar um novo dispositivo via Web API. Use isso em um curl, um script bash, um job Python, ou uma etapa de 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 usar em qualquer visualização tipo waterfall.

# Puxar 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 (reduzida)
<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 complementos, sem medição por chamada, sem níveis extras de cobrança.

Comece seu teste GRATUITO de 30 dias
Agende uma Demo
  • 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 de DevOps usam a API do Dotcom-Monitor para trazer o monitoramento para os 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 retire dispositivos através de seu pipeline Terraform ou Pulumi existente — sem divergência entre staging e produção.

Testes Rápidos Pós-Deploy

Dispare checagens HTTPS sob demanda e transações em múltiplas 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 do XRS em páginas de uptime para clientes, displays internos do NOC ou relatórios executivos de SLA. Extraia apenas os campos que desejar, formatados exatamente como 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 — documentados, com carimbo de data e prontos para auditoria.

Provisionamento em Massa de Dispositivos

Inicie centenas de monitores em uma única execução após uma aquisição, migração ou cutover de CDN. Clone templates de dispositivos existentes e atribua os grupos, cronogramas e rotas de alerta corretos em escala.

Incorporação de Dashboards de Terceiros

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

Gerenciamento de Contas Multi-inquilino

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

Enriquecimento de Incidentes

Quando um monitor dispara, obtenha o gráfico de cascata, cifra e detalhamento de tempo via XRS e anexe automaticamente ao incidente no PagerDuty ou ServiceNow — reduzindo o tempo de triagem.

Análise Profunda do XRS

Relatórios em tempo real exatamente do jeito que você precisa

O XML Reporting Service é um feed flexível, gratuito e sob demanda. Solicite dados resumidos ou respostas brutas. Filtre por local, cronograma ou estado de sucesso. Retorne apenas os campos que 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ças e capacidade, reconciliação de faturamento
Status do dispositivo
Estado atual e status de dispositivos individuais ou conjuntos
Páginas de status ao vivo, painéis de parede do NOC
Detalhes da resposta
Temporização 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 resumo
Tempo ativo, tempo inativo, contagem de sucessos, 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 por hora
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 finais de semana
Semanal / mensal / anual
Resumos em horizontes de tempo mais longos
Tendências em nível de diretoria, relatórios de desempenho anual
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

Projetado para DevOps, SRE & Engenharia de Plataforma

A API Dotcom-Monitor elimina cliques manuais na interface do usuário do seu fluxo de trabalho de monitoramento para que sua equipe possa expandir a cobertura sintética sem aumentar o quadro 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.

Mova o Monitoramento para a Esquerda

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

Escale Sem Cliques

Integre 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, lista de IPs opcional, e chaves de integração limitadas 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 CI/CD.

Seus Dados, Seu Controle

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

Superfície Unificada

Uma API abrange monitoramento e LoadView load testing — 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 taxa extra para automação.

O Que Nossos Clientes Dizem

"Uma das melhores funcionalidades do 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 Transmissão · Avaliação verificada no Capterra

Pronto Para Colocar Seu Monitoramento no Piloto Automático?

Cada avaliação gratuita 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.

Começar Avaliação Gratuita
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 do 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, cronogramas, 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, 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 é totalmente 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 do Dotcom-Monitor: HTTPS, REST, SOAP, GraphQL, WebSocket, ServerView, BrowserView, UserView (scripts EveryStep) e MetricsView — assim como todos os monitores de protocolo (DNS, SSL, Email, FTP, ICMP Ping, Porta TCP, Traceroute, VoIP e mais). Também cobre toda a superfície de teste de carga do LoadView.

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

O XRS pode retornar dados brutos de resposta por até os últimos 6 meses. Relatórios resumidos e estatísticos (agregados horários / diários / semanais / mensais / anuais e estatísticas de 3 meses) estão disponíveis por períodos de tempo 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 costumam integrar com Jenkins, GitHub Actions, GitLab CI, Azure DevOps, CircleCI e Terraform para provisionar monitores na implantação, executar testes básicos pós-lançamento e controlar implantações 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 endereços IP 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 raiz podem gerenciar departamentos programaticamente, e uma integração XML Feed pode ser limitada a departamentos específicos. Usuários limitados a departamentos podem puxar relatórios XRS apenas do 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 Monitoring e LoadView com exemplos JSON, e a referência de parâmetros de requisição do XRS. Modelos de código prontos para uso estão disponíveis na seção de Exemplos de Código.

Automatize o Monitoramento.Recupere Tempo de Engenharia.

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

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