Skip to content

Check a product page

POST
/mc4p/page-checks
curl --request POST \
--url https://api.mintall.ai/api/v1/mc4p/page-checks \
--header 'Content-Type: application/json' \
--data '{ "url": "example", "freshness": "cached" }'

Fetch a public product page, extract the commercial facts, and report whether an MC4P document is present on it.

freshness: cached serves a recent observation of the page. freshness: fresh refetches it. Fresh checks are rate limited per caller and return 429 once the limit is reached.

Media typeapplication/json
PageCheckRequest
object
url
required
Url
string
<= 2048 characters
freshness
Freshness
string
default: cached
Allowed values: cached fresh

Successful Response

Media typeapplication/json
PageCheckResponse

The full report for one page check.

object
id
required
Id
string format: uuid
url
required
Url
string
final_url
Any of:
string
fetched_at
required
Fetched At
string format: date-time
platform_detected
required
Platform Detected
string
Allowed values: shopify woocommerce custom
verdict
required
Verdict
string
facts
required
ProductFactsResponse

Every fact the page stated, each with where it was read.

A null field means the page did not state it.

object
name
Any of:
ProductFactResponse
object
value
required
Value
string
source
required
Source
string
field
required
Field
string
description
Any of:
ProductFactResponse
object
value
required
Value
string
source
required
Source
string
field
required
Field
string
price
Any of:
ProductFactResponse
object
value
required
Value
string
source
required
Source
string
field
required
Field
string
currency
Any of:
ProductFactResponse
object
value
required
Value
string
source
required
Source
string
field
required
Field
string
availability
Any of:
ProductFactResponse
object
value
required
Value
string
source
required
Source
string
field
required
Field
string
sku
Any of:
ProductFactResponse
object
value
required
Value
string
source
required
Source
string
field
required
Field
string
brand
Any of:
ProductFactResponse
object
value
required
Value
string
source
required
Source
string
field
required
Field
string
images
Images
Array<object>
default:
ProductFactResponse
object
value
required
Value
string
source
required
Source
string
field
required
Field
string
mc4p
required
Mc4pPresenceResponse
object
present
Present
boolean
shape
Any of:
string
snapshot_at
Any of:
string
canonical_source
Any of:
string
product_id
Any of:
string
issued_to
Any of:
string
status
Any of:
string
Allowed values: verified failed unverified
checks
Any of:
object
key
additional properties
any
findings
Findings
Array<string>
default:
warnings
Warnings
Array<string>
default:
errors
Errors
Array<string>
default:
Example
{
"platform_detected": "shopify",
"facts": {
"images": []
},
"mc4p": {
"present": false,
"status": "verified"
},
"findings": [],
"warnings": [],
"errors": []
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}

Fresh page check rate limit reached.

The page check failed.