WebPixie API

WebPixie's GraphQL API lets you read and manage your monitoring data programmatically, using the API keys created in API Users.

WebPixie exposes a GraphQL API for reading and managing your monitoring data programmatically.

Some features and limits mentioned on this page vary by plan. Visit our Pricing page to review the plans.

Endpoint

All requests are sent to:

https://app.webpixie.io/graphql

Authentication

Requests are authenticated with an API key and secret, using HTTP Basic authentication. See Authentication for the exact format and setup.

Example Query

Read your active uptime monitors, selecting only the fields you need:

query {
  findUptimeLink(query: "status = ACTIVE", limit: 10) {
    items {
      id
      name
      target
      status
      checkInterval
      lastRecord {
        accessibilityStatus
        spendTime
      }
    }
  }
}

Example Mutation

Add a new site to monitor, enabling specific product areas:

mutation {
  createSite(
    domain: "acme.io"
    features: [
      MONITOR_WHOIS
      MONITOR_SSL
      MONITOR_DNS
      LINK_CRAWLER
    ]
    notification: { all: true }
  ) {
    id
    domain
    features
    notification {
      all
    }
  }
}

Conventions

Every response follows the standard GraphQL shape: a data object, and an errors array when something failed.
IDs are strings (UUIDs).
Timestamps are ISO 8601 strings. In time arguments such as startTime and endTime, a time without a timezone is read as UTC.
Sites are addressed by domain; uptime monitors and most other records by id. Find IDs with findUptimeLink, mySites, and the other list queries.

Filtering, Pagination & Sorting

Most list queries accept a query string written in WQL for filtering, plus page, limit, and sort arguments. See Filtering and Pagination & Sorting.

See Resources for the queries, mutations, and filterable fields available for each resource — your account, sites, uptime monitors, incidents, tags and folders, and integrations — plus the shared Types reference.

Error Codes

Failed requests return a standard GraphQL errors array or an HTTP error, and monitoring data (SSL, DNS, WHOIS, sitemap, and more) carries its own machine-readable error.code. See Error Codes.

Scope

API keys cover your monitoring data: sites, uptime monitors, incidents, and your own identity. Workspace administration and billing management are done in the WebPixie dashboard.

Using an AI Assistant

Prefer to work through an AI assistant instead of code? Connect it to your WebPixie account with the MCP Server.

On this page