diff --git a/docs/index.html b/docs/index.html index 48990af1d..b6c0dd16a 100644 --- a/docs/index.html +++ b/docs/index.html @@ -481,7 +481,7 @@ -
SpaceCat logo

Get a brand by ID (v2)

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

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  • "name": "Example Brand",
  • "status": "active",
  • "origin": "human",
  • "description": "An example brand",
  • "vertical": "technology",
  • "region": [
    ],
  • "urls": [],
  • "socialAccounts": [],
  • "earnedContent": [],
  • "brandAliases": [
    ],
  • "competitors": [],
  • "siteIds": [
    ],
  • "updatedAt": "2026-03-15T10:30:00Z",
  • "updatedBy": "user@adobe.com"
}

Get a brand by ID (v2)

Retrieves a single brand by its UUID for the given organization.

Authorizations:
ims_keyapi_key
path Parameters
spaceCatId
required
string <uuid>
Example: a1b2c3d4-5678-90ab-cdef-1234567890ab

SpaceCat Organization ID (UUID)

@@ -4363,7 +4363,7 @@ " class="sc-iKGpAq sc-cCYyou dXXcln cFvDiF">

Development server

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

Production server

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

Response samples

Content type
application/json
{
  • "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  • "name": "Example Brand",
  • "status": "active",
  • "origin": "human",
  • "description": "An example brand",
  • "vertical": "technology",
  • "region": [
    ],
  • "urls": [],
  • "socialAccounts": [],
  • "earnedContent": [],
  • "brandAliases": [
    ],
  • "competitors": [],
  • "siteIds": [
    ],
  • "updatedAt": "2026-03-15T10:30:00Z",
  • "updatedBy": "user@adobe.com"
}

Update a brand (v2)

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

Response samples

Content type
application/json
{
  • "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  • "name": "Example Brand",
  • "status": "active",
  • "origin": "human",
  • "description": "An example brand",
  • "vertical": "technology",
  • "region": [
    ],
  • "urls": [],
  • "socialAccounts": [],
  • "earnedContent": [],
  • "brandAliases": [
    ],
  • "competitors": [],
  • "siteIds": [
    ],
  • "updatedAt": "2026-03-15T10:30:00Z",
  • "updatedBy": "user@adobe.com"
}

Update a brand (v2)

Updates an existing brand. Only provided fields are updated. Nested arrays use full-replace semantics on each write.

@@ -4387,7 +4387,7 @@ " class="sc-iKGpAq sc-cCYyou dXXcln cFvDiF">

Development server

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

Production server

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

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  • "name": "Example Brand",
  • "status": "active",
  • "origin": "human",
  • "description": "An example brand",
  • "vertical": "technology",
  • "region": [
    ],
  • "urls": [],
  • "socialAccounts": [],
  • "earnedContent": [],
  • "brandAliases": [
    ],
  • "competitors": [],
  • "siteIds": [
    ],
  • "updatedAt": "2026-03-15T10:30:00Z",
  • "updatedBy": "user@adobe.com"
}

Delete a brand (v2)

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

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
  • "name": "Example Brand",
  • "status": "active",
  • "origin": "human",
  • "description": "An example brand",
  • "vertical": "technology",
  • "region": [
    ],
  • "urls": [],
  • "socialAccounts": [],
  • "earnedContent": [],
  • "brandAliases": [
    ],
  • "competitors": [],
  • "siteIds": [
    ],
  • "updatedAt": "2026-03-15T10:30:00Z",
  • "updatedBy": "user@adobe.com"
}

Delete a brand (v2)

Soft-deletes a brand by setting its status to deleted. The brand remains queryable with ?status=deleted.

@@ -4411,7 +4411,203 @@ " class="sc-iKGpAq sc-cCYyou dXXcln cFvDiF">

Development server

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

Production server

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

List topics for an organization (v2)

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

List categories for an organization (v2)

Returns all categories for the given organization, backed by +PostgREST/Aurora. By default, deleted categories are excluded. Use the +status query parameter to filter by specific status or include deleted +categories.

+
Authorizations:
ims_keyapi_key
path Parameters
spaceCatId
required
string <uuid>
Example: a1b2c3d4-5678-90ab-cdef-1234567890ab

SpaceCat Organization ID (UUID)

+
query Parameters
status
string
Enum: "active" "pending" "deleted" "ignored"
Example: status=active

Filter by category status. Default excludes deleted categories.

+

Responses

Response samples

Content type
application/json
{
  • "categories": [
    ]
}

Create a category (idempotent by name) (v2)

Creates a new category for the organization, idempotent by name.

+

