Health

Retrieve Core Web Vitals results, uptime summaries, and recent availability checks for your Screpy projects.

Separate performance from availability

Core Web Vitals and uptime answer different questions: performance data helps assess user experience, while uptime data shows whether a monitored site was reachable. Use the endpoint that matches the signal you need, then investigate affected URLs in the Core Web Vitals guide.

A data: null response can mean that no matching check is available yet. Confirm the project and monitoring setup before treating it as a site failure; the uptime guide explains the availability workflow.

Get Core Web Vitals data

GET/projects/{project_uid}/core-web-vitals

Returns data: null when no checked homepage result is available.

Authorization

bearerApiKey

AuthorizationBearer

Create a REST API key in Settings > Connected Apps. MCP credentials do not authenticate this API.

In: header

Path Parameters

project_uid*string

Accessible project UID. Discover it with GET /projects; do not guess it.

Match^[a-z0-9]{10}$

Response Body

200 application/json

401 application/json

403 application/json

404 application/json

429 application/json

cURL

curl -X GET "https://api.screpy.com/v1/projects/string/core-web-vitals"

200401403404429

{
  "data": {
    "url": "string",
    "last_checked_at": "2019-08-24T14:15:22Z",
    "metrics": {
      "fcp": {
        "value": 0,
        "distribution": {
          "good": 0,
          "needs_improvement": 0,
          "poor": 0
        },
        "history": [
          {
            "label": "string",
            "value": 0,
            "status": "string"
          }
        ]
      },
      "lcp": {
        "value": 0,
        "distribution": {
          "good": 0,
          "needs_improvement": 0,
          "poor": 0
        },
        "history": [
          {
            "label": "string",
            "value": 0,
            "status": "string"
          }
        ]
      },
      "cls": {
        "value": 0,
        "distribution": {
          "good": 0,
          "needs_improvement": 0,
          "poor": 0
        },
        "history": [
          {
            "label": "string",
            "value": 0,
            "status": "string"
          }
        ]
      },
      "ttfb": {
        "value": 0,
        "distribution": {
          "good": 0,
          "needs_improvement": 0,
          "poor": 0
        },
        "history": [
          {
            "label": "string",
            "value": 0,
            "status": "string"
          }
        ]
      },
      "tbt": {
        "value": 0,
        "distribution": {
          "good": 0,
          "needs_improvement": 0,
          "poor": 0
        },
        "history": [
          {
            "label": "string",
            "value": 0,
            "status": "string"
          }
        ]
      },
      "speed_index": {
        "value": 0,
        "distribution": {
          "good": 0,
          "needs_improvement": 0,
          "poor": 0
        },
        "history": [
          {
            "label": "string",
            "value": 0,
            "status": "string"
          }
        ]
      }
    }
  }
}

{
  "message": "Unauthenticated."
}

{
  "message": "string",
  "code": "string"
}

{
  "message": "Project not found or not accessible."
}

{
  "message": "string",
  "code": "string"
}

Get uptime summary and recent checks

GET/projects/{project_uid}/uptime

Authorization

bearerApiKey

AuthorizationBearer

Create a REST API key in Settings > Connected Apps. MCP credentials do not authenticate this API.

In: header

Path Parameters

project_uid*string

Accessible project UID. Discover it with GET /projects; do not guess it.

Match^[a-z0-9]{10}$

Response Body

200 application/json

401 application/json

403 application/json

404 application/json

429 application/json

cURL

curl -X GET "https://api.screpy.com/v1/projects/string/uptime"

200401403404429

{
  "data": {
    "summary": {
      "current_status": "string",
      "uptime_percentage": 0,
      "avg_response_time_ms": 0,
      "last_checked_at": "2019-08-24T14:15:22Z"
    },
    "rows": [
      {
        "label": "string",
        "status": "string",
        "response_time_ms": 0,
        "checked_at": "2019-08-24T14:15:22Z"
      }
    ]
  }
}

{
  "message": "Unauthenticated."
}

{
  "message": "string",
  "code": "string"
}

{
  "message": "Project not found or not accessible."
}

{
  "message": "string",
  "code": "string"
}