diff --git a/docs/index.html b/docs/index.html index 7d7cb39423..8d05c208f7 100644 --- a/docs/index.html +++ b/docs/index.html @@ -567,7 +567,7 @@ 55.627 l 55.6165,55.627 -231.245496,231.24803 c -127.185,127.1864 -231.5279,231.248 -231.873,231.248 -0.3451,0 -104.688, -104.0616 -231.873,-231.248 z - " fill="currentColor">

SpaceCat API (1.667.0)

Download OpenAPI specification:

SpaceCat API (1.676.0)

Download OpenAPI specification:

The SpaceCat API is used to manage edge delivery site directory and obtain audit information.

Authentication

api_key

DEPRECATED, use scoped_api_key or ims_key. (Used for read-only operations.)

@@ -5755,7 +5755,9 @@ " class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">

The search query prompt text

name
string

Display name (defaults to prompt slice)

-
regions
Array of strings
Default: []
categoryId
string
topicId
string
status
string
Default: "active"
Enum: "active" "pending" "deleted"
origin
string
Default: "human"
Enum: "ai" "human"
source
string
Default: "config"
regions
Array of strings
Default: []
categoryId
string
topicId
string
status
string
Default: "active"
Enum: "active" "pending" "deleted"
origin
string
Default: "human"
Enum: "ai" "human"

Who authored the prompt's text. SERVICE-PRINCIPAL-ONLY and read-only for end users: a user-authenticated request (IMS/JWT) has this field IGNORED (never rejected) and the value derived as human; only a service principal (e.g. the generation pipeline) may assert it, validated against the enum. It is never patched on update — it is fixed by the writer that created the row (origin-dimension.md §3).

+
source
string
Default: "config"

The source system or process that created the prompt

intent
string

Optional search-intent bucket for the prompt. Normalized on write: the value is lowercased, legacy aliases are remapped (statistical/navigational -> informational, commercial -> transactional), and the result is validated against the canonical buckets. An absent, empty, or (post-remap) invalid value is stored as null (NULL) — it is NOT coerced to a default bucket. Canonical buckets (mirror DRS prompt generation): informational, instructional, comparative, transactional, planning, delegation. No enum constraint is applied to the input: legacy aliases (statistical, navigational, commercial) are accepted and normalized on write.

@@ -5787,7 +5789,9 @@ " class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">

Development server

https://spacecat.experiencecloud.live/api/ci/v2/orgs/{spaceCatId}/brands/{brandId}/prompts/{promptId}

Production server

-
https://spacecat.experiencecloud.live/api/v1/v2/orgs/{spaceCatId}/brands/{brandId}/prompts/{promptId}

Response samples

Content type
application/json
{
  • "id": "photoshop-prompt-1",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "prompt": "string",
  • "name": "string",
  • "regions": [
    ],
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
  • "topicId": "string",
  • "status": "active",
  • "origin": "ai",
  • "source": "config",
  • "intent": "informational",
  • "updatedAt": "2024-01-19T14:20:30Z",
  • "updatedBy": "string",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "brandName": "string",
  • "category": {
    },
  • "topic": {
    }
}

Update a single prompt

Authorizations:
ims_keyapi_key
path Parameters
spaceCatId
required
string <uuid>
brandId
required
string
promptId
required
string
https://spacecat.experiencecloud.live/api/v1/v2/orgs/{spaceCatId}/brands/{brandId}/prompts/{promptId}

Response samples

Content type
application/json
{
  • "id": "photoshop-prompt-1",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "prompt": "string",
  • "name": "string",
  • "regions": [
    ],
  • "categoryId": "337f5e5d-288b-40d5-be14-901cc3acacc0",
  • "topicId": "string",
  • "status": "active",
  • "origin": "ai",
  • "source": "config",
  • "intent": "informational",
  • "updatedAt": "2024-01-19T14:20:30Z",
  • "updatedBy": "string",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "brandName": "string",
  • "category": {
    },
  • "topic": {
    }
}

Update a single prompt

Updates a single prompt. origin is NOT patchable — it is fixed by the writer that created the row and is never re-derived on update (origin-dimension.md §3 item 3); an origin in the body is ignored, leaving the stored value untouched.