Name matching is case-insensitive and whitespace-normalized (NFC), +so "Discovery & Research", " discovery & research ", and +"DISCOVERY & RESEARCH" resolve to the same category.

+

Behavior by outcome:

+
    +
  • New row inserted — returns 201 Created with the new row.
    • +
  • Existing row matched with identical fields — no-op; returns +200 OK with the existing row. Audit trail (updatedAt, +updatedBy) is preserved.
    • +
  • Existing row matched with differing fields — patch applied to +origin / status (with provenance guard: origin is never +downgraded from human to ai), returns 200 OK with the +updated row.
    • +
  • Soft-deleted row matched — resurrected: status flipped to +active, stable id (slug) preserved, returns 201 Created.
    • +
+

Clients discriminating creation from idempotent update should inspect +the HTTP status, not the response body (identical in both cases).

+

Duplicate-name reposts (the common DRS re-sync case) are absorbed by +design and do NOT produce 409. 409 is reserved for the two +orthogonal race conditions documented under the 409 response below.

+
Authorizations:
ims_keyapi_key
path Parameters
spaceCatId
required
string <uuid>
Example: a1b2c3d4-5678-90ab-cdef-1234567890ab

SpaceCat Organization ID (UUID)

+
query Parameters
status
string
Enum: "active" "pending" "deleted" "ignored"
Example: status=active

Filter by category status. Default excludes deleted categories.

+
Request Body schema: application/json
required
id
string

Client-supplied slug. Used only when inserting a brand-new row; for +existing rows the stored id is preserved (FK stability).

+
name
required
string

Human-readable category name. Canonicalized on write.

+
origin
string
Default: "human"
Enum: "human" "ai"

Provenance. Subject to the human→ai downgrade guard on existing rows.

+
status
string
Default: "active"
Enum: "active" "pending" "ignored"

Responses

Request samples

Content type
application/json
{
  • "id": "discovery-research",
  • "name": "Discovery & Research",
  • "origin": "human",
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "id": "baseurl-discovery-research",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "Discovery & Research",
  • "status": "active",
  • "origin": "human",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "updatedBy": "string"
}

Update a category (v2)

Updates an existing category. Only provided fields are updated. The +name field is canonicalized (trim + whitespace-collapse + NFC) on +write.

+
Authorizations:
ims_keyapi_key
path Parameters
spaceCatId
required
string <uuid>
Example: a1b2c3d4-5678-90ab-cdef-1234567890ab

SpaceCat Organization ID (UUID)

+
categoryId
required
string
Example: baseurl-discovery-research

Category business key (category_id slug)

+
Request Body schema: application/json
required
name
string

Human-readable category name. Canonicalized on write.

+
origin
string
Enum: "human" "ai"
status
string
Enum: "active" "pending" "deleted" "ignored"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "origin": "human",
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "id": "baseurl-discovery-research",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "Discovery & Research",
  • "status": "active",
  • "origin": "human",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": "string",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "updatedBy": "string"
}

Delete a category (v2)

Soft-deletes a category by setting its status to deleted. The +category remains queryable with ?status=deleted and can be +resurrected by POSTing a category with the same name.

+
Authorizations:
ims_keyapi_key
path Parameters
spaceCatId
required
string <uuid>
Example: a1b2c3d4-5678-90ab-cdef-1234567890ab

SpaceCat Organization ID (UUID)

+
categoryId
required
string
Example: baseurl-discovery-research

Category business key (category_id slug)

+

Responses

List topics for an organization (v2)

Returns all topics for the given organization, backed by PostgREST/Aurora. @@ -4439,7 +4635,7 @@ " class="sc-iKGpAq sc-cCYyou dXXcln cFvDiF">

Development server

https://spacecat.experiencecloud.live/api/ci/v2/orgs/{spaceCatId}/topics

Production server

-
https://spacecat.experiencecloud.live/api/v1/v2/orgs/{spaceCatId}/topics

Response samples

Content type
application/json
{
  • "topics": [
    ]
}

Create or upsert a topic (v2)

https://spacecat.experiencecloud.live/api/v1/v2/orgs/{spaceCatId}/topics

Response samples

Content type
application/json
{
  • "topics": [
    ]
}

Create or upsert a topic (v2)

Creates a new topic for the organization. If a topic with the same ID @@ -4467,6 +4663,16 @@ " class="sc-iKGpAq sc-cCYyou sc-cjERFZ dXXcln fTBBlJ dkmSdy">

User does not have access to this organization

Production server

-
https://spacecat.experiencecloud.live/api/v1/v2/orgs/{spaceCatId}/topics

