Skip to content
HALOWERK

Signalwerk

review rating extract

Extracts every AggregateRating from JSON-LD (also nested and @graph), Microdata and RDFa of the start page or the supplied HTML (robots.txt respected, one fetch). Per rating: rated item type and name, ratingValue, bestRating/worstRating (schema.org/Google defaults 5 and 1 when omitted), reviewCount and ratingCount, a percent position on the declared scale and a proportional 5-star value. Checks flag missing values or counts (Google requires ratingCount or reviewCount), invalid scales and.

POST https://signal.halowerk.com/v1/review-rating-extract

Inputs

Fields of the published input schema
FieldTypeRequiredDescription
urlstringNoCompany domain or page URL (https:// is added when missing). Public pages only; robots.txt is respected; at most 5 fetches per call.
htmlstringNoAlready loaded HTML of one page (alternative to url). The company site is then not crawled.
base_urlstringNoURL the HTML was loaded from (required with html); used to resolve links.
Show full input schema
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "url": {
      "type": "string",
      "minLength": 3,
      "maxLength": 2048,
      "description": "Company domain or page URL (https:// is added when missing). Public pages only; robots.txt is respected; at most 5 fetches per call."
    },
    "html": {
      "type": "string",
      "minLength": 20,
      "maxLength": 3000000,
      "description": "Already loaded HTML of one page (alternative to url). The company site is then not crawled."
    },
    "base_url": {
      "type": "string",
      "format": "uri",
      "maxLength": 2048,
      "description": "URL the HTML was loaded from (required with html); used to resolve links."
    }
  }
}

Open original schema

Published input example

{
  "html": "<html><head><script type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"Product\",\"name\":\"Gartenbank Eiche\",\"aggregateRating\":{\"@type\":\"AggregateRating\",\"ratingValue\":\"4.6\",\"reviewCount\":\"128\"}}</script></head><body><h1>Gartenbank Eiche</h1></body></html>",
  "base_url": "https://halowerk.com/"
}

Result & documentation

Machine-readable documentation of this hub

Source of this page: the published HALOWERK catalog. Updated: 2026-11-17 UTC.

More endpoints in this hub

All endpoints in this hub โ†’