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"
}
'
import requests

url = "https://api.godiligent.ai/screen"

payload = { "website": "https://example-store.com" }
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({website: 'https://example-store.com'})
};

fetch('https://api.godiligent.ai/screen', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.godiligent.ai/screen",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'website' => 'https://example-store.com'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.godiligent.ai/screen"

payload := strings.NewReader("{\n \"website\": \"https://example-store.com\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.godiligent.ai/screen")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"website\": \"https://example-store.com\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.godiligent.ai/screen")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"website\": \"https://example-store.com\"\n}"

response = http.request(request)
puts response.read_body
{
  "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."
  }
}
{
"code": "unsupported_platform",
"error": "Operational screening is not supported for INSTAGRAM links on this endpoint.",
"platform": "INSTAGRAM"
}

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