Request samples

Content type
application/json
{
  • "id": "baseurl-discovery-research-topic",
  • "name": "Discovery & Research",
  • "description": "string",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "id": "baseurl-discovery-research-topic",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "Discovery & Research",
  • "description": "string",
  • "status": "active",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "updatedBy": "string"
}

Update a topic (v2)

https://spacecat.experiencecloud.live/api/v1/v2/orgs/{spaceCatId}/topics

Request samples

Content type
application/json
{
  • "id": "baseurl-discovery-research-topic",
  • "name": "Discovery & Research",
  • "description": "string",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "status": "active"
}

Response samples

Content type
application/json
{
  • "id": "baseurl-discovery-research-topic",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "Discovery & Research",
  • "description": "string",
  • "status": "active",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "updatedBy": "string"
}

Update a topic (v2)

Updates an existing topic. Only provided fields are updated.

Authorizations:
ims_keyapi_key
path Parameters
spaceCatId
required
string <uuid>
Example: a1b2c3d4-5678-90ab-cdef-1234567890ab

SpaceCat Organization ID (UUID)

@@ -4503,7 +4709,7 @@ " class="sc-iKGpAq sc-cCYyou dXXcln cFvDiF">

Development server

https://spacecat.experiencecloud.live/api/ci/v2/orgs/{spaceCatId}/topics/{topicId}

Production server

-
https://spacecat.experiencecloud.live/api/v1/v2/orgs/{spaceCatId}/topics/{topicId}

Request samples

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

Response samples

Content type
application/json
{
  • "id": "baseurl-discovery-research-topic",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "Discovery & Research",
  • "description": "string",
  • "status": "active",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "updatedBy": "string"
}

Delete a topic (v2)

https://spacecat.experiencecloud.live/api/v1/v2/orgs/{spaceCatId}/topics/{topicId}

Request samples

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

Response samples

Content type
application/json
{
  • "id": "baseurl-discovery-research-topic",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "Discovery & Research",
  • "description": "string",
  • "status": "active",
  • "brandId": "0e9bcbb3-096e-49f9-aeea-7a13a201eff5",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "updatedBy": "string"
}

Delete a topic (v2)

Soft-deletes a topic by setting its status to deleted. The topic remains queryable with ?status=deleted.

@@ -4569,7 +4775,7 @@ " class="sc-iKGpAq sc-cCYyou dXXcln cFvDiF">

Development server

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

Production server

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

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "limit": 0,
  • "page": 0
}

Create or upsert prompts (bulk)

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

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "total": 0,
  • "limit": 0,
  • "page": 0
}

Create or upsert prompts (bulk)

Upserts prompts. Match by id or by (text, regions). If match found, update; else insert.

Authorizations:
ims_keyapi_key
path Parameters
spaceCatId
required
string <uuid>

SpaceCat Organization ID (UUID)

@@ -4617,7 +4823,7 @@ " class="sc-iKGpAq sc-cCYyou dXXcln cFvDiF">

Development server

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

Production server

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

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "created": 0,
  • "updated": 0,
  • "prompts": [
    ]
}

Get 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

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "created": 0,
  • "updated": 0,
  • "prompts": [
    ]
}

Get a single prompt

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

prompt_id (business key)

Responses

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": "string",
  • "topicId": "string",
  • "status": "active",
  • "origin": "ai",
  • "source": "config",
  • "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": "string",
  • "topicId": "string",
  • "status": "active",
  • "origin": "ai",
  • "source": "config",
  • "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

prompt_id (business key)

Request Body schema: application/json
id
string

Optional business key; auto-generated if omitted

@@ -4653,7 +4859,7 @@ " class="sc-iKGpAq sc-cCYyou dXXcln cFvDiF">

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}

Request samples

Content type
application/json
{
  • "id": "string",
  • "prompt": "string",
  • "name": "string",
  • "regions": [ ],
  • "categoryId": "string",
  • "topicId": "string",
  • "status": "active",
  • "origin": "ai",
  • "source": "config"
}

Response samples

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

Soft-delete a prompt

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

Request samples

Content type
application/json
{
  • "id": "string",
  • "prompt": "string",
  • "name": "string",
  • "regions": [ ],
  • "categoryId": "string",
  • "topicId": "string",
  • "status": "active",
  • "origin": "ai",
  • "source": "config"
}

Response samples

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

Soft-delete a prompt

Sets status to 'deleted'.

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

prompt_id (business key)

@@ -4695,7 +4901,7 @@ " class="sc-iKGpAq sc-cCYyou dXXcln cFvDiF">

Development server

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

Production server

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

Request samples

