Website and API Monitoring Actor

This Apify actor is designed to monitor the status, response time, and content of websites and API endpoints. It can help you ensure that your web assets are available, performing well, and delivering the expected content.

Features

• Website and API Monitoring: Check multiple URLs or API endpoints to ensure they are up and running.
• Response Time Tracking: Monitor how long it takes for each endpoint to respond.
• SSL Certificate Error Detection: Optionally flag SSL certificate issues as errors.
• Content Validation: Verify that specific content is present in the response from each URL.
• Proxy Support: Utilize Apify's proxy configuration for requests.
• Customizable Timeout and Response Time Thresholds: Set time limits for requests and acceptable response times.

Use Cases

• Regularly check the availability of websites or APIs your business relies on.
• Monitor response times to identify slow endpoints.
• Ensure critical content is delivered correctly on your web pages.
• Detect SSL certificate issues that could affect user trust or accessibility.

Parameters

Required

• urls (array): List of URLs or API endpoints to monitor. Each item can be a string URL or an object with additional request options.

Optional

• flagSslErrorsAsError (boolean): If true, treat SSL certificate validation errors as request errors. Default is true.

• contentValidation (object): Key-value pairs where the key is a URL and the value is the content to validate within that URL's response.

• timeout (integer): Timeout in seconds for each website check. Default is 5.

• responseTimeThreshold (integer): Maximum acceptable response time in seconds.

• proxyConfiguration (object): Proxy settings used by the actor. Supports Apify's proxy configuration options.

How to Use

1. Create a task on Apify platform using this actor.
2. Provide input parameters as per your monitoring needs:
   • Specify URLs you want to monitor.
   • Set whether SSL errors should be flagged as errors (flagSslErrorsAsError).
   • Define any specific content you expect each URL to contain (contentValidation).
   • Adjust timeout and response time thresholds if necessary.
3. Run the actor manually or schedule it at regular intervals using Apify's scheduling feature.
4. Review results pushed by the actor which include status codes, response times, potential errors, and more.

Example Input

{
    "urls": [
        "https://example.com",
        {
            "url": "https://api.example.com/data",
            "method": "POST",
            "payload": {"key": "value"},
            "headers": {"Authorization": "Bearer token"}
        }
    ],
    "flagSslErrorsAsError": true,
    "contentValidation": {
        "https://example.com": "<title>Example Domain</title>"
    },
    "timeout": 10,
    "responseTimeThreshold": 2,
    "proxyConfiguration": {
        "useApifyProxy": true,
        "apifyProxyGroups": ["RESIDENTIAL"],
        "apifyProxyCountry": "US"
    }
}

Output

The actor outputs an array of results for each URL checked:

[
  {
    "status": true,
    "url": "https://example.com",
    ...
  },
  ...
]

Each result includes details such as HTTP status code, elapsed time, redirect information, any errors encountered, whether content validation passed, and if response time exceeded thresholds.

---