Schema library b2b-intel
Return a product changelog entry from a public page.
Pass this JSON Schema and a public source URL to/extract/json. Capture a public product change, release date, summary, and related links.
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 changelog entry.
Schema for individual product changelog or release note entries.
| Field | Type | What it holds |
|---|---|---|
company_name | string, required | Name of the company publishing the changelog. |
company_domain | string | Website domain of the company. |
product_name | string | Name of the specific product or component. |
version | string | Version number or release identifier. |
release_date | string, required | Date of this changelog entry or release. |
change_type | string, required | Type of change described in this entry. |
title | string, required | Title or headline of the changelog entry. |
description | string, required | Full description of the change. |
affected_products | array | Products or modules affected by this change. |
affected_plans | array | Pricing plans affected by this change. |
is_breaking | boolean | Whether this is a breaking change. |
migration_required | boolean | Whether migration steps are required for this change. |
migration_guide_url | string | URL to the migration guide for this change. |
changelog_url | string | URL of the changelog page. |
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-changelog-entry.json'
const res = await client.extract.json({
url: 'https://example.com/pricing',
json_schema: schema,
})tabstack extract json 'https://example.com/pricing' \
--schema @./product-changelog-entry.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: api documentation endpoint.
- Same category: company profile.
- Same category: competitor profile.
- The job rather than the object: the Extract API.