Content type
application/json
{
  • "promptIds": [
    ]
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "failures": [
    ]
}

trigger

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

Request samples

Content type
application/json
{
  • "promptIds": [
    ]
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "failures": [
    ]
}

trigger

Trigger operations

Trigger an audit Deprecated

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/agentic-traffic/movers

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/agentic-traffic/movers

Response samples

Content type
application/json
[
  • {
    }
]

Brand presence citation detail for a URL

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/agentic-traffic/movers

Response samples

Content type
application/json
[
  • {
    }
]

URL Inspector aggregate stats and weekly sparklines

Returns aggregate citation statistics and weekly trend breakdown for the site. +Site ID is required via query parameter. Platform is optional — when absent, +no model filter is applied.

+
Authorizations:
api_keyims_key
path Parameters
spaceCatId
required
string <uuid>

Organization (SpaceCat) ID

+
brandId
required
string

Brand ID or "all" for unfiltered

+
query Parameters
siteId
required
string <uuid>

Site ID to scope the query

+
startDate
string <date>
Example: startDate=2026-01-01
endDate
string <date>
Example: endDate=2026-03-31
platform
string

LLM platform code (e.g. perplexity, openai). Omit for all models.

+
categoryId
string

Category ID or name to filter by

+
regionCode
string

Region code to filter by (e.g. US, DE)

+

Responses

Response samples

Content type
application/json
{
  • "stats": {
    },
  • "weeklyTrends": [
    ]
}

Paginated owned URL citations

Returns paginated per-URL citation aggregates with JSONB weekly arrays +for week-over-week trends. Owned URLs are those belonging to the site.

+
Authorizations:
api_keyims_key
path Parameters
spaceCatId
required
string <uuid>

Organization (SpaceCat) ID

+
brandId
required
string

Brand ID or "all" for unfiltered

+
query Parameters
siteId
required
string <uuid>
startDate
string <date>
endDate
string <date>
platform
string
categoryId
string
regionCode
string
page
integer >= 0
Default: 0

Zero-based page number

+
pageSize
integer [ 1 .. 1000 ]
Default: 50

Items per page (max 1000)

+

Responses

Response samples

Content type
application/json
{
  • "urls": [],
  • "totalCount": 100
}

Paginated non-owned (trending) URL citations

Returns paginated non-owned URL citations with per-prompt breakdown. +The RPC returns flat rows (one per URL+prompt); this endpoint groups +them by URL and calculates totalCitations per URL. +Rows with null URLs are filtered out.

+
Authorizations:
api_keyims_key
path Parameters
spaceCatId
required
string <uuid>

Organization (SpaceCat) ID

+
brandId
required
string

Brand ID or "all" for unfiltered

+
query Parameters
siteId
required
string <uuid>
startDate
string <date>
endDate
string <date>
platform
string
categoryId
string
regionCode
string
channel
string

Content channel filter (e.g. earned, social)

+
page
integer >= 0
Default: 0
pageSize
integer [ 1 .. 1000 ]
Default: 50

Responses

Response samples

Content type
application/json
{
  • "urls": [
    ],
  • "totalNonOwnedUrls": 500
}

Paginated domain-level citation aggregations

Returns paginated domain-level citation aggregations with dominant +content type per domain.

+
Authorizations:
api_keyims_key
path Parameters
spaceCatId
required
string <uuid>

Organization (SpaceCat) ID

+
brandId
required
string

Brand ID or "all" for unfiltered

+
query Parameters
siteId
required
string <uuid>
startDate
string <date>
endDate
string <date>
platform
string
categoryId
string
regionCode
string
channel
string
page
integer >= 0
Default: 0
pageSize
integer [ 1 .. 1000 ]
Default: 50

Responses

Response samples

Content type
application/json
{
  • "domains": [
    ],
  • "totalCount": 50
}

Paginated URLs within a cited domain (Phase 2 drilldown)

Returns paginated URLs within a specific domain. Used as a Phase 2 drilldown +from the cited-domains view. The underlying RPC does not accept brand, category, +or region filters — domain-level drilldown is already scoped by hostname.

+
Authorizations:
api_keyims_key
path Parameters
spaceCatId
required
string <uuid>

Organization (SpaceCat) ID

+
brandId
required
string

Brand ID or "all" for unfiltered

+
query Parameters
siteId
required
string <uuid>
hostname
required
string
Example: hostname=competitor.com

Domain hostname to drill into

+
startDate
string <date>
endDate
string <date>
platform
string
channel
string
page
integer >= 0
Default: 0
pageSize
integer [ 1 .. 1000 ]
Default: 50

