SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester

Add a website to track

Creates a site from a domain. Connecting Search Console needs a Google account, which only the dashboard can do. 402 quota_exceeded means the plan allows no more sites; 409 site_exists means the domain is already tracked.

POSThttps://app.softsolz.uk/api/v1/services/seo/sites

Recent Requests

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

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

namestring

Display name. Defaults to the domain.

domainstring

Website address. Required unless a Search Console property is given.

timezonestring

IANA timezone for reporting. Defaults to UTC.

settings_jsonobject

brand_terms (string[]), thresholds, page_cap, query_page_cap.

refresh_frequencystring

daily, weekly or monthly.

visibilitystring

private, tenant or shared. Defaults to private, which a plain API key cannot read back, so send tenant for sites the API should keep seeing.

shared_user_idsarray of integers

Member ids when visibility is shared.

shared_role_idsarray of integers

Role ids when visibility is shared.

Response

Response Body

idstringWebsite id. Use it as site_id in every other call.
namestringDisplay name.
domainstringBare domain the site is tracked under.
gsc_property_urlstring | nullSearch Console property bound to this site, or null when not connected. Reports and history imports need this.
gsc_connection_idstring | nullGoogle connection carrying the property.
gsc_connection_statusstring | nullState of that Google connection: active, reconnect_required or revoked. Null when none is linked. Returned by the list and get calls.
gsc_connection_activebooleanTrue only when the linked Google connection is active. When false the site stops refreshing and reports cannot start until the account is reconnected or the property is bound again. Returned by the list and get calls.
links_schedulestringHow often the website is read on its own: off, weekly or monthly.
links_last_run_atstring | nullWhen the website was last read on its own.
bing_connection_idstring | nullBing Webmaster connection used for link imports.
bing_site_urlstring | nullBing Webmaster site used for link imports.
timezonestringIANA timezone used for reporting.
statusstringactive, paused or archived.
refresh_frequencystringdaily, weekly or monthly automatic refresh.
last_refresh_atstring | nullWhen Search Console data was last refreshed.
settings_jsonobjectBrand terms, thresholds and caps that tune the detectors.
visibilitystringprivate, tenant or shared. A plain API key only sees tenant-wide sites; a connected app sees what its member sees.
created_byinteger | nullMember who added the site.
created_atstringCreation time.
updated_atstringRound-trip as expected_updated_at on PATCH to avoid overwriting a newer edit.

Request

curl --request POST \
--url https://app.softsolz.uk/api/v1/services/seo/sites \
--header 'Authorization: Bearer sk_live_your_key' \
--header 'Content-Type: application/json' \
--data '{
"name": "Acme Bakery",
"domain": "acmebakery.co.uk",
"visibility": "tenant"
}'

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 · 201

{
"data": {
"id": "3f2b9c44-8f4e-4d0a-9c1b-2a7d6e5f1a23",
"name": "Acme Bakery",
"domain": "acmebakery.co.uk",
"gsc_property_url": "sc-domain:acmebakery.co.uk",
"gsc_connection_id": null,
"gsc_connection_status": "active",
"gsc_connection_active": true,
"links_schedule": "off",
"links_last_run_at": null,
"bing_connection_id": null,
"bing_site_url": null,
"timezone": "Europe/London",
"status": "active",
"refresh_frequency": "daily",
"last_refresh_at": null,
"settings_json": {
"brand_terms": [
"acme bakery"
]
},
"visibility": "tenant",
"created_by": 12,
"created_at": "2026-09-01T09:00:00.000Z",
"updated_at": "2026-09-01T09:00:00.000Z"
}
}