GET /v1/commerce/catalog-sync/health

GET/v1/commerce/catalog-sync/health

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Responses

200OK

active_productsinteger<int64>required

failed_countinteger<int64>required

health_percentinteger<int32>required

mapped_countinteger<int64>required

synced_countinteger<int64>required

defaultError

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X GET "/v1/commerce/catalog-sync/health"

const response = await fetch("/v1/commerce/catalog-sync/health", {
  method: "GET"
});

import requests

response = requests.get(
    "/v1/commerce/catalog-sync/health",
)

Response

{
  "active_products": 0,
  "failed_count": 0,
  "health_percent": 0,
  "mapped_count": 0,
  "synced_count": 0
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}