SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester

Titles, descriptions, headings, structured data, images and video across the site

Counts how many pages hit each check and lists the pages. Structured data is only asked for where it suits the page type, so a blog post is never told to add Product markup. Any one of the fitting types is enough, for example one of Article, BlogPosting or NewsArticle on an article. A check row carries the highest severity found on any page. Needs a crawl first.

GEThttps://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/on-page

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Path Params

site_idstringrequired

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Query Params

limitinteger

How many pages to scan, up to 5000.

checkstring

Only list the pages with this check, for example images_missing_alt (up to 500). An unknown check answers 400 unknown_check.

Response

Response Body

issuesobjectcounts per check, pages (the first 200 pages with a problem, or up to 500 pages for the check you asked for), pages_total (every page with a problem, so you can tell when the list was cut) and pages_scanned.
appearancesarray of objectsHow your pages appeared in Google.
discoverobjectDiscover traffic, when Google reports any.

Request

curl --request GET \
--url https://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/on-page \
--header 'Authorization: Bearer sk_live_your_key'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
"data": {
"issues": {
"counts": [],
"pages": [],
"pages_total": 0,
"pages_scanned": 0,
"check": null
},
"appearances": [
{
"period_start": "2026-08-01",
"appearance": "FAQ_RICH_SNIPPET",
"label": "Questions and answers",
"clicks": 320,
"impressions": 14000,
"position": 4.2
}
],
"discover": {
"rows": [],
"note": ""
}
}
}