Read the suggestions on file for a keyword plus the evidence to write new ones from.

advice is null until someone writes suggestions. evidence always carries the current position, previous position, impressions, clicks, CTR and the pages ranking for the keyword. Write suggestions from these numbers, then PUT them back.

GEThttps://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/keywords/{keyword_id}/advice

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

site_idstringrequired

keyword_idstringrequired

Headers

Authorizationstringrequired

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

Response

Response Body

adviceobjectSuggestions on file, or null.

evidenceobjectSearch Console facts for the keyword.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.seo.getSiteKeywordAdvice('<site_id>', '<keyword_id>');
console.log(result);

Credentials

Authorization

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

Response · 200

{
  "data": {
    "advice": {},
    "evidence": {}
  }
}