apyhub
▣ SEO

Check Rich Results API

What it does

Rich Results Checker audits a webpage URL for structured-data eligibility and returns which rich result types are eligible, which are not, and what fields are missing or present for each type.

Send a page URL and get back a summary with types_checked, eligible_count, and total_types_checked, plus detailed eligible and not_eligible lists. Each item includes the rich result type, a status, and the fields Google-style schema checks found as fields_missing, fields_present, and fields_recommended.

Use Rich Results Checker when you need to validate product pages, articles, recipes, events, or other pages before they go live. It helps you spot incomplete markup quickly so you can fix structured data issues that affect search appearance and indexing signals.

The response also includes the original url and source_url, making it straightforward to trace results back to the page you tested.

POST
Check Rich Results
https://api.eu.apyverse.com/chisleroff/check-rich-results

QUICKSTART

GUIDE

Quickstart

Check whether a webpage is eligible for rich results by sending its URL.

curl -X POST "https://api.eu.apyverse.com/chisleroff/check-rich-results" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com"}'

What you'll get back

Returns a JSON object with these top-level fields: url and source_url are URI strings, summary is an object, and eligible / not_eligible are arrays of result objects. summary includes types_checked, eligible_count, and total_types_checked.

{
  "url": "https://example.com",
  "summary": {
    "types_checked": ["Article"],
    "eligible_count": 1,
    "total_types_checked": 1
  },
  "eligible": [],
  "source_url": "https://example.com",
  "not_eligible": []
}
TRY ITLIVE · 100 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
body*
URL of the webpage to extract, audit, or validate content from (http/https only).

About this endpoint

What it does

Checks a webpage URL for rich result eligibility and returns a structured report for the URL you submit. The response includes summary counts plus per-type breakdowns of eligible and not eligible rich result types.

Request Body

ParameterTypeMandatoryDescription
urlStringYesURL of the webpage to extract, audit, or validate content from. Must be an HTTP/HTTPS URI.

Response

Returns a JSON object with url and source_url string URI fields, a summary object, and eligible and not_eligible arrays of objects. The summary object contains types_checked as a string array, eligible_count as an integer, and total_types_checked as an integer.

ParameterTypeMandatoryDescription
urlStringNoThe URL associated with the check result. Format: URI.
summaryObjectNoAggregate results for the check. Contains types_checked (string array), eligible_count (integer), and total_types_checked (integer).
summary.types_checkedString ArrayNoTypes that were checked.
summary.eligible_countIntegerNoCount of eligible types.
summary.total_types_checkedIntegerNoTotal number of types checked.
eligibleObject ArrayNoArray of eligible rich result type objects. Each item includes type (string), status (string), fields_missing (string array), fields_present (string array), and fields_recommended (string array).
eligible[].typeStringNoRich result type name.
eligible[].statusStringNoStatus for the rich result type.
eligible[].fields_missingString ArrayNoFields that are missing.
eligible[].fields_presentString ArrayNoFields that are present.
eligible[].fields_recommendedString ArrayNoFields that are recommended.
source_urlStringNoSource URL used for the result. Format: URI.
not_eligibleObject ArrayNoArray of not eligible rich result type objects. Each item includes type (string), status (string), fields_missing (string array), fields_present (string array), and fields_recommended (string array).
not_eligible[].typeStringNoRich result type name.
not_eligible[].statusStringNoStatus for the rich result type.
not_eligible[].fields_missingString ArrayNoFields that are missing.
not_eligible[].fields_presentString ArrayNoFields that are present.
not_eligible[].fields_recommendedString ArrayNoFields that are recommended.

Body

Name
Type
Description
bodyREQUIRED
object
—
▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.

Product
CatalogPricingQuickstartBecome a providerStatus (opens in new tab)
Company
AboutBlogCareers (opens in new tab)Contact
Legal
Terms of ServicePrivacy PolicyProvider terms
© 2026 APYHUB · BUILT FOR DEVELOPERS