+
Authorizations:
ims_keyapi_key
path Parameters
spaceCatId
required
string <uuid>
brandId
required
string
promptId
required
string

prompt_id (business key)

Request Body schema: application/json
id
string

Optional business key; auto-generated if omitted

@@ -5795,7 +5799,9 @@ " class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">

The search query prompt text

name
string

Display name (defaults to prompt slice)

-
regions
Array of strings
Default: []
categoryId
string
topicId
string
status
string
Default: "active"
Enum: "active" "pending" "deleted"
origin
string
Default: "human"
Enum: "ai" "human"
source
string
Default: "config"
regions
Array of strings
Default: []
categoryId
string
topicId
string
status
string
Default: "active"
Enum: "active" "pending" "deleted"
origin
string
Default: "human"
Enum: "ai" "human"

Who authored the prompt's text. SERVICE-PRINCIPAL-ONLY and read-only for end users: a user-authenticated request (IMS/JWT) has this field IGNORED (never rejected) and the value derived as human; only a service principal (e.g. the generation pipeline) may assert it, validated against the enum. It is never patched on update — it is fixed by the writer that created the row (origin-dimension.md §3).

+
source
string
Default: "config"

The source system or process that created the prompt

intent
string

Optional search-intent bucket for the prompt. Normalized on write: the value is lowercased, legacy aliases are remapped (statistical/navigational -> informational, commercial -> transactional), and the result is validated against the canonical buckets. An absent, empty, or (post-remap) invalid value is stored as null (NULL) — it is NOT coerced to a default bucket. Canonical buckets (mirror DRS prompt generation): informational, instructional, comparative, transactional, planning, delegation. No enum constraint is applied to the input: legacy aliases (statistical, navigational, commercial) are accepted and normalized on write.

@@ -10371,8 +10377,10 @@

Behaviour notes

" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">

Akamai contract ID.

groupId
required
string^grp_[A-Za-z0-9]+$

Akamai group ID.

-
insertIndex
integer >= 0

Optional position among the existing (non-managed) top-level rules to insert the managed wrapper at. Defaults to 0 (before everything); clamped to the number of existing children.

+
insertIndex
integer >= 0

Optional position among the existing (non-managed) top-level rules to insert the managed wrapper at. Defaults to appending AFTER all existing children (so the Optimize-at-Edge origin/cacheId win, since Akamai is last-match-wins); an explicit value is clamped to the number of existing children.

+
baseVersion
integer >= 1

(deploy only) Optional property version to copy the new version from. Defaults to the property's latest version.

Responses

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/cdn-onboard/akamai/plan

Request samples

Content type
application/json
{
  • "propertyId": "prp_1253269",
  • "contractId": "ctr_1-ABC123",
  • "groupId": "grp_18385",
  • "insertIndex": 0
}

Response samples

Content type
application/json
{
  • "propertyId": "string",
  • "latestVersion": 0,
  • "ruleFormat": "string",
  • "managedRules": [
    ],
  • "currentChildRules": [
    ],
  • "mergedChildRules": [
    ],
  • "validated": true,
  • "errors": [
    ],
  • "warnings": [
    ],
  • "merged": { }
}

Create a new property version with the Edge Optimize rules

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/cdn-onboard/akamai/plan

Request samples

Content type
application/json
{
  • "propertyId": "prp_1253269",
  • "contractId": "ctr_1-ABC123",
  • "groupId": "grp_18385",
  • "insertIndex": 0,
  • "baseVersion": 1
}

Response samples

Content type
application/json
{
  • "propertyId": "string",
  • "latestVersion": 0,
  • "ruleFormat": "string",
  • "managedRules": [
    ],
  • "currentChildRules": [
    ],
  • "mergedChildRules": [
    ],
  • "validated": true,
  • "errors": [
    ],
  • "warnings": [
    ],
  • "merged": { }
}

Create a new property version with the Edge Optimize rules

Creates a NEW property version from the latest, merges the managed Edge Optimize rules into -it, and PUTs the rule tree with Akamai-side validation. Does NOT activate — activation is a +" class="sc-iJuXkV sc-cBNeAB iNuSsz jtfGmi">

