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, using HTTP Basic authentication. Create and manage API keys from the API Users page.

An API key acts with the same workspace role as the user who created it — there is no separate read-only or write-only key level. A key's access can also be narrowed to specific sites when it's created.

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

Scope

The GraphQL API covers your full account and monitoring management: sites, uptime monitors, incidents, workspace users, invitations, subscription and billing, and more — 25+ queries and 20+ mutations in total.

Endpoint

Authentication

Example Query

Example Mutation

Scope

On this page