SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
seo

Search performance totals, series, top pages and top keywords for a range.

Read this before writing any advice: it holds the real clicks, impressions and positions. range is 7d, 28d, 3m, 6m, 12m, all or custom with from/to.

GEThttps://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/analytics

Recent Requests

Log in to see full request history
TimeStatusUser Agent
Make a request to see history.

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

rangestring

7d, 28d, 3m, 6m, 12m, all or custom.

fromstring

Start date (YYYY-MM-DD) when range=custom.

tostring

End date (YYYY-MM-DD) when range=custom.

Response

Response Body

siteobjectA tracked website.
analyticsobjectrange, totals, series, top_pages, top_keywords, coverage and query visibility.

Request

import { SoftSolz } from '@softsolz/sdk';
const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });
const result = await client.seo.getSiteAnalytics('<site_id>', {});
console.log(result);

Credentials

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
"data": {
"site": {},
"analytics": {}
}
}