Responses

Response samples

Content type
application/json
{
  • "urls": [
    ],
  • "totalCount": 100
}

Prompt breakdown for a specific URL (Phase 3 drilldown)

Returns the prompts that cited a specific URL. Used as a Phase 3 drilldown +from the domain-urls view. The underlying RPC does not accept brand, category, +or region filters — URL-level drilldown is scoped by url_id.

+
Authorizations:
api_keyims_key
path Parameters
spaceCatId
required
string <uuid>

Organization (SpaceCat) ID

+
brandId
required
string

Brand ID or "all" for unfiltered

+
query Parameters
siteId
required
string <uuid>
urlId
required
string
Example: urlId=44444444-4444-4444-4444-444444444444

URL identifier from the domain-urls response

+
startDate
string <date>
endDate
string <date>
platform
string

Responses

Response samples

Content type
application/json
{
  • "prompts": [
    ]
}

Brand presence citation detail for a URL

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/agentic-traffic/url-brand-presence

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/agentic-traffic/url-brand-presence

Response samples

Content type
application/json
{
  • "totalCitations": 314,
  • "totalMentions": 295,
  • "uniquePrompts": 47,
  • "weeklyTrends": [
    ],
  • "prompts": [
    ]
}

Get LLMO configuration

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/agentic-traffic/url-brand-presence

Response samples

Content type
application/json
{
  • "totalCitations": 314,
  • "totalMentions": 295,
  • "uniquePrompts": 47,
  • "weeklyTrends": [
    ],
  • "prompts": [
    ]
}

Get LLMO configuration

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/config

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/config

Response samples

Content type
application/json
{
  • "config": {
    },
  • "version": "abc123def456"
}

Update LLMO configuration

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/config

Response samples

Content type
application/json
{
  • "config": {
    },
  • "version": "abc123def456"
}

Update LLMO configuration

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/config

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/config

Request samples

Content type
application/json
{
  • "entities": {
    },
  • "categories": {},
  • "topics": {
    },
  • "aiTopics": {
    },
  • "brands": {
    },
  • "competitors": {},
  • "deleted": {
    },
  • "ignored": {
    }
}

Response samples

Content type
application/json
{
  • "version": "abc123def456"
}

Get LLMO questions

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/config

Request samples

Content type
application/json
{
  • "entities": {
    },
  • "categories": {},
  • "topics": {
    },
  • "aiTopics": {
    },
  • "brands": {
    },
  • "competitors": {},
  • "deleted": {
    },
  • "ignored": {
    }
}

Response samples

Content type
application/json
{
  • "version": "abc123def456"
}

Get LLMO questions

Retrieves all LLMO questions (both human and AI) for a specific site. Returns an object with Human and AI question arrays.

@@ -6251,7 +6617,7 @@ " class="sc-iKGpAq sc-cCYyou dXXcln cFvDiF">

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/questions

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/questions

Response samples

Content type
application/json
{
  • "Human": [
    ],
  • "AI": [
    ]
}

Add LLMO questions

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/questions

Response samples

Content type
application/json
{
  • "Human": [
    ],
  • "AI": [
    ]
}

Add LLMO questions

Adds new questions to the LLMO configuration for a specific site. Questions can be added to both Human and AI categories.

@@ -6273,7 +6639,7 @@ " class="sc-iKGpAq sc-cCYyou dXXcln cFvDiF">

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/questions

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/questions

Request samples

Content type
application/json
{
  • "Human": [
    ],
  • "AI": [
    ]
}

Response samples

Content type
application/json
{
  • "Human": [
    ],
  • "AI": [
    ]
}

Remove LLMO question

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/questions

Request samples

Content type
application/json
{
  • "Human": [
    ],
  • "AI": [
    ]
}

Response samples

Content type
application/json
{
  • "Human": [
    ],
  • "AI": [
    ]
}

Remove LLMO question

Removes a specific question from the LLMO configuration by its unique key. The question can be from either Human or AI categories.

@@ -6293,7 +6659,7 @@ " class="sc-iKGpAq sc-cCYyou dXXcln cFvDiF">

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/questions/{questionKey}

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/questions/{questionKey}

Response samples

Content type
application/json
{
  • "Human": [
    ],
  • "AI": [
    ]
}

Update LLMO question

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/questions/{questionKey}

Response samples

Content type
application/json
{
  • "Human": [
    ],
  • "AI": [
    ]
}

Update LLMO question

Updates a specific question in the LLMO configuration by its unique key. The question can be from either Human or AI categories.

