SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
seo

Read one opportunity with how it has moved over time.

history is one row per month the opportunity was measured, so you can see whether it is getting better or worse before deciding what to do. baseline_json is what it looked like when it was first seen, which is what any later improvement is measured against.

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

Recent Requests

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

Path Params

site_idstringrequired
opportunity_idstringrequired

Headers

Authorizationstringrequired

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

Response

Response Body

opportunityobjectOne piece of work worth doing, scored and tracked across months. This is the unit the growth board is built from.
historyarray of objectsNewest first.

Request

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

Credentials

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

Response · 200

{
"data": {
"opportunity": {},
"history": []
}
}