SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
seo

Track a keyword for a website.

409 already_tracked means it is already on the list; 402 quota_exceeded means the cap is reached.

POSThttps://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/keywords

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.

Idempotency-Keystring

Optional idempotency key for safe retries.

Body Params

query_textstring

The search to track.

Response

Response Body

idstringTracked keyword id.
query_textstringNormalised search text.
created_atstringWhen tracking started.

Request

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

Credentials

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

Response · 201

{
"data": {
"id": "string",
"query_text": "string",
"created_at": "string"
}
}