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(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
    }
  }
}

Filtering, Pagination & Sorting

Most list queries (the ones starting with find) accept a query string written in WQL for filtering, plus page, limit, and sort arguments. See Filtering and Pagination & Sorting.

Resources

See Resources for the queries, mutations, and filterable fields available for each resource — sites, uptime monitors, and incidents.

Error Codes

Monitoring pillar data (SSL, DNS, WHOIS, sitemap, and more) carries its own machine-readable error.code — separate from whether the GraphQL request itself succeeded. See Error Codes.

API keys cover your monitoring data: sites, uptime monitors, incidents, and your own identity. Workspace administration — managing workspace users, invitations, and subscription/billing — is only available through the WebPixie dashboard, not the API.