@@ -6331,7 +6697,7 @@ " class="sc-iKGpAq sc-cCYyou dXXcln cFvDiF">

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/questions/{questionKey}

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/questions/{questionKey}

Request samples

Content type
application/json
{
  • "question": "What is the updated value proposition of this product?",
  • "source": "human",
  • "country": "US",
  • "product": "Adobe Creative Cloud",
  • "volume": "high",
  • "importTime": "2024-01-20T12:00:00Z",
  • "keyword": "creative software",
  • "url": "https://www.adobe.com/creativecloud.html",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "Human": [
    ],
  • "AI": [
    ]
}

Get LLMO customer intent

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/questions/{questionKey}

Request samples

Content type
application/json
{
  • "question": "What is the updated value proposition of this product?",
  • "source": "human",
  • "country": "US",
  • "product": "Adobe Creative Cloud",
  • "volume": "high",
  • "importTime": "2024-01-20T12:00:00Z",
  • "keyword": "creative software",
  • "url": "https://www.adobe.com/creativecloud.html",
  • "tags": [
    ]
}

Response samples

Content type
application/json
{
  • "Human": [
    ],
  • "AI": [
    ]
}

Get LLMO customer intent

Retrieves all LLMO customer intent key-value pairs for a specific site. Returns an array of customer intent items with key and value properties.

@@ -6349,7 +6715,7 @@ " class="sc-iKGpAq sc-cCYyou dXXcln cFvDiF">

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/customer-intent

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/customer-intent

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Add LLMO customer intent

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/customer-intent

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Add LLMO customer intent

Adds new customer intent items to the LLMO configuration for a specific site. Customer intent items are key-value pairs that define customer targeting and goals.

@@ -6371,7 +6737,7 @@ " class="sc-iKGpAq sc-cCYyou dXXcln cFvDiF">

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/customer-intent

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/customer-intent

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Remove LLMO customer intent item

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/customer-intent

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Remove LLMO customer intent item

Removes a specific customer intent item from the LLMO configuration by its key. The key should match an existing customer intent item.

@@ -6391,7 +6757,7 @@ " class="sc-iKGpAq sc-cCYyou dXXcln cFvDiF">

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/customer-intent/{intentKey}

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/customer-intent/{intentKey}

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Update LLMO customer intent item

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/customer-intent/{intentKey}

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Update LLMO customer intent item

Updates a specific customer intent item in the LLMO configuration by its key. You can update either the key, value, or both properties.

@@ -6415,7 +6781,7 @@ " class="sc-iKGpAq sc-cCYyou dXXcln cFvDiF">

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/customer-intent/{intentKey}

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/customer-intent/{intentKey}

Request samples

