Skip to main content
POST
/
screen
Screen a website instantly for operational status (Experimental)
curl --request POST \
  --url https://api.godiligent.ai/screen \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "website": "https://example-store.com"
}
'
{
  "run_id": "run_123456789",
  "website": "https://example-store.com",
  "screened_at": "2025-03-31T12:34:56Z",
  "platform": "SALLA",
  "operational_status": {
    "is_active": false,
    "explanation": "The message indicates that the store is currently under maintenance, which is a clear indicator of a non-operational status."
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.godiligent.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
website
string<uri>
required
Example:

"https://example-store.com"

Response

Successful screening result

​
run_id
string
required

Unique identifier for this screening run

Example:

"run_123456789"

​
website
string<uri>
required
Example:

"https://example-store.com"

​
screened_at
string<date-time>
required
Example:

"2025-03-31T12:34:56Z"

​
platform
enum<string>
required

Detected platform of the website

Available options:
SHOPIFY,
WOOCOMMERCE,
NOPCOMMERCE,
ZID,
SALLA,
WIZISHOP,
MAGENTO,
OXID,
PRESTASHOP,
CUSTOM
Example:

"SALLA"

​
operational_status
object
required