apyhub
Back
▣ DATA EXTRACTION · DATA VALIDATION

Validate Schema API

What it does

Schema Validator checks a webpage at a given URL and returns the structured data and metadata it finds. Send an http or https URL in the request body, and get back the page URL, any JSON-LD objects, microdata, meta tags, Open Graph data, Twitter card data, and a validation summary.

Use Schema Validator when you need to inspect how a page is exposing structured data for search engines and social platforms. The response summary includes warning and critical error counts, the total number of entities found, the types detected, an overall score, and any rich-results eligibility signals it can identify.

This is useful for SEO audits, content QA, and schema troubleshooting on product pages, articles, local business pages, and landing pages. You can confirm whether a page is emitting the markup you expect without parsing the HTML yourself.

If you need to compare what a page publishes across JSON-LD, microdata, and social metadata, Schema Validator gives you the structured result in one response.

POST
Validate Schema (Structured Data)
https://api.eu.apyhub.com/chisleroff/validate-schema

QUICKSTART

GUIDE

Quickstart

Check a webpage and return its structured metadata from the URL you provide.

curl -X POST "https://api.eu.apyhub.com/chisleroff/validate-schema" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://apyhub.com"}'

What you'll get back

Returns a JSON object with top-level fields such as url and source_url as strings, plus structured metadata objects/arrays like json_ld, microdata, open_graph, twitter_card, and meta_tags. It also includes a summary object with numeric and array fields describing the page analysis.

{
  "url": "https://apyhub.com",
  "json_ld": [],
  "summary": {
    "warnings": 0,
    "types_found": [],
    "overall_score": 0,
    "total_entities": 0,
    "critical_errors": 0,
    "rich_results_eligible": []
  },
  "meta_tags": {},
  "microdata": [],
  "open_graph": {},
  "source_url": "https://apyhub.com",
  "twitter_card": {}
}
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

Validates structured data found on a webpage URL and returns the extracted metadata and a validation summary. The request body requires a url field, and the response includes the source URL plus structured-data-related fields when available.

Request Body

ParameterTypeDescription
urlStringURL of the webpage to extract, audit, or validate content from. Must be a valid URI and use http or https.

Response

Returns a JSON object with top-level fields for the analyzed page URL, structured data extracts, and a summary object. The response includes url and source_url strings, json_ld and microdata arrays of objects, meta_tags, open_graph, and twitter_card objects, and a summary object with validation metrics.

ParameterTypeDescription
urlStringThe analyzed page URL.
json_ldObject ArrayJSON-LD objects extracted from the page.
summaryObjectValidation summary object containing scoring and counts.
summary.warningsIntegerNumber of warnings found.
summary.types_foundString ArrayTypes detected in the structured data.
summary.overall_scoreNumberOverall score for the page's structured data.
summary.total_entitiesIntegerTotal number of detected entities.
summary.critical_errorsIntegerNumber of critical errors found.
summary.rich_results_eligibleString ArrayRich result types the page is eligible for.
meta_tagsObjectMeta tag data extracted from the page. Additional properties may be present.
microdataObject ArrayMicrodata objects extracted from the page.
open_graphObjectOpen Graph data extracted from the page. Additional properties may be present.
source_urlStringSource URL associated with the extracted data.
twitter_cardObjectTwitter Card data extracted from the page. Additional properties may be present.
▣ 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.