Content type
application/json
{
  • "key": "updated_target_audience",
  • "value": "enterprise customers"
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Update LLMO CDN logs filter configuration

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/customer-intent/{intentKey}

Request samples

Content type
application/json
{
  • "key": "updated_target_audience",
  • "value": "enterprise customers"
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Update LLMO CDN logs filter configuration

Updates the CDN logs filter configuration for a specific site.

Authorizations:
api_key
path Parameters
siteId
required
string <uuid> (Id)
Example: 123e4567-e89b-12d3-a456-426614174000

The site ID in uuid format

@@ -6433,7 +6799,7 @@ " class="sc-iKGpAq sc-cCYyou dXXcln cFvDiF">

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/cdn-logs-filter

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/cdn-logs-filter

Request samples

Content type
application/json
{
  • "cdnlogsFilter": [
    ]
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Update LLMO CDN bucket config configuration

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/cdn-logs-filter

Request samples

Content type
application/json
{
  • "cdnlogsFilter": [
    ]
}

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Update LLMO CDN bucket config configuration

Updates the CDN bucket config configuration for a specific site.

Authorizations:
api_key
path Parameters
siteId
required
string <uuid> (Id)
Example: 123e4567-e89b-12d3-a456-426614174000

The site ID in uuid format

@@ -6451,7 +6817,7 @@ " class="sc-iKGpAq sc-cCYyou dXXcln cFvDiF">

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/cdn-logs-bucket-config

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/cdn-logs-bucket-config

Request samples

Content type
application/json
{
  • "cdnBucketConfig": {
    }
}

Response samples

Content type
application/json
{
  • "bucketName": "my-cdn-logs-bucket",
  • "orgId": "org-12345",
  • "cdnProvider": "aem-cs-fastly"
}

Onboard new customer to LLMO

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/cdn-logs-bucket-config

Request samples

Content type
application/json
{
  • "cdnBucketConfig": {
    }
}

Response samples

Content type
application/json
{
  • "bucketName": "my-cdn-logs-bucket",
  • "orgId": "org-12345",
  • "cdnProvider": "aem-cs-fastly"
}

Onboard new customer to LLMO

Development server

https://spacecat.experiencecloud.live/api/ci/llmo/onboard

Production server

-
https://spacecat.experiencecloud.live/api/v1/llmo/onboard

Request samples

Content type
application/json
{
  • "domain": "example.com",
  • "brandName": "Example Brand",
  • "temp-onboarding": true
}

Response samples

Content type
application/json
{
  • "message": "LLMO onboarding initiated successfully",
  • "domain": "example.com",
  • "brandName": "Example Brand",
  • "imsOrgId": "1234567890ABCDEF@AdobeOrg",
  • "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  • "siteId": "987fcdeb-51a2-43d1-9f12-345678901234",
  • "detectedCdn": "aem-cs-fastly",
  • "status": "initiated",
  • "createdAt": "2025-01-15T10:30:00Z"
}

Offboard customer from LLMO

https://spacecat.experiencecloud.live/api/v1/llmo/onboard

Request samples

Content type
application/json
{
  • "domain": "example.com",
  • "brandName": "Example Brand",
  • "temp-onboarding": true
}

Response samples

Content type
application/json
{
  • "message": "LLMO onboarding initiated successfully",
  • "domain": "example.com",
  • "brandName": "Example Brand",
  • "imsOrgId": "1234567890ABCDEF@AdobeOrg",
  • "organizationId": "123e4567-e89b-12d3-a456-426614174000",
  • "siteId": "987fcdeb-51a2-43d1-9f12-345678901234",
  • "detectedCdn": "aem-cs-fastly",
  • "status": "initiated",
  • "createdAt": "2025-01-15T10:30:00Z"
}

Offboard customer from LLMO

Offboards a customer from LLMO (Large Language Model Optimizer). @@ -6505,7 +6871,7 @@ " class="sc-iKGpAq sc-cCYyou dXXcln cFvDiF">

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/offboard

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/offboard

Response samples

Content type
application/json
{
  • "message": "LLMO offboarding completed successfully",
  • "siteId": "987fcdeb-51a2-43d1-9f12-345678901234",
  • "baseURL": "https://example.com",
  • "status": "completed",
  • "completedAt": "2025-01-15T10:30:00Z"
}

Mark opportunities as reviewed

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/offboard

Response samples

Content type
application/json
{
  • "message": "LLMO offboarding completed successfully",
  • "siteId": "987fcdeb-51a2-43d1-9f12-345678901234",
  • "baseURL": "https://example.com",
  • "status": "completed",
  • "completedAt": "2025-01-15T10:30:00Z"
}

Mark opportunities as reviewed

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/opportunities-reviewed

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/opportunities-reviewed

Response samples

Content type
application/json
[
  • "opportunitiesReviewed"
]

Get brand claims presigned URL

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/opportunities-reviewed

Response samples

Content type
application/json
[
  • "opportunitiesReviewed"
]

Get brand claims presigned URL

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/brand-claims

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/brand-claims

Response samples

Content type
application/json
{
  • "siteId": "9ae8877a-bbf3-407d-9adb-d6a72ce3c5e3",
  • "model": "gpt-4.1",
  • "presignedUrl": "http://example.com",
  • "expiresAt": "2025-06-15T12:00:00.000Z"
}

Get presigned URL for summit demo brand presence fixture

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/brand-claims

Response samples

Content type
application/json
{
  • "siteId": "9ae8877a-bbf3-407d-9adb-d6a72ce3c5e3",
  • "model": "gpt-4.1",
  • "presignedUrl": "http://example.com",
  • "expiresAt": "2025-06-15T12:00:00.000Z"
}

Get presigned URL for summit demo brand presence fixture

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/strategy/demo/brand-presence

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/strategy/demo/brand-presence

Response samples

Content type
application/json
{}

Get presigned URL for summit demo recommendations fixture

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/strategy/demo/brand-presence

Response samples

Content type
application/json
{}

Get presigned URL for summit demo recommendations fixture

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/strategy/demo/recommendations

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/strategy/demo/recommendations

Response samples

Content type
application/json
{}

Create or update edge optimization configuration for an LLMO site +

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/strategy/demo/recommendations

Response samples

Content type
application/json
{}

Create or update edge optimization configuration for an LLMO site

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/edge-optimize-config

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/edge-optimize-config

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Retrieve edge optimization configuration for an LLMO site +

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/edge-optimize-config

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Retrieve edge optimization configuration for an LLMO site

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/edge-optimize-config

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/edge-optimize-config

Response samples

Content type
application/json
{ }

Add staging domains for edge optimize (stage environment support)

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/edge-optimize-config

Response samples

Content type
application/json
{ }

Add staging domains for edge optimize (stage environment support)

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/edge-optimize-config/stage

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/edge-optimize-config/stage

Request samples

Content type
application/json
{
  • "stagingDomains": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Check Edge Optimize status for a site path

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/edge-optimize-config/stage

Request samples

Content type
application/json
{
  • "stagingDomains": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Check Edge Optimize status for a site path

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/edge-optimize-status

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/edge-optimize-status

Response samples

Content type
application/json
{
  • "edgeOptimizeEnabled": true
}

Update edge optimize routing for a site

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/edge-optimize-status

Response samples

Content type
application/json
{
  • "edgeOptimizeEnabled": true
}

Update edge optimize routing for a site

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/edge-optimize-routing

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/edge-optimize-routing

Request samples

Content type
application/json
{
  • "cdnType": "aem-cs-fastly",
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "domain": "www.example.com",
  • "cdnType": "aem-cs-fastly"
}

Get LLMO strategy

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/edge-optimize-routing

Request samples

Content type
application/json
{
  • "cdnType": "aem-cs-fastly",
  • "enabled": true
}

Response samples

Content type
application/json
{
  • "enabled": true,
  • "domain": "www.example.com",
  • "cdnType": "aem-cs-fastly"
}

Get LLMO strategy

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/strategy

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/strategy

Response samples

Content type
application/json
{
  • "data": { },
  • "version": "abc123def456"
}

Save LLMO strategy

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/strategy

Response samples

Content type
application/json
{
  • "data": { },
  • "version": "abc123def456"
}

Save LLMO strategy

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/strategy

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/strategy

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "version": "abc123def456",
  • "notifications": {
    }
}

entitlements

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/strategy

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "version": "abc123def456",
  • "notifications": {
    }
}

entitlements

Entitlement management operations

List all entitlements for an organization

This endpoint retrieves all entitlements associated with a specific organization.

@@ -12027,9 +12393,12 @@ <p>Performance note: the underlying PostgREST query filters on <code>(scope_prefix, handler_name, projected_at, skipped)</code>. A composite index on these columns is required for acceptable query performance on large tables.</p> -<p>Auth note: DRS workers call this endpoint via admin <code>x-api-key</code>. The <code>drsBpPgAudit:read</code> -capability gates S2S JWT callers only; admin key access bypasses capability checks. This -is intentional — DRS runs in a separate AWS account without an S2S consumer registration.</p> +<p>Auth note: this endpoint is admin <code>x-api-key</code> only — S2S JWT consumers are denied at the +gate because the route is absent from <code>routeRequiredCapabilities</code> (and listed in +<code>INTERNAL_ROUTES</code> for visibility). DRS workers run in a separate AWS account without an +S2S consumer registration. If a future S2S consumer needs access, introduce a dedicated +resource-scoped capability (e.g. <code>drsBrandPresenceAudit:read</code>) rather than reusing the +site-scoped <code>audit:read</code> or a domain-bucket capability like <code>monitoring:read</code>.</p> <p>Results are paginated. Inspect <code>hasMore</code> in the response to determine whether additional pages exist. Increment <code>offset</code> by <code>limit</code> (default 500) and repeat while <code>hasMore</code> is <code>true</code>.</p> @@ -12051,9 +12420,12 @@

Performance note: the underlying PostgREST query filters on (scope_prefix, handler_name, projected_at, skipped). A composite index on these columns is required for acceptable query performance on large tables.

-

Auth note: DRS workers call this endpoint via admin x-api-key. The drsBpPgAudit:read -capability gates S2S JWT callers only; admin key access bypasses capability checks. This -is intentional — DRS runs in a separate AWS account without an S2S consumer registration.

+

Auth note: this endpoint is admin x-api-key only — S2S JWT consumers are denied at the +gate because the route is absent from routeRequiredCapabilities (and listed in +INTERNAL_ROUTES for visibility). DRS workers run in a separate AWS account without an +S2S consumer registration. If a future S2S consumer needs access, introduce a dedicated +resource-scoped capability (e.g. drsBrandPresenceAudit:read) rather than reusing the +site-scoped audit:read or a domain-bucket capability like monitoring:read.

Results are paginated. Inspect hasMore in the response to determine whether additional pages exist. Increment offset by limit (default 500) and repeat while hasMore is true.

@@ -12097,7 +12469,7 @@ " class="sc-iKGpAq sc-cCYyou dXXcln cFvDiF">

Production server

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

Response samples

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