Read one content brief.

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

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

site_idstringrequired

brief_idstringrequired

Headers

Authorizationstringrequired

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

Response

Response Body

briefobjectA plan for one page: what it must cover, in what order, and which searches it is for. Written from Search Console evidence, never from a guess about what competitors do.

Request

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

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

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

Credentials

Authorization

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

Response · 200

{
  "data": {
    "brief": {}
  }
}