Readiness

Related events: readiness.score.updated

Endpoints

GET/v1/brands/{brand}/readiness

The Readiness score object

Attributes

objectstring
readiness_score
brandstring
The brand the object belongs to (br_…).
marketstringnullable
Market code (ISO country, e.g. FR).
scoreintegernullable
previous_scoreobject
triggerenum
Possible values: crawl · sync · declaration · manual · seed
blocksarray of object
computed_atstring
livemodeboolean
true for live data, false for the test-mode sandbox.

The Readiness score object


{
  "object": "readiness_score",
  "brand": "br_031DIivuBKog78mwjgnYQr",
  "market": "FR",
  "score": 68,
  "previous_score": 64,
  "trigger": "crawl",
  "blocks": [
    {
      "block": "crawlability",
      "weight": 30,
      "score": 82,
      "measured": true,
      "checks": [
        {
          "check": "robots_ai_bots",
          "status": "ok",
          "value": "7/7",
          "impact": 0
        },
        {
          "check": "llms_txt",
          "status": "err",
          "value": null,
          "impact": 4
        }
      ]
    }
  ],
  "computed_at": "2026-09-23T04:19:10Z",
  "livemode": true
}

Retrieve the readiness score

GET/v1/brands/{brand}/readiness

The latest AI readiness audit of a market — crawlability by AI bots, structured data, product feed conformity, agentic checkout — scored /100 with its checks. 404 until a first audit ran on the market.

Parameters

brandstringrequired
Brand id (br_…).

Returns

Returns the readiness_score object. Raises an error if something goes wrong.

curl


curl https://api.skoup.ai/v1/brands/br_034CyfRFSXUqzrbzV6MAfZ/readiness \
  -H "Authorization: Bearer skoup_test_4eC39HqLyjWDarjtT1zdp7dc"

Node.js


const response = await fetch('https://api.skoup.ai/v1/brands/br_034CyfRFSXUqzrbzV6MAfZ/readiness', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.SKOUP_API_KEY}`,
  },
})
const data = await response.json()

PHP


$client = new GuzzleHttp\Client(['base_uri' => 'https://api.skoup.ai/v1/']);
$response = $client->request('GET', 'brands/br_034CyfRFSXUqzrbzV6MAfZ/readiness', [
    'headers' => ['Authorization' => 'Bearer '.getenv('SKOUP_API_KEY')],
]);
$data = json_decode((string) $response->getBody(), true);

Python


import os, requests
 
response = requests.get(
    "https://api.skoup.ai/v1/brands/br_034CyfRFSXUqzrbzV6MAfZ/readiness",
    headers={"Authorization": f"Bearer {os.environ['SKOUP_API_KEY']}"},
)
data = response.json()

Response


{
  "object": "readiness_score",
  "brand": "br_031DIivuBKog78mwjgnYQr",
  "market": "FR",
  "score": 68,
  "previous_score": 64,
  "trigger": "crawl",
  "blocks": [
    {
      "block": "crawlability",
      "weight": 30,
      "score": 82,
      "measured": true,
      "checks": [
        {
          "check": "robots_ai_bots",
          "status": "ok",
          "value": "7/7",
          "impact": 0
        },
        {
          "check": "llms_txt",
          "status": "err",
          "value": null,
          "impact": 4
        }
      ]
    }
  ],
  "computed_at": "2026-09-23T04:19:10Z",
  "livemode": true
}