SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester

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

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

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

curl --request GET \
--url https://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/opportunities/{opportunity_id} \
--header 'Authorization: Bearer sk_live_your_key'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
"data": {
"opportunity": {
"id": "3f2b9c44-8f4e-4d0a-9c1b-2a7d6e5f1a23",
"site_id": "3f2b9c44-8f4e-4d0a-9c1b-2a7d6e5f1a23",
"kind": "fix_snippet",
"kind_label": "Rewrite the title and description",
"family": "content",
"pillar": "seo",
"action": "refresh",
"is_win": false,
"entity_type": "page",
"question_id": null,
"question": null,
"subject_key": null,
"task_id": null,
"page_id": 1335,
"query_id": 812,
"topic_id": 41,
"title": "Rewrite the title and description on /pricing",
"score": 59.28,
"score_components": {
"gap": {
"value": 1,
"weight": 0.3
},
"demand": {
"value": 0.62,
"weight": 0.22
}
},
"opportunity_clicks": 29,
"est_value": null,
"effort": "low",
"confidence": 0.666,
"status": "open",
"first_seen_on": "2026-05-01",
"last_seen_on": "2026-08-01",
"occurrence_count": 4,
"baseline_json": {
"clicks": 4,
"impressions": 900,
"position": 14.2
},
"evidence_json": {
"finding_count": 2
},
"recommendation_id": null,
"created_at": "2026-09-01T09:00:00.000Z",
"updated_at": "2026-09-01T09:00:00.000Z"
},
"history": [
{
"observed_on": "2026-08-01",
"event": "measured",
"from_status": "open",
"to_status": "in_progress",
"score": 48.2,
"opportunity_clicks": 29,
"clicks": 4,
"impressions": 900,
"position": 14.2,
"created_at": "2026-09-01T09:00:00.000Z"
}
]
}
}