Schema library e-commerce
Return a product review from a public page.
Pass this JSON Schema and a public source URL to/extract/json. Normalize public review text, rating, date, product, and reviewer fields allowed by the source and schema.
TEXT
MARKDOWN
LINKS
const res = await client.extract.json({
url: 'https://example.com/pricing',
json_schema: {
type: 'object',
properties: {
plan: { type: 'string' },
price: { type: 'number' },
},
},
})res = client.extract.json(
url='https://example.com/pricing',
json_schema={
'type': 'object',
'properties': {
'plan': {'type': 'string'},
'price': {'type': 'number'},
},
},
)tabstack extract json https://example.com/pricing \
--schema '{"type":"object","properties":{"plan":{"type":"string"},"price":{"type":"number"}}}'What it captures
Fields in this product review.
Schema for individual product reviews from e-commerce platforms.
| Field | Type | What it holds |
|---|---|---|
product_id | string | Platform product identifier (ASIN, SKU, etc.). |
product_name | string, required | Name of the reviewed product. |
platform | string, required | Platform where the review was posted. |
review_id | string | Platform-specific review identifier. |
reviewer_name | string | Display name of the reviewer. |
reviewer_verified_purchase | boolean | Whether the reviewer made a verified purchase. |
rating | number, required | Numeric star rating given by the reviewer. |
title | string | Title or headline of the review. |
body | string, required | Full text body of the review. |
review_date | string, required | Date the review was posted. |
helpful_votes | number | Number of helpful votes for this review. |
sentiment | string | Overall sentiment of the review. |
topics_mentioned | array | Key topics or aspects mentioned in the review. |
pros | array | List of positives mentioned in the review. |
cons | array | List of negatives mentioned in the review. |
seller_response | string | Seller or brand response to the review, if any. |
country | string | Country where the review was submitted from. |
language | string | Language of the review text (BCP 47 code). |
page_title | string | Title of the source page. Tabstack auto-fills this from page metadata when left empty. |
favicon | string | Favicon URL of the source page. Tabstack auto-fills this from page metadata when left empty. |
Example
Inspect and validate the response shape.
The example below is generated from the schema to demonstrate its structure. Edit the object or paste a real response to validate it in your browser.
What it checks
Pass or fail, and the first reason why.
Whether the text parses as JSON, whether the top level is an object, and whether each field the schema requires is present at the declared type. A null is allowed anywhere. Every key you ask for is present. A field the page does not state can come back null, empty, a placeholder number, or a guessed value. Validate values, not just keys.
Usage
Send the schema with your source URL.
The schema travels with the request rather than living on your account, so the same call can send a trimmed version for one page and the full one for another. Every key you ask for is present. A field the page does not state can come back null, empty, a placeholder number, or a guessed value. Validate values, not just keys.
import schema from './product-review.json'
const res = await client.extract.json({
url: 'https://example.com/pricing',
json_schema: schema,
})tabstack extract json 'https://example.com/pricing' \
--schema @./product-review.jsonAdaptation
Make the schema match your application.
The schema is a starting point, not a guarantee that every source page contains every field. Three things are worth doing before you write one into your system, and the schema-authoring guide covers the rest.
Remove what you do not need
A shorter schema is a smaller response and fewer fields to handle.
Describe the ambiguous ones
A description tells Extract what to look for when a label could mean two things.
Validate before you store
Check the returned object against the schema rather than trusting it.
Related
Related schemas
Other schemas in this category.
- Same category: category search results.
- Same category: grocery & cpg product.
- Same category: marketplace seller profile.
- The job rather than the object: the Extract API.