Creates a NEW property version from baseVersion (default: latest), merges the managed Edge +Optimize rules into it, and PUTs the rule tree with Akamai-side validation. Only supported for +properties whose default origin uses "Choose Your Own" (CUSTOM) SSL verification; a property on +"Use Platform Settings" is rejected with 400. Does NOT activate — activation is a separate, explicit step. Guarded so the target property must serve the site's own domain on an active hostname. Idempotent by rule name: the merge replaces any previously-managed rules rather than duplicating them.

@@ -10427,8 +10439,10 @@

Behaviour notes

" class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">

Akamai contract ID.

groupId
required
string^grp_[A-Za-z0-9]+$

Akamai group ID.

-
insertIndex
integer >= 0

Optional position among the existing (non-managed) top-level rules to insert the managed wrapper at. Defaults to 0 (before everything); clamped to the number of existing children.

+
insertIndex
integer >= 0

Optional position among the existing (non-managed) top-level rules to insert the managed wrapper at. Defaults to appending AFTER all existing children (so the Optimize-at-Edge origin/cacheId win, since Akamai is last-match-wins); an explicit value is clamped to the number of existing children.

+
baseVersion
integer >= 1

(deploy only) Optional property version to copy the new version from. Defaults to the property's latest version.

Responses

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/cdn-onboard/akamai/deploy

Request samples

Content type
application/json
{
  • "propertyId": "prp_1253269",
  • "contractId": "ctr_1-ABC123",
  • "groupId": "grp_18385",
  • "insertIndex": 0
}

Response samples

Content type
application/json
{
  • "propertyId": "string",
  • "baseVersion": 0,
  • "newVersion": 0,
  • "managedRules": [
    ],
  • "warnings": [
    ]
}

Activate a property version to STAGING or PRODUCTION

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/cdn-onboard/akamai/deploy

Request samples

Content type
application/json
{
  • "propertyId": "prp_1253269",
  • "contractId": "ctr_1-ABC123",
  • "groupId": "grp_18385",
  • "insertIndex": 0,
  • "baseVersion": 1
}

Response samples

Content type
application/json
{
  • "propertyId": "string",
  • "baseVersion": 0,
  • "newVersion": 0,
  • "managedRules": [
    ],
  • "warnings": [
    ]
}

Activate a property version to STAGING or PRODUCTION

Behaviour notes " class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">

Akamai contract ID.

groupId
required
string^grp_[A-Za-z0-9]+$

Akamai group ID.

-
insertIndex
integer >= 0

Optional position among the existing (non-managed) top-level rules to insert the managed wrapper at. Defaults to 0 (before everything); clamped to the number of existing children.

+
insertIndex
integer >= 0

Optional position among the existing (non-managed) top-level rules to insert the managed wrapper at. Defaults to appending AFTER all existing children (so the Optimize-at-Edge origin/cacheId win, since Akamai is last-match-wins); an explicit value is clamped to the number of existing children.

+
baseVersion
integer >= 1

(deploy only) Optional property version to copy the new version from. Defaults to the property's latest version.

network
string
Default: "STAGING"
Enum: "STAGING" "PRODUCTION"

Activation network. Defaults to STAGING.

version
integer >= 1
Behaviour notes " class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/cdn-onboard/akamai/activate

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/cdn-onboard/akamai/activate

Request samples

Content type
application/json
{
  • "propertyId": "prp_1253269",
  • "contractId": "ctr_1-ABC123",
  • "groupId": "grp_18385",
  • "insertIndex": 0,
  • "network": "STAGING",
  • "version": 1
}

Response samples

Content type
application/json
{
  • "propertyId": "string",
  • "version": 0,
  • "network": "STAGING",
  • "activationId": "atv_123",
  • "activationLink": "string"
}

Check the status of an Akamai activation

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/cdn-onboard/akamai/activate

Request samples

Content type
application/json
{
  • "propertyId": "prp_1253269",
  • "contractId": "ctr_1-ABC123",
  • "groupId": "grp_18385",
  • "insertIndex": 0,
  • "baseVersion": 1,
  • "network": "STAGING",
  • "version": 1
}

Response samples

