Read the link-checking schedule and brand phrases.

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

Recent Requests

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.

Response

Response Body

schedulestringoff, weekly or monthly automatic link checks.

last_run_atstring | nullLast scheduled run.

brand_phrasesarray of stringsPhrases searched for as mentions.

suggested_phrasesarray of stringsPhrases derived from the name and domain.

crawl_budgetinteger | nullPages per crawl override, null for the plan default.

respect_robotsbooleanWhether crawls obey robots.txt.

bing_connectedbooleanA Bing Webmaster key is connected.

bing_site_urlstring | nullBing site URL when connected.

Request

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

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

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

Credentials

Authorization

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

Response · 200

{
  "data": {
    "schedule": "string",
    "last_run_at": "string",
    "brand_phrases": [],
    "suggested_phrases": [],
    "crawl_budget": 0,
    "respect_robots": true,
    "bing_connected": true,
    "bing_site_url": "string"
  }
}