ScrepyDocs

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/projects/{project_uid}/core-web-vitals

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

Authorization

bearerApiKey
AuthorizationBearer <token>

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

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/projects/string/core-web-vitals"
{  "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"          }        ]      }    }  }}
GET/projects/{project_uid}/uptime

Authorization

bearerApiKey
AuthorizationBearer <token>

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

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/projects/string/uptime"
{  "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"      }    ]  }}