Content type
application/json
{
  • "propertyId": "string",
  • "version": 0,
  • "network": "STAGING",
  • "activationId": "atv_123",
  • "activationLink": "string"
}

Check the status of an Akamai activation

Returns the status of an activation. With activationId, checks that specific activation @@ -14794,30 +14810,34 @@

Filters

https://spacecat.experiencecloud.live/api/ci/v2/orgs/{spaceCatId}/brands/{brandId}/serenity/deactivate

Production server

https://spacecat.experiencecloud.live/api/v1/v2/orgs/{spaceCatId}/brands/{brandId}/serenity/deactivate

Response samples

Content type
application/json
{
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "status": "pending"
}

Filter dimensions for the Serenity URL Inspector dashboard

Returns the option universe for the URL Inspector Brand/Region/Topic/ -Category/Intent/Origin filter dropdowns, sourced from the Semrush Brands, -Markets, and Topics elements (not from Adobe Postgres). Unlike the -cascading /brand-presence/filter-dimensions endpoint, this read is not -itself filtered by any of the dimensions it returns — it defines what -those dropdowns can show.

+Category/Intent/Origin/Content-Type filter dropdowns, sourced from the +Semrush Brands, Markets, Topics, and Content Types elements (not from +Adobe Postgres). Unlike the cascading /brand-presence/filter-dimensions +endpoint, this read is not itself filtered by any of the dimensions it +returns — it defines what those dropdowns can show.

topics/categories/page_intents/origins are derived from the same underlying Topics element response, split apart by their topic__/ category__/intent__/source__ tag prefix. Any other tag prefix Semrush introduces later (e.g. type__branded) surfaces automatically as an extra array property keyed by that prefix. Bare prefix declarations with no -value (e.g. a lone category row) are ignored — see +value (e.g. a lone category row) are ignored. content_types is +sourced from a separate Content Types element (Semrush domain_type +values) scoped to the same model/date window — see SerenityUrlInspectorFilterDimensions.

Authorizations:
ims_key
path Parameters
spaceCatId
required
string <uuid>

SpaceCat Organization ID (UUID)

@@ -14831,8 +14851,16 @@

Filters

server-side). Defaults to search-gpt when omitted or unrecognized.

platform
string

Legacy alias for model; model takes precedence when both are given.

-
projectId
string <uuid>
projectId
string <uuid>

Semrush project UUID to scope the Topics element to a specific market.

+
startDate
string <date>

ISO date (YYYY-MM-DD) scoping the Content Types element's date window. +Defaults to 28 days before endDate.

+
endDate
string <date>

ISO date (YYYY-MM-DD) scoping the Content Types element's date window. +Defaults to today.

Responses

Production server

-
https://spacecat.experiencecloud.live/api/v1/v2/orgs/{spaceCatId}/brands/{brandId}/serenity/brand-presence/url-inspector/filter-dimensions

Response samples

Content type
application/json
{
  • "brands": [
    ],
  • "regions": [
    ],
  • "topics": [
    ],
  • "categories": [
    ],
  • "page_intents": [
    ],
  • "origins": [
    ],
  • "tags": [
    ],
  • "property1": [
    ],
  • "property2": [
    ]
}

Weekly Market Tracking Trends for the Brand Presence Competitor Comparison chart

https://spacecat.experiencecloud.live/api/v1/v2/orgs/{spaceCatId}/brands/{brandId}/serenity/brand-presence/url-inspector/filter-dimensions

Response samples

Content type
application/json
{
  • "brands": [
    ],
  • "regions": [
    ],
  • "topics": [
    ],
  • "categories": [
    ],
  • "page_intents": [
    ],
  • "origins": [
    ],
  • "content_types": [
    ],
  • "tags": [
    ],
  • "property1": [
    ],
  • "property2": [
    ]
}

Weekly Market Tracking Trends for the Brand Presence Competitor Comparison chart

Filters " class="sc-iJuXkV sc-cBNeAB iNuSsz dyntKg">

Production server

https://spacecat.experiencecloud.live/api/v1/monitoring/drs-bp-pg-audit

Response samples

Content type
application/json
{
  • "rows": [
    ],
  • "hasMore": true
}