SpaceCat API (1.169.0)
Download OpenAPI specification:
SpaceCat API (1.173.0)
Download OpenAPI specification:
The SpaceCat API is used to manage edge delivery site directory and obtain audit information.
api_key
DEPRECATED, use scoped_api_key or ims_key. (Used for read-only operations.)
@@ -557,7 +557,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/organizations/{organizationId}/sitesProduction server
-https://spacecat.experiencecloud.live/api/v1/organizations/{organizationId}/sitesResponse samples
- 200
Content typeapplication/json[- {
- "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Site",
- "deliveryType": "aem_edge",
- "deliveryConfig": {
- "programId": "12652",
- "environmentId": "16854",
- "siteId": "1234"
- "goLiveDate": "2024-01-20T10:00:00Z",
- "config": {
- "slack": {
- "channel": "C1234567890",
- "workspace": "example-workspace"
- "handlers": {
- "404": {
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "broken-backlinks": {
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "excludedURLs": {
- "description": "URLs to be excluded from the alert",
- "type": "array",
- "items": {
- "type": "string",
- "format": "uri'"
- "groupedURLs": {
- "description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the URL group",
- "type": "string"
- "pattern": {
- "description": "Pattern representing the URL path structure to group",
- "type": "string"
- "contentAiConfig": {
- "index": "example-index-name"
- "cdnLogsConfig": {
- "bucketName": "test-bucket",
- "filters": [
- {
- "key": "test-key",
- "value": [
- "test-value"
- "outputLocation": "test-output-location"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Response samples
- 200
Content typeapplication/json[- {
- "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Site",
- "deliveryType": "aem_edge",
- "deliveryConfig": {
- "programId": "12652",
- "environmentId": "16854",
- "siteId": "1234"
- "goLiveDate": "2024-01-20T10:00:00Z",
- "config": {
- "slack": {
- "channel": "C1234567890",
- "workspace": "example-workspace"
- "handlers": {
- "404": {
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "broken-backlinks": {
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "excludedURLs": {
- "description": "URLs to be excluded from the alert",
- "type": "array",
- "items": {
- "type": "string",
- "format": "uri'"
- "groupedURLs": {
- "description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the URL group",
- "type": "string"
- "pattern": {
- "description": "Pattern representing the URL path structure to group",
- "type": "string"
- "contentAiConfig": {
- "index": "example-index-name"
- "cdnLogsConfig": {
- "bucketName": "test-bucket",
- "filters": [
- {
- "key": "test-key",
- "value": [
- "test-value"
- "outputLocation": "test-output-location"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Create a new site
This endpoint is useful for creating a new site.
Authorizations:
admin_keyRequest Body schema: application/json
requiredname stringThe name of the site
@@ -579,7 +579,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sitesProduction server
-https://spacecat.experiencecloud.live/api/v1/sitesRequest samples
- Payload
Content typeapplication/json{- "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "deliveryType": "aem_cs",
- "name": "New Site"
Response samples
- 201
Content typeapplication/json{- "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Site",
- "deliveryType": "aem_edge",
- "deliveryConfig": {
- "programId": "12652",
- "environmentId": "16854",
- "siteId": "1234"
- "goLiveDate": "2024-01-20T10:00:00Z",
- "config": {
- "slack": {
- "channel": "C1234567890",
- "workspace": "example-workspace"
- "handlers": {
- "404": {
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "broken-backlinks": {
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "excludedURLs": {
- "description": "URLs to be excluded from the alert",
- "type": "array",
- "items": {
- "type": "string",
- "format": "uri'"
- "groupedURLs": {
- "description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the URL group",
- "type": "string"
- "pattern": {
- "description": "Pattern representing the URL path structure to group",
- "type": "string"
- "contentAiConfig": {
- "index": "example-index-name"
- "cdnLogsConfig": {
- "bucketName": "test-bucket",
- "filters": [
- {
- "key": "test-key",
- "value": [
- "test-value"
- "outputLocation": "test-output-location"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Request samples
- Payload
Content typeapplication/json{- "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "deliveryType": "aem_cs",
- "name": "New Site"
Response samples
- 201
Content typeapplication/json{- "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Site",
- "deliveryType": "aem_edge",
- "deliveryConfig": {
- "programId": "12652",
- "environmentId": "16854",
- "siteId": "1234"
- "goLiveDate": "2024-01-20T10:00:00Z",
- "config": {
- "slack": {
- "channel": "C1234567890",
- "workspace": "example-workspace"
- "handlers": {
- "404": {
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "broken-backlinks": {
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "excludedURLs": {
- "description": "URLs to be excluded from the alert",
- "type": "array",
- "items": {
- "type": "string",
- "format": "uri'"
- "groupedURLs": {
- "description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the URL group",
- "type": "string"
- "pattern": {
- "description": "Pattern representing the URL path structure to group",
- "type": "string"
- "contentAiConfig": {
- "index": "example-index-name"
- "cdnLogsConfig": {
- "bucketName": "test-bucket",
- "filters": [
- {
- "key": "test-key",
- "value": [
- "test-value"
- "outputLocation": "test-output-location"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Retrieve all sites
This endpoint is useful for retrieving all sites.
Authorizations:
api_keyResponses
Production server
-https://spacecat.experiencecloud.live/api/v1/sitesResponse samples
- 200
Content typeapplication/json[- {
- "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Site",
- "deliveryType": "aem_edge",
- "deliveryConfig": {
- "programId": "12652",
- "environmentId": "16854",
- "siteId": "1234"
- "goLiveDate": "2024-01-20T10:00:00Z",
- "config": {
- "slack": {
- "channel": "C1234567890",
- "workspace": "example-workspace"
- "handlers": {
- "404": {
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "broken-backlinks": {
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "excludedURLs": {
- "description": "URLs to be excluded from the alert",
- "type": "array",
- "items": {
- "type": "string",
- "format": "uri'"
- "groupedURLs": {
- "description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the URL group",
- "type": "string"
- "pattern": {
- "description": "Pattern representing the URL path structure to group",
- "type": "string"
- "contentAiConfig": {
- "index": "example-index-name"
- "cdnLogsConfig": {
- "bucketName": "test-bucket",
- "filters": [
- {
- "key": "test-key",
- "value": [
- "test-value"
- "outputLocation": "test-output-location"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Response samples
- 200
Content typeapplication/json[- {
- "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Site",
- "deliveryType": "aem_edge",
- "deliveryConfig": {
- "programId": "12652",
- "environmentId": "16854",
- "siteId": "1234"
- "goLiveDate": "2024-01-20T10:00:00Z",
- "config": {
- "slack": {
- "channel": "C1234567890",
- "workspace": "example-workspace"
- "handlers": {
- "404": {
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "broken-backlinks": {
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "excludedURLs": {
- "description": "URLs to be excluded from the alert",
- "type": "array",
- "items": {
- "type": "string",
- "format": "uri'"
- "groupedURLs": {
- "description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the URL group",
- "type": "string"
- "pattern": {
- "description": "Pattern representing the URL path structure to group",
- "type": "string"
- "contentAiConfig": {
- "index": "example-index-name"
- "cdnLogsConfig": {
- "bucketName": "test-bucket",
- "filters": [
- {
- "key": "test-key",
- "value": [
- "test-value"
- "outputLocation": "test-output-location"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Retrieve all sites by delivery type
This endpoint is useful for retrieving all sites by delivery type.
Authorizations:
api_keypath Parameters
deliveryType requiredstring (DeliveryType)Enum: "aem_edge" "aem_cs" "other"Example: aem_edgeThe type of the delivery this site is using
@@ -607,7 +607,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/by-delivery-type/{deliveryType}Production server
-https://spacecat.experiencecloud.live/api/v1/sites/by-delivery-type/{deliveryType}Response samples
- 200
Content typeapplication/json[- {
- "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Site",
- "deliveryType": "aem_edge",
- "deliveryConfig": {
- "programId": "12652",
- "environmentId": "16854",
- "siteId": "1234"
- "goLiveDate": "2024-01-20T10:00:00Z",
- "config": {
- "slack": {
- "channel": "C1234567890",
- "workspace": "example-workspace"
- "handlers": {
- "404": {
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "broken-backlinks": {
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "excludedURLs": {
- "description": "URLs to be excluded from the alert",
- "type": "array",
- "items": {
- "type": "string",
- "format": "uri'"
- "groupedURLs": {
- "description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the URL group",
- "type": "string"
- "pattern": {
- "description": "Pattern representing the URL path structure to group",
- "type": "string"
- "contentAiConfig": {
- "index": "example-index-name"
- "cdnLogsConfig": {
- "bucketName": "test-bucket",
- "filters": [
- {
- "key": "test-key",
- "value": [
- "test-value"
- "outputLocation": "test-output-location"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Response samples
- 200
Content typeapplication/json[- {
- "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Site",
- "deliveryType": "aem_edge",
- "deliveryConfig": {
- "programId": "12652",
- "environmentId": "16854",
- "siteId": "1234"
- "goLiveDate": "2024-01-20T10:00:00Z",
- "config": {
- "slack": {
- "channel": "C1234567890",
- "workspace": "example-workspace"
- "handlers": {
- "404": {
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "broken-backlinks": {
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "excludedURLs": {
- "description": "URLs to be excluded from the alert",
- "type": "array",
- "items": {
- "type": "string",
- "format": "uri'"
- "groupedURLs": {
- "description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the URL group",
- "type": "string"
- "pattern": {
- "description": "Pattern representing the URL path structure to group",
- "type": "string"
- "contentAiConfig": {
- "index": "example-index-name"
- "cdnLogsConfig": {
- "bucketName": "test-bucket",
- "filters": [
- {
- "key": "test-key",
- "value": [
- "test-value"
- "outputLocation": "test-output-location"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Retrieve a single site by its Base URL
This endpoint is useful for retrieving a site when you only have its Base URL. The Base URL is a unique identifier for a site other than the Site ID. The base URL provided in the path must be base64 encoded. This is to allow for URLs with special characters to be used as path parameters.
@@ -627,7 +627,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/by-base-url/{base64BaseUrl}Production server
-https://spacecat.experiencecloud.live/api/v1/sites/by-base-url/{base64BaseUrl}Response samples
- 200
Content typeapplication/json{- "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Site",
- "deliveryType": "aem_edge",
- "deliveryConfig": {
- "programId": "12652",
- "environmentId": "16854",
- "siteId": "1234"
- "goLiveDate": "2024-01-20T10:00:00Z",
- "config": {
- "slack": {
- "channel": "C1234567890",
- "workspace": "example-workspace"
- "handlers": {
- "404": {
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "broken-backlinks": {
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "excludedURLs": {
- "description": "URLs to be excluded from the alert",
- "type": "array",
- "items": {
- "type": "string",
- "format": "uri'"
- "groupedURLs": {
- "description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the URL group",
- "type": "string"
- "pattern": {
- "description": "Pattern representing the URL path structure to group",
- "type": "string"
- "contentAiConfig": {
- "index": "example-index-name"
- "cdnLogsConfig": {
- "bucketName": "test-bucket",
- "filters": [
- {
- "key": "test-key",
- "value": [
- "test-value"
- "outputLocation": "test-output-location"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Response samples
- 200
Content typeapplication/json{- "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Site",
- "deliveryType": "aem_edge",
- "deliveryConfig": {
- "programId": "12652",
- "environmentId": "16854",
- "siteId": "1234"
- "goLiveDate": "2024-01-20T10:00:00Z",
- "config": {
- "slack": {
- "channel": "C1234567890",
- "workspace": "example-workspace"
- "handlers": {
- "404": {
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "broken-backlinks": {
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "excludedURLs": {
- "description": "URLs to be excluded from the alert",
- "type": "array",
- "items": {
- "type": "string",
- "format": "uri'"
- "groupedURLs": {
- "description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the URL group",
- "type": "string"
- "pattern": {
- "description": "Pattern representing the URL path structure to group",
- "type": "string"
- "contentAiConfig": {
- "index": "example-index-name"
- "cdnLogsConfig": {
- "bucketName": "test-bucket",
- "filters": [
- {
- "key": "test-key",
- "value": [
- "test-value"
- "outputLocation": "test-output-location"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Retrieve all sites including their latest audit
This endpoint is useful for retrieving all sites including their latest audit. @@ -647,7 +647,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">
Development server
https://spacecat.experiencecloud.live/api/ci/sites/with-latest-audit/{auditType}Production server
-https://spacecat.experiencecloud.live/api/v1/sites/with-latest-audit/{auditType}Response samples
- 200
Content typeapplication/json[- {
- "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Site",
- "deliveryType": "aem_edge",
- "goLiveDate": "2024-01-20T10:00:00Z",
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z",
- "audits": [
- {
- "siteId": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "auditedAt": "2024-01-20T12:00:00Z",
- "expiresAt": "2024-07-20T12:00:00Z",
- "auditType": "cwv",
- "isError": false,
- "deliveryType": "aem_edge",
- "auditResult": {
- "someProperty": "someValue"
- "previousAuditResult": {
- "someProperty": "somePreviousValue"
Response samples
- 200
Content typeapplication/json[- {
- "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Site",
- "deliveryType": "aem_edge",
- "goLiveDate": "2024-01-20T10:00:00Z",
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z",
- "audits": [
- {
- "siteId": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "auditedAt": "2024-01-20T12:00:00Z",
- "expiresAt": "2024-07-20T12:00:00Z",
- "auditType": "cwv",
- "isError": false,
- "deliveryType": "aem_edge",
- "auditResult": {
- "someProperty": "someValue"
- "previousAuditResult": {
- "someProperty": "somePreviousValue"
Get latest site metrics
Retrieves the latest metrics for a specific site, including RUM (Real User Monitoring) @@ -667,7 +667,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">
Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/latest-metricsProduction server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/latest-metricsResponse samples
- 200
Content typeapplication/json{- "pageViewsChange": 0,
- "ctrChange": 0,
- "projectedTrafficValue": 0
Response samples
- 200
Content typeapplication/json{- "pageViewsChange": 0,
- "ctrChange": 0,
- "projectedTrafficValue": 0
Retrieve a single site by its ID
This endpoint is useful for retrieving a site by its ID.
Authorizations:
api_keypath Parameters
siteId requiredstring <uuid> (Id)Example: 123e4567-e89b-12d3-a456-426614174000The site ID in uuid format
@@ -685,7 +685,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}Production server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}Response samples
- 200
Content typeapplication/json{- "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Site",
- "deliveryType": "aem_edge",
- "deliveryConfig": {
- "programId": "12652",
- "environmentId": "16854",
- "siteId": "1234"
- "goLiveDate": "2024-01-20T10:00:00Z",
- "config": {
- "slack": {
- "channel": "C1234567890",
- "workspace": "example-workspace"
- "handlers": {
- "404": {
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "broken-backlinks": {
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "excludedURLs": {
- "description": "URLs to be excluded from the alert",
- "type": "array",
- "items": {
- "type": "string",
- "format": "uri'"
- "groupedURLs": {
- "description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the URL group",
- "type": "string"
- "pattern": {
- "description": "Pattern representing the URL path structure to group",
- "type": "string"
- "contentAiConfig": {
- "index": "example-index-name"
- "cdnLogsConfig": {
- "bucketName": "test-bucket",
- "filters": [
- {
- "key": "test-key",
- "value": [
- "test-value"
- "outputLocation": "test-output-location"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Response samples
- 200
Content typeapplication/json{- "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Site",
- "deliveryType": "aem_edge",
- "deliveryConfig": {
- "programId": "12652",
- "environmentId": "16854",
- "siteId": "1234"
- "goLiveDate": "2024-01-20T10:00:00Z",
- "config": {
- "slack": {
- "channel": "C1234567890",
- "workspace": "example-workspace"
- "handlers": {
- "404": {
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "broken-backlinks": {
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "excludedURLs": {
- "description": "URLs to be excluded from the alert",
- "type": "array",
- "items": {
- "type": "string",
- "format": "uri'"
- "groupedURLs": {
- "description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the URL group",
- "type": "string"
- "pattern": {
- "description": "Pattern representing the URL path structure to group",
- "type": "string"
- "contentAiConfig": {
- "index": "example-index-name"
- "cdnLogsConfig": {
- "bucketName": "test-bucket",
- "filters": [
- {
- "key": "test-key",
- "value": [
- "test-value"
- "outputLocation": "test-output-location"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Request samples
- Payload
Content typeapplication/json{- "organizationId": "u7y6t5r4-e3w2-x1z0-z9y8-x7v6w5u4t3s2",
- "deliveryType": "other",
- "name": "New Site",
- "deliveryConfig": {
- "programId": "12652",
- "environmentId": "16854",
- "siteId": "1234"
- "goLiveDate": "2024-01-20T10:00:00Z"
Response samples
- 200
Content typeapplication/json{- "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Site",
- "deliveryType": "aem_edge",
- "deliveryConfig": {
- "programId": "12652",
- "environmentId": "16854",
- "siteId": "1234"
- "goLiveDate": "2024-01-20T10:00:00Z",
- "config": {
- "slack": {
- "channel": "C1234567890",
- "workspace": "example-workspace"
- "handlers": {
- "404": {
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "broken-backlinks": {
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "excludedURLs": {
- "description": "URLs to be excluded from the alert",
- "type": "array",
- "items": {
- "type": "string",
- "format": "uri'"
- "groupedURLs": {
- "description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the URL group",
- "type": "string"
- "pattern": {
- "description": "Pattern representing the URL path structure to group",
- "type": "string"
- "contentAiConfig": {
- "index": "example-index-name"
- "cdnLogsConfig": {
- "bucketName": "test-bucket",
- "filters": [
- {
- "key": "test-key",
- "value": [
- "test-value"
- "outputLocation": "test-output-location"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Request samples
- Payload
Content typeapplication/json{- "organizationId": "u7y6t5r4-e3w2-x1z0-z9y8-x7v6w5u4t3s2",
- "deliveryType": "other",
- "name": "New Site",
- "deliveryConfig": {
- "programId": "12652",
- "environmentId": "16854",
- "siteId": "1234"
- "goLiveDate": "2024-01-20T10:00:00Z"
Response samples
- 200
Content typeapplication/json{- "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Site",
- "deliveryType": "aem_edge",
- "deliveryConfig": {
- "programId": "12652",
- "environmentId": "16854",
- "siteId": "1234"
- "goLiveDate": "2024-01-20T10:00:00Z",
- "config": {
- "slack": {
- "channel": "C1234567890",
- "workspace": "example-workspace"
- "handlers": {
- "404": {
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "broken-backlinks": {
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "excludedURLs": {
- "description": "URLs to be excluded from the alert",
- "type": "array",
- "items": {
- "type": "string",
- "format": "uri'"
- "groupedURLs": {
- "description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the URL group",
- "type": "string"
- "pattern": {
- "description": "Pattern representing the URL path structure to group",
- "type": "string"
- "contentAiConfig": {
- "index": "example-index-name"
- "cdnLogsConfig": {
- "bucketName": "test-bucket",
- "filters": [
- {
- "key": "test-key",
- "value": [
- "test-value"
- "outputLocation": "test-output-location"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Delete a site
This endpoint is useful for deleting a site.
Authorizations:
admin_keypath Parameters
siteId requiredstring <uuid> (Id)Example: 123e4567-e89b-12d3-a456-426614174000The site ID in uuid format
@@ -761,7 +761,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/{auditType}Production server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/{auditType}Request samples
- Payload
Content typeapplication/json{- "groupedURLs": [
- {
- "name": "catalog",
- "pattern": "/products/"
- {
- "name": "blog",
- "pattern": "/post/"
Response samples
- 200
Content typeapplication/json{- "excludedURLs": [
- "groupedURLs": [
- {
- "name": "catalog",
- "pattern": "/products/"
- {
- "name": "blog",
- "pattern": "/post/"
Request samples
- Payload
Content typeapplication/json{- "groupedURLs": [
- {
- "name": "catalog",
- "pattern": "/products/"
- {
- "name": "blog",
- "pattern": "/post/"
Response samples
- 200
Content typeapplication/json{- "excludedURLs": [
- "groupedURLs": [
- {
- "name": "catalog",
- "pattern": "/products/"
- {
- "name": "blog",
- "pattern": "/post/"
Retrieves brand guidelines for a site
This endpoint provide the brand guidelines for the given site, if brandId is configured in the site configuration.
Authorizations:
api_keypath Parameters
siteId requiredstring <uuid> (Id)Example: 123e4567-e89b-12d3-a456-426614174000The site ID in uuid format
@@ -777,7 +777,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/brand-guidelinesProduction server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/brand-guidelinesResponse samples
- 200
Content typeapplication/json{- "id": "urn:aaid:sc:VA6C2:e64205e7-13ca-51e8-8b83-8d8ef1ebf911",
- "name": "Brand Foo Bar Example",
- "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
- "createdAt": "2025-01-01T00:00:00Z",
- "updatedAt": "2025-02-01T00:00:00Z",
- "toneOfVoice": [
- {
- "text": "Encourage Action"
- {
- "text": "Be optimistic"
- "coreValues": [
- {
- "text": "Inspiring"
- {
- "text": "Human"
- "guidelines": [
- {
- "text": "Use gender-neutral pronouns like 'they', 'them', 'theirs'"
- {
- "text": "Always use sentence case"
- "restrictions": [
- {
- "text": "Don't use rhetorical questions"
- "additionalGuidelines": [
- {
- "text": "Always use sentence case"
Response samples
- 200
Content typeapplication/json{- "id": "urn:aaid:sc:VA6C2:e64205e7-13ca-51e8-8b83-8d8ef1ebf911",
- "name": "Brand Foo Bar Example",
- "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
- "createdAt": "2025-01-01T00:00:00Z",
- "updatedAt": "2025-02-01T00:00:00Z",
- "toneOfVoice": [
- {
- "text": "Encourage Action"
- {
- "text": "Be optimistic"
- "coreValues": [
- {
- "text": "Inspiring"
- {
- "text": "Human"
- "guidelines": [
- {
- "text": "Use gender-neutral pronouns like 'they', 'them', 'theirs'"
- {
- "text": "Always use sentence case"
- "restrictions": [
- {
- "text": "Don't use rhetorical questions"
- "additionalGuidelines": [
- {
- "text": "Always use sentence case"
Update CDN logs configuration for a site
This endpoint allows updating the CDN logs configuration for a specific site.
Authorizations:
ims_keyscoped_api_keypath Parameters
siteId requiredstring <uuid> (Id)Example: 123e4567-e89b-12d3-a456-426614174000The site ID in uuid format
@@ -797,7 +797,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/config/cdn-logsProduction server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/config/cdn-logsRequest samples
- Payload
Content typeapplication/json{- "cdnLogsConfig": {
- "bucketName": "test-bucket",
- "outputLocation": "test-output-location",
- "filters": [
- {
- "key": "test-key",
- "value": [
- "test-value"
Response samples
- 200
Content typeapplication/json{- "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Site",
- "deliveryType": "aem_edge",
- "deliveryConfig": {
- "programId": "12652",
- "environmentId": "16854",
- "siteId": "1234"
- "goLiveDate": "2024-01-20T10:00:00Z",
- "config": {
- "slack": {
- "channel": "C1234567890",
- "workspace": "example-workspace"
- "handlers": {
- "404": {
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "broken-backlinks": {
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "excludedURLs": {
- "description": "URLs to be excluded from the alert",
- "type": "array",
- "items": {
- "type": "string",
- "format": "uri'"
- "groupedURLs": {
- "description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the URL group",
- "type": "string"
- "pattern": {
- "description": "Pattern representing the URL path structure to group",
- "type": "string"
- "contentAiConfig": {
- "index": "example-index-name"
- "cdnLogsConfig": {
- "bucketName": "test-bucket",
- "filters": [
- {
- "key": "test-key",
- "value": [
- "test-value"
- "outputLocation": "test-output-location"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Request samples
- Payload
Content typeapplication/json{- "cdnLogsConfig": {
- "bucketName": "test-bucket",
- "outputLocation": "test-output-location",
- "filters": [
- {
- "key": "test-key",
- "value": [
- "test-value"
Response samples
- 200
Content typeapplication/json{- "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Site",
- "deliveryType": "aem_edge",
- "deliveryConfig": {
- "programId": "12652",
- "environmentId": "16854",
- "siteId": "1234"
- "goLiveDate": "2024-01-20T10:00:00Z",
- "config": {
- "slack": {
- "channel": "C1234567890",
- "workspace": "example-workspace"
- "handlers": {
- "404": {
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "broken-backlinks": {
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "excludedURLs": {
- "description": "URLs to be excluded from the alert",
- "type": "array",
- "items": {
- "type": "string",
- "format": "uri'"
- "groupedURLs": {
- "description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the URL group",
- "type": "string"
- "pattern": {
- "description": "Pattern representing the URL path structure to group",
- "type": "string"
- "contentAiConfig": {
- "index": "example-index-name"
- "cdnLogsConfig": {
- "bucketName": "test-bucket",
- "filters": [
- {
- "key": "test-key",
- "value": [
- "test-value"
- "outputLocation": "test-output-location"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Retrieve key events for a site
This endpoint returns key events for a site chronologically, starting from the most recent and descending to the least recent
Authorizations:
api_keypath Parameters
siteId requiredstring <uuid> (Id)Example: 123e4567-e89b-12d3-a456-426614174000The site ID in uuid format
@@ -815,7 +815,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/key-eventsProduction server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/key-eventsResponse samples
- 200
Content typeapplication/json[- {
- "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "name": "Multiple 404s detected",
- "type": "seo",
- "time": "2023-12-15T09:30:00Z"
Response samples
- 200
Content typeapplication/json[- {
- "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "name": "Multiple 404s detected",
- "type": "seo",
- "time": "2023-12-15T09:30:00Z"
Create a new key event for a site
The endpoint for creating new key events for a site
Authorizations:
api_keypath Parameters
siteId requiredstring <uuid> (Id)Example: 123e4567-e89b-12d3-a456-426614174000The site ID in uuid format
@@ -833,7 +833,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/key-eventsProduction server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/key-eventsRequest samples
- Payload
Content typeapplication/json{- "name": "string",
- "type": "performance",
- "time": "2024-01-19T14:20:30Z"
Response samples
- 201
Content typeapplication/json{- "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "name": "Multiple 404s detected",
- "type": "seo",
- "time": "2023-12-15T09:30:00Z"
Request samples
- Payload
Content typeapplication/json{- "name": "string",
- "type": "performance",
- "time": "2024-01-19T14:20:30Z"
Response samples
- 201
Content typeapplication/json{- "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "name": "Multiple 404s detected",
- "type": "seo",
- "time": "2023-12-15T09:30:00Z"
Delete a key event
The endpoint for deleting a key event
Authorizations:
api_keypath Parameters
siteId requiredstring <uuid> (Id)Example: 123e4567-e89b-12d3-a456-426614174000The site ID in uuid format
@@ -873,7 +873,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/top-pagesProduction server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/top-pagesResponse samples
- 200
Content typeapplication/json[- {
- "siteId": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "traffic": 360420000,
- "source": "ahrefs",
- "geo": "au",
- "importedAt": "2024-04-29T15:14:33.653Z"
Response samples
- 200
Content typeapplication/json[- {
- "siteId": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "traffic": 360420000,
- "source": "ahrefs",
- "geo": "au",
- "importedAt": "2024-04-29T15:14:33.653Z"
Retrieve top pages for site by source
This endpoint is useful for retrieving top pages for a site. @@ -895,7 +895,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">
Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/top-pages/{source}Production server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/top-pages/{source}Response samples
- 200
Content typeapplication/json[- {
- "siteId": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "traffic": 360420000,
- "source": "ahrefs",
- "geo": "au",
- "importedAt": "2024-04-29T15:14:33.653Z"
Response samples
- 200
Content typeapplication/json[- {
- "siteId": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "traffic": 360420000,
- "source": "ahrefs",
- "geo": "au",
- "importedAt": "2024-04-29T15:14:33.653Z"
Retrieve top pages for site by source and geo
This endpoint is useful for retrieving top pages for a site. The top pages will be ordered in descending order by traffic.
@@ -917,7 +917,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/top-pages/{source}/{geo}Production server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/top-pages/{source}/{geo}Response samples
- 200
Content typeapplication/json[- {
- "siteId": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "traffic": 360420000,
- "source": "ahrefs",
- "geo": "au",
- "importedAt": "2024-04-29T15:14:33.653Z"
Response samples
- 200
Content typeapplication/json[- {
- "siteId": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "traffic": 360420000,
- "source": "ahrefs",
- "geo": "au",
- "importedAt": "2024-04-29T15:14:33.653Z"
Get top pages by paid traffic source for a site
Returns the top pages per traffic source receiving the most paid traffic for a given week.
Authorizations:
api_keypath Parameters
siteId requiredstring <uuid> (Id)Example: 123e4567-e89b-12d3-a456-426614174000The site ID in uuid format
@@ -935,7 +935,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/traffic/paidProduction server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/traffic/paidResponse samples
- 200
Content typeapplication/json[- {
- "ctr": 0.015,
- "avgClicksPerSession": 1.82,
- "pageViews": 6100,
- "clickedSessions": 1800,
- "bounceRate": 0.98,
- "totalNumClicks": 5100,
- "source": "paid:affiliate:"
Response samples
- 200
Content typeapplication/json[- {
- "ctr": 0.015,
- "avgClicksPerSession": 1.82,
- "pageViews": 6100,
- "clickedSessions": 1800,
- "bounceRate": 0.98,
- "totalNumClicks": 5100,
- "source": "paid:affiliate:"
Get paid traffic data grouped by URL and page type
Returns paid traffic data for a site, grouped by URL and page type for a given week or month and year.
Authorizations:
api_keypath Parameters
siteId requiredstring <uuid> (Id)Example: 123e4567-e89b-12d3-a456-426614174000The site ID in uuid format
@@ -1221,7 +1221,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/metrics/{metric}/{source}Production server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/metrics/{metric}/{source}Response samples
- 200
Content typeapplication/json[- {
- "siteId": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "source": "ahrefs",
- "name": "organic-traffic",
- "value": 37900,
- "time": "2024-04-29T00:00:00.000Z"
Response samples
- 200
Content typeapplication/json[- {
- "siteId": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "source": "ahrefs",
- "name": "organic-traffic",
- "value": 37900,
- "time": "2024-04-29T00:00:00.000Z"
Retrieve page metrics by source
This endpoint is useful for retrieving page metrics by source. Currently only
@@ -1247,7 +1247,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">organic-keywordsis supported as a metric and only for sourceahrefs.Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/metrics/{metric}/{source}/by-url/{base64PageUrl}Production server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/metrics/{metric}/{source}/by-url/{base64PageUrl}Response samples
- 200
Content typeapplication/json[- {
- "siteId": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "source": "ahrefs",
- "name": "organic-keywords",
- "time": "2024-04-29T00:00:00.000Z",
- "keyword": "foo bar example",
- "traffic": 2355,
- "volume": 2400,
- "bestPosition": 1,
- "cpc": 89,
- "isBranded": true
Response samples
- 200
Content typeapplication/json[- {
- "siteId": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "source": "ahrefs",
- "name": "organic-keywords",
- "time": "2024-04-29T00:00:00.000Z",
- "keyword": "foo bar example",
- "traffic": 2355,
- "volume": 2400,
- "bestPosition": 1,
- "cpc": 89,
- "isBranded": true
Retrieves all experiments for the site
This endpoint provide a list of experiments obtained from RUM data for the given site along with all the experiment details.
Authorizations:
api_keypath Parameters
siteId requiredstring <uuid> (Id)Example: 123e4567-e89b-12d3-a456-426614174000The site ID in uuid format
@@ -1263,7 +1263,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/experimentsProduction server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/experimentsResponse samples
- 200
Content typeapplication/json[- {
- "siteId": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "experimentId": "1012-home-page-optimization",
- "name": "1012 Home Page Optimization",
- "type": "AB",
- "status": "ACTIVE",
- "startDate": "2024-04-29T15:14:33.653Z",
- "endDate": "2024-05-29T15:14:33.653Z",
- "variants": [
- {
- "name": "challenger-1",
- "label": "Challenger 1",
- "split": 0.5,
- "views": 1000,
- "samples": 10,
- "interactionsCount": 200,
- "p_value": 0.04,
- "power": 97.6,
- "statsig": true,
- "metrics": [
- {
- "selector": ".add-to-cart",
- "value": 300,
- "samples": 3,
- "type": "click"
- "updatedAt": "2024-05-31T15:14:33.653Z",
- "updatedBy": "admin",
- "conversionEventName": "click",
- "conversionEventValue": ".add-to-cart"
Response samples
- 200
Content typeapplication/json[- {
- "siteId": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "experimentId": "1012-home-page-optimization",
- "name": "1012 Home Page Optimization",
- "type": "AB",
- "status": "ACTIVE",
- "startDate": "2024-04-29T15:14:33.653Z",
- "endDate": "2024-05-29T15:14:33.653Z",
- "variants": [
- {
- "name": "challenger-1",
- "label": "Challenger 1",
- "split": 0.5,
- "views": 1000,
- "samples": 10,
- "interactionsCount": 200,
- "p_value": 0.04,
- "power": 97.6,
- "statsig": true,
- "metrics": [
- {
- "selector": ".add-to-cart",
- "value": 300,
- "samples": 3,
- "type": "click"
- "updatedAt": "2024-05-31T15:14:33.653Z",
- "updatedBy": "admin",
- "conversionEventName": "click",
- "conversionEventValue": ".add-to-cart"
Response samples
- 200
Content typeapplication/json[- {
- "siteId": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "auditedAt": "2024-01-20T12:00:00Z",
- "expiresAt": "2024-07-20T12:00:00Z",
- "auditType": "cwv",
- "isError": false,
- "deliveryType": "aem_edge",
- "auditResult": {
- "someProperty": "someValue"
- "previousAuditResult": {
- "someProperty": "somePreviousValue"
Response samples
- 200
Content typeapplication/json[- {
- "siteId": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "auditedAt": "2024-01-20T12:00:00Z",
- "expiresAt": "2024-07-20T12:00:00Z",
- "auditType": "cwv",
- "isError": false,
- "deliveryType": "aem_edge",
- "auditResult": {
- "someProperty": "someValue"
- "previousAuditResult": {
- "someProperty": "somePreviousValue"
Retrieve all audits for a site
This endpoint is useful for retrieving all audits for a site. Optionally, the results can be sorted in ascending order by audited at date.
@@ -1305,7 +1305,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/auditsProduction server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/auditsResponse samples
- 200
Content typeapplication/json[- {
- "siteId": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "auditedAt": "2024-01-20T12:00:00Z",
- "expiresAt": "2024-07-20T12:00:00Z",
- "auditType": "cwv",
- "isError": false,
- "deliveryType": "aem_edge",
- "auditResult": {
- "someProperty": "someValue"
- "previousAuditResult": {
- "someProperty": "somePreviousValue"
Response samples
- 200
Content typeapplication/json[- {
- "siteId": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "auditedAt": "2024-01-20T12:00:00Z",
- "expiresAt": "2024-07-20T12:00:00Z",
- "auditType": "cwv",
- "isError": false,
- "deliveryType": "aem_edge",
- "auditResult": {
- "someProperty": "someValue"
- "previousAuditResult": {
- "someProperty": "somePreviousValue"
Retrieve all audits of a given type for a site
This endpoint is useful for retrieving all audits of a given type for a site. Optionally, the results can be sorted in ascending order by audited at date.
@@ -1327,7 +1327,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/audits/{auditType}Production server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/audits/{auditType}Response samples
- 200
Content typeapplication/json[- {
- "siteId": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "auditedAt": "2024-01-20T12:00:00Z",
- "expiresAt": "2024-07-20T12:00:00Z",
- "auditType": "cwv",
- "isError": false,
- "deliveryType": "aem_edge",
- "auditResult": {
- "someProperty": "someValue"
- "previousAuditResult": {
- "someProperty": "somePreviousValue"
Response samples
- 200
Content typeapplication/json[- {
- "siteId": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "auditedAt": "2024-01-20T12:00:00Z",
- "expiresAt": "2024-07-20T12:00:00Z",
- "auditType": "cwv",
- "isError": false,
- "deliveryType": "aem_edge",
- "auditResult": {
- "someProperty": "someValue"
- "previousAuditResult": {
- "someProperty": "somePreviousValue"
Retrieve a single audit for a site
This endpoint is useful for retrieving a single audit for a site. @@ -1353,7 +1353,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">
Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/audits/{auditType}/{auditedAt}Production server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/audits/{auditType}/{auditedAt}Response samples
- 200
Content typeapplication/jsonExample{- "id": "123e4567-e89b-12d3-a456-426614174000",
- "siteId": "456e4567-e89b-12d3-a456-426614174000",
- "auditedAt": "2024-01-20T12:00:00Z",
- "expiresAt": "2024-07-20T12:00:00Z",
- "deliveryType": "aem_edge",
- "auditResult": {
- "someProperty": "someValue"
- "previousAuditResult": {
- "someProperty": "somePreviousValue"
Response samples
- 200
Content typeapplication/jsonExample{- "id": "123e4567-e89b-12d3-a456-426614174000",
- "siteId": "456e4567-e89b-12d3-a456-426614174000",
- "auditedAt": "2024-01-20T12:00:00Z",
- "expiresAt": "2024-07-20T12:00:00Z",
- "deliveryType": "aem_edge",
- "auditResult": {
- "someProperty": "someValue"
- "previousAuditResult": {
- "someProperty": "somePreviousValue"
Retrieve all audits for a site
This endpoint is useful for retrieving all audits for a site. Optionally, the results can be sorted in ascending order by audited at date.
@@ -1373,7 +1373,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/audits/latestProduction server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/audits/latestResponse samples
- 200
Content typeapplication/json[- {
- "siteId": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "auditedAt": "2024-01-20T12:00:00Z",
- "expiresAt": "2024-07-20T12:00:00Z",
- "auditType": "cwv",
- "isError": false,
- "deliveryType": "aem_edge",
- "auditResult": {
- "someProperty": "someValue"
- "previousAuditResult": {
- "someProperty": "somePreviousValue"
Response samples
- 200
Content typeapplication/json[- {
- "siteId": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "auditedAt": "2024-01-20T12:00:00Z",
- "expiresAt": "2024-07-20T12:00:00Z",
- "auditType": "cwv",
- "isError": false,
- "deliveryType": "aem_edge",
- "auditResult": {
- "someProperty": "someValue"
- "previousAuditResult": {
- "someProperty": "somePreviousValue"
Retrieve the latest audit for a site
This endpoint is useful for retrieving the latest audit for a site. @@ -1397,7 +1397,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">
Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/latest-audit/{auditType}Production server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/latest-audit/{auditType}Response samples
- 200
Content typeapplication/jsonExample{- "id": "123e4567-e89b-12d3-a456-426614174000",
- "siteId": "456e4567-e89b-12d3-a456-426614174000",
- "auditedAt": "2024-01-20T12:00:00Z",
- "expiresAt": "2024-07-20T12:00:00Z",
- "deliveryType": "aem_edge",
- "auditResult": {
- "someProperty": "someValue"
- "previousAuditResult": {
- "someProperty": "somePreviousValue"
Response samples
- 200
Content typeapplication/jsonExample{- "id": "123e4567-e89b-12d3-a456-426614174000",
- "siteId": "456e4567-e89b-12d3-a456-426614174000",
- "auditedAt": "2024-01-20T12:00:00Z",
- "expiresAt": "2024-07-20T12:00:00Z",
- "deliveryType": "aem_edge",
- "auditResult": {
- "someProperty": "someValue"
- "previousAuditResult": {
- "someProperty": "somePreviousValue"
Update the configuration for an audit
This endpoint is useful for updating the configuration for an audit, for example to set which URLs to skip from the audit.
@@ -1423,7 +1423,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/{auditType}Production server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/{auditType}Request samples
- Payload
Content typeapplication/json{- "groupedURLs": [
- {
- "name": "catalog",
- "pattern": "/products/"
- {
- "name": "blog",
- "pattern": "/post/"
Response samples
- 200
Content typeapplication/json{- "excludedURLs": [
- "groupedURLs": [
- {
- "name": "catalog",
- "pattern": "/products/"
- {
- "name": "blog",
- "pattern": "/post/"
Request samples
- Payload
Content typeapplication/json{- "groupedURLs": [
- {
- "name": "catalog",
- "pattern": "/products/"
- {
- "name": "blog",
- "pattern": "/post/"
Response samples
- 200
Content typeapplication/json{- "excludedURLs": [
- "groupedURLs": [
- {
- "name": "catalog",
- "pattern": "/products/"
- {
- "name": "blog",
- "pattern": "/post/"
Trigger audits for a sandbox site
Triggers one or more audits for a sandbox site. If no specific audit types are provided, all enabled audits will be triggered. Rate limiting is applied to prevent excessive audit runs.
@@ -1449,7 +1449,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/sandbox/auditProduction server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/sandbox/auditResponse samples
- 200
- 429
Content typeapplication/json{- "message": "Triggered 1 of 2 audits for https://sandbox.example.com",
- "siteId": "123e4567-e89b-12d3-a456-426614174000",
- "results": [
- {
- "auditType": "meta-tags",
- "status": "triggered"
- {
- "auditType": "alt-text",
- "status": "skipped",
- "nextAllowedAt": "2025-08-15T15:37:48.419Z",
- "minutesRemaining": 45
Response samples
- 200
- 429
Content typeapplication/json{- "message": "Triggered 1 of 2 audits for https://sandbox.example.com",
- "siteId": "123e4567-e89b-12d3-a456-426614174000",
- "results": [
- {
- "auditType": "meta-tags",
- "status": "triggered"
- {
- "auditType": "alt-text",
- "status": "skipped",
- "nextAllowedAt": "2025-08-15T15:37:48.419Z",
- "minutesRemaining": 45
Response samples
- 200
Content typeapplication/json{- "status": "Site is connected to Google Search Console"
Response samples
- 200
Content typeapplication/json{- "status": "Site is connected to Google Search Console"
Authenticate with access token
Authenticates a user using an IMS access token and returns session information.
Request Body schema: application/json
requiredaccessToken requiredstringThe access token to authenticate with
@@ -1501,7 +1501,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/auth/loginProduction server
-https://spacecat.experiencecloud.live/api/v1/auth/loginRequest samples
- Payload
Content typeapplication/json{- "accessToken": "string"
Response samples
- 200
- 401
- 403
Content typeapplication/json{- "sessionToken": "string"
Request samples
- Payload
Content typeapplication/json{- "accessToken": "string"
Response samples
- 200
- 401
- 403
Content typeapplication/json{- "sessionToken": "string"
Create a new organization
This endpoint is useful for creating a new organization.
@@ -1523,7 +1523,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/organizationsProduction server
-https://spacecat.experiencecloud.live/api/v1/organizationsRequest samples
- Payload
Content typeapplication/json{- "name": "Example Organization",
- "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
- "config": {
- "slack": {
- "channel": "#example-channel",
- "workspace": "example-workspace"
- "handlers": {
- "404": {
- "mentions": {
- "slack": [
- "@user3",
- "@user4"
- "cwv": {
- "byOrg": false,
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "contentAiConfig": {
- "index": "example-index-name"
Response samples
- 201
Content typeapplication/json{- "id": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Organization",
- "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
- "config": {
- "slack": {
- "channel": "#example-channel",
- "workspace": "example-workspace",
- "invitedUserCount": 5
- "handlers": {
- "404": {
- "byOrg": true,
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "cwv": {
- "byOrg": false,
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "contentAiConfig": {
- "index": "example-index-name"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Request samples
- Payload
Content typeapplication/json{- "name": "Example Organization",
- "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
- "config": {
- "slack": {
- "channel": "#example-channel",
- "workspace": "example-workspace"
- "handlers": {
- "404": {
- "mentions": {
- "slack": [
- "@user3",
- "@user4"
- "cwv": {
- "byOrg": false,
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "contentAiConfig": {
- "index": "example-index-name"
Response samples
- 201
Content typeapplication/json{- "id": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Organization",
- "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
- "config": {
- "slack": {
- "channel": "#example-channel",
- "workspace": "example-workspace",
- "invitedUserCount": 5
- "handlers": {
- "404": {
- "byOrg": true,
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "cwv": {
- "byOrg": false,
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "contentAiConfig": {
- "index": "example-index-name"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Retrieve all organizations
This endpoint is useful for retrieving all organizations.
Authorizations:
api_keyResponses
Production server
-https://spacecat.experiencecloud.live/api/v1/organizationsResponse samples
- 200
Content typeapplication/json[- {
- "id": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Organization",
- "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
- "config": {
- "slack": {
- "channel": "#example-channel",
- "workspace": "example-workspace",
- "invitedUserCount": 5
- "handlers": {
- "404": {
- "byOrg": true,
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "cwv": {
- "byOrg": false,
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "contentAiConfig": {
- "index": "example-index-name"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Response samples
- 200
Content typeapplication/json[- {
- "id": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Organization",
- "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
- "config": {
- "slack": {
- "channel": "#example-channel",
- "workspace": "example-workspace",
- "invitedUserCount": 5
- "handlers": {
- "404": {
- "byOrg": true,
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "cwv": {
- "byOrg": false,
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "contentAiConfig": {
- "index": "example-index-name"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Retrieve a single organization by its ID
This endpoint is useful for retrieving an organization by its ID.
Authorizations:
api_keypath Parameters
organizationId requiredstring <uuid> (Id)Example: 123e4567-e89b-12d3-a456-426614174000The organization ID in uuid format
@@ -1553,7 +1553,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/organizations/{organizationId}Production server
-https://spacecat.experiencecloud.live/api/v1/organizations/{organizationId}Response samples
- 200
Content typeapplication/json{- "id": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Organization",
- "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
- "config": {
- "slack": {
- "channel": "#example-channel",
- "workspace": "example-workspace",
- "invitedUserCount": 5
- "handlers": {
- "404": {
- "byOrg": true,
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "cwv": {
- "byOrg": false,
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "contentAiConfig": {
- "index": "example-index-name"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Response samples
- 200
Content typeapplication/json{- "id": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Organization",
- "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
- "config": {
- "slack": {
- "channel": "#example-channel",
- "workspace": "example-workspace",
- "invitedUserCount": 5
- "handlers": {
- "404": {
- "byOrg": true,
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "cwv": {
- "byOrg": false,
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "contentAiConfig": {
- "index": "example-index-name"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Update an organization
This endpoint is useful for updating an organization. @@ -1581,7 +1581,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">
Development server
https://spacecat.experiencecloud.live/api/ci/organizations/{organizationId}Production server
-https://spacecat.experiencecloud.live/api/v1/organizations/{organizationId}Request samples
- Payload
Content typeapplication/json{- "name": "Example Organization",
- "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
- "config": {
- "slack": {
- "channel": "#example-channel",
- "workspace": "example-workspace"
- "handlers": {
- "404": {
- "mentions": {
- "slack": [
- "@user3",
- "@user4"
- "cwv": {
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "contentAiConfig": {
- "index": "example-index-name"
Response samples
- 200
Content typeapplication/json{- "id": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Organization",
- "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
- "config": {
- "slack": {
- "channel": "#example-channel",
- "workspace": "example-workspace",
- "invitedUserCount": 5
- "handlers": {
- "404": {
- "byOrg": true,
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "cwv": {
- "byOrg": false,
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "contentAiConfig": {
- "index": "example-index-name"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Request samples
- Payload
Content typeapplication/json{- "name": "Example Organization",
- "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
- "config": {
- "slack": {
- "channel": "#example-channel",
- "workspace": "example-workspace"
- "handlers": {
- "404": {
- "mentions": {
- "slack": [
- "@user3",
- "@user4"
- "cwv": {
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "contentAiConfig": {
- "index": "example-index-name"
Response samples
- 200
Content typeapplication/json{- "id": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Organization",
- "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
- "config": {
- "slack": {
- "channel": "#example-channel",
- "workspace": "example-workspace",
- "invitedUserCount": 5
- "handlers": {
- "404": {
- "byOrg": true,
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "cwv": {
- "byOrg": false,
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "contentAiConfig": {
- "index": "example-index-name"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Delete an organization
This endpoint is useful for deleting an organization.
Authorizations:
admin_keypath Parameters
organizationId requiredstring <uuid> (Id)Example: 123e4567-e89b-12d3-a456-426614174000The organization ID in uuid format
@@ -1615,7 +1615,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/organizations/{organizationId}/brandsProduction server
-https://spacecat.experiencecloud.live/api/v1/organizations/{organizationId}/brandsResponse samples
- 200
Content typeapplication/json[- {
- "id": "urn:aaid:sc:VA6C2:e64205e7-13ca-51e8-8b83-8d8ef1ebf911",
- "name": "Brand Foo Bar Example",
- "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
- "createdAt": "2025-01-01T00:00:00Z",
- "updatedAt": "2025-02-01T00:00:00Z"
Response samples
- 200
Content typeapplication/json[- {
- "id": "urn:aaid:sc:VA6C2:e64205e7-13ca-51e8-8b83-8d8ef1ebf911",
- "name": "Brand Foo Bar Example",
- "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
- "createdAt": "2025-01-01T00:00:00Z",
- "updatedAt": "2025-02-01T00:00:00Z"
Retrieve all sites for an organization
This endpoint is useful for retrieving all sites for an organization.
Authorizations:
api_keypath Parameters
organizationId requiredstring <uuid> (Id)Example: 123e4567-e89b-12d3-a456-426614174000The organization ID in uuid format
@@ -1633,7 +1633,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/organizations/{organizationId}/sitesProduction server
-https://spacecat.experiencecloud.live/api/v1/organizations/{organizationId}/sitesResponse samples
- 200
Content typeapplication/json[- {
- "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Site",
- "deliveryType": "aem_edge",
- "deliveryConfig": {
- "programId": "12652",
- "environmentId": "16854",
- "siteId": "1234"
- "goLiveDate": "2024-01-20T10:00:00Z",
- "config": {
- "slack": {
- "channel": "C1234567890",
- "workspace": "example-workspace"
- "handlers": {
- "404": {
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "broken-backlinks": {
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "excludedURLs": {
- "description": "URLs to be excluded from the alert",
- "type": "array",
- "items": {
- "type": "string",
- "format": "uri'"
- "groupedURLs": {
- "description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the URL group",
- "type": "string"
- "pattern": {
- "description": "Pattern representing the URL path structure to group",
- "type": "string"
- "contentAiConfig": {
- "index": "example-index-name"
- "cdnLogsConfig": {
- "bucketName": "test-bucket",
- "filters": [
- {
- "key": "test-key",
- "value": [
- "test-value"
- "outputLocation": "test-output-location"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Response samples
- 200
Content typeapplication/json[- {
- "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
- "organizationId": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Site",
- "deliveryType": "aem_edge",
- "deliveryConfig": {
- "programId": "12652",
- "environmentId": "16854",
- "siteId": "1234"
- "goLiveDate": "2024-01-20T10:00:00Z",
- "config": {
- "slack": {
- "channel": "C1234567890",
- "workspace": "example-workspace"
- "handlers": {
- "404": {
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "broken-backlinks": {
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "excludedURLs": {
- "description": "URLs to be excluded from the alert",
- "type": "array",
- "items": {
- "type": "string",
- "format": "uri'"
- "groupedURLs": {
- "description": "List of grouped URL patterns for categorization. Each entry should include a name and a URL pattern. If empty, previously grouped URLs will be removed",
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the URL group",
- "type": "string"
- "pattern": {
- "description": "Pattern representing the URL path structure to group",
- "type": "string"
- "contentAiConfig": {
- "index": "example-index-name"
- "cdnLogsConfig": {
- "bucketName": "test-bucket",
- "filters": [
- {
- "key": "test-key",
- "value": [
- "test-value"
- "outputLocation": "test-output-location"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Retrieve an organization by IMS Org ID
This endpoint is useful for retrieving an organization by IMS Org ID.
Authorizations:
api_keypath Parameters
imsOrgId requiredstring (ImsOrganizationId)Example: 1234567890ABCDEF12345678@AdobeOrgAn IMS organization ID
@@ -1651,7 +1651,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/organizations/by-ims-org-id/{imsOrgId}Production server
-https://spacecat.experiencecloud.live/api/v1/organizations/by-ims-org-id/{imsOrgId}Response samples
- 200
Content typeapplication/json{- "id": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Organization",
- "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
- "config": {
- "slack": {
- "channel": "#example-channel",
- "workspace": "example-workspace",
- "invitedUserCount": 5
- "handlers": {
- "404": {
- "byOrg": true,
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "cwv": {
- "byOrg": false,
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "contentAiConfig": {
- "index": "example-index-name"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Response samples
- 200
Content typeapplication/json{- "id": "o1p2q3r4-s5t6-u7v8-w9x0-yz12x34y56z",
- "name": "Example Organization",
- "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
- "config": {
- "slack": {
- "channel": "#example-channel",
- "workspace": "example-workspace",
- "invitedUserCount": 5
- "handlers": {
- "404": {
- "byOrg": true,
- "mentions": {
- "slack": [
- "@user1",
- "@user2"
- "cwv": {
- "byOrg": false,
- "mentions": {
- "slack": [
- "@user5",
- "@user6"
- "contentAiConfig": {
- "index": "example-index-name"
- "createdAt": "2023-12-15T09:30:00Z",
- "updatedAt": "2024-01-19T11:20:00Z"
Retrieve Slack config for an organization by IMS Org ID
This endpoint is useful for retrieving the Slack config of an organization by IMS Org ID.
@@ -1673,7 +1673,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/organizations/by-ims-org-id/{imsOrgId}/slack-configProduction server
-https://spacecat.experiencecloud.live/api/v1/organizations/by-ims-org-id/{imsOrgId}/slack-configResponse samples
- 200
Content typeapplication/json{- "channel": "C1234567890",
- "workspace": "example-workspace",
- "invitedUserCount": 5,
https://spacecat.experiencecloud.live/api/v1/organizations/by-ims-org-id/{imsOrgId}/slack-configResponse samples
- 200
Content typeapplication/json{- "channel": "C1234567890",
- "workspace": "example-workspace",
- "invitedUserCount": 5,
Request samples
- Payload
Content typeapplication/json[- {
- "id": "b7fyJDj1bu5yrt82RxLX89a98a73KSqR4ptC5MRvlEoLshbgAB3emGKdjQleAMyINZcoAkM6cB7ma2aV",
- "topic": "example_fulfillment_topic",
- "partition": 0,
- "offset": 1234,
- "value": {
- "content": "ewogICAgImV4dGVybmFsX3JlcXVlc3RfaWQiOiAiMTIzNDUiLAogICAgInJlcXVlc3Rvcl9pZCI6ICIxMjM0NTY3ODkw\nQUJDREVGMTIzNDU2NzhAYWRvYmUuY29tIiwKICAgICJvd25lcl9pZCI6ICIxMjM0NTY3ODkwQUJDREVGMTIzNDU2NzhA\nQWRvYmVPcmciLAogICAgInJlcXVlc3RfdHlwZSI6ICJSRUdVTEFSIiwKICAgICJyZXF1ZXN0b3Jfc3lzdGVtIjogIkFB\nVUkiLAogICAgImZ1bGZpbGxtZW50X2lkIjogIjEyMzQ1Njc4OTBhYmNkZWYxMjM0NTY3ODkwYWJjZGVmMTIzNDU2Nzg5\nMGFiY2RlZjEyMzQ1Njc4OTBhYmNkZWYiLAogICAgImNyZWF0ZV9kYXRlIjogIjIwMjQtMDEtMjJUMDk6MjA6MDEuMTIz\nNDVaIiwKICAgICJpdGVtcyI6IFsKICAgICAgICB7CiAgICAgICAgICAgICJleHRlcm5hbF9pdGVtX2lkIjogIjEyMzQ1\nLWFiY2QtMTIzNC0xMjM0LTEyMzQ0MzIxIiwKICAgICAgICAgICAgInF1YW50aXR5IjogIlVOTElNSVRFRCIsCiAgICAg\nICAgICAgICJvZmZlcl9pZCI6ICIxMjM0NTY3ODkwQUJDREVGMTIzNDU2Nzg5MEFCQ0RFRiIsCiAgICAgICAgICAgICJh\nY2NlcHRlZF90ZXJtcyI6IHsKICAgICAgICAgICAgICAgICJjb250cmFjdF9pZCI6ICIxMjM0NTY3ODkwQUJDREVGMTIz\nNCIsCiAgICAgICAgICAgICAgICAiYWNjZXB0ZWRfYWdyZWVtZW50IjogIklOSVRJQUwiCiAgICAgICAgICAgIH0sCiAg\nICAgICAgICAgICJmdWxmaWxsYWJsZV9pdGVtc19jb21wbGV0ZWQiOiBbCiAgICAgICAgICAgICAgICB7CiAgICAgICAg\nICAgICAgICAgICAgImlkIjogIjEyM2U0NTY3LWU4OWItMTJkMy1hNDU2LTQyNjYxNDE3NDAwMCIsCiAgICAgICAgICAg\nICAgICAgICAgImNvZGUiOiAiZHhfZXhhbXBsZV9zb2x1dGlvbiIsCiAgICAgICAgICAgICAgICAgICAgImZ1bGZpbGxt\nZW50X2RldGFpbHMiOiB7CiAgICAgICAgICAgICAgICAgICAgICAgICJmdWxmaWxsYWJsZV9lbnRpdHlfcmVzb3VyY2Vf\nbG9jYXRvciI6ICJodHRwczovL2V4YW1wbGUuY29tLzEyMzQ1Njc4OTBBQkNERUYxMjM0NTY3OEBBZG9iZU9yZyIsCiAg\nICAgICAgICAgICAgICAgICAgICAgICJmdWxmaWxsYWJsZV9lbnRpdHlfcmVzb3VyY2VfbmFtZSI6ICJFeGFtcGxlIFNv\nbHV0aW9uIgogICAgICAgICAgICAgICAgICAgIH0KICAgICAgICAgICAgICAgIH0KICAgICAgICAgICAgXQogICAgICAg\nIH0KICAgIF0KfQ==",
- "headers": {
- "x-request-id": [
- "123e4567-e89b-12d3-a456-426614174000"
- "miso-trace-id": [
- "12345678abcdef12:12345678abcdef12:12345678abcdef12:1"
- "com-adobe-hoolihan-source-partition": [
- "0"
- "com-adobe-hoolihan-source-offset": [
- "1234"
- "com-adobe-hoolihan-publish-time": [
- "1705915000000"
- "x-api-key": [
- "example_publisher_client_id"
- "com-adobe-hoolihan-publisher": [
- "example_publisher_client_id"
- "com-adobe-hoolihan-source-topic": [
- "example_source_topic"
- "com-adobe-hoolihan-on-behalf-of": [
- "example_other_client_id"
- "Content-Type": [
- "application/json"
Response samples
- 202
Content typeapplication/json[- {
- "status": "accepted",
- "requestId": "123e4567-e89b-12d3-a456-426614174000"
- {
- "status": "rejected"
Request samples
- Payload
Content typeapplication/json[- {
- "id": "b7fyJDj1bu5yrt82RxLX89a98a73KSqR4ptC5MRvlEoLshbgAB3emGKdjQleAMyINZcoAkM6cB7ma2aV",
- "topic": "example_fulfillment_topic",
- "partition": 0,
- "offset": 1234,
- "value": {
- "content": "ewogICAgImV4dGVybmFsX3JlcXVlc3RfaWQiOiAiMTIzNDUiLAogICAgInJlcXVlc3Rvcl9pZCI6ICIxMjM0NTY3ODkw\nQUJDREVGMTIzNDU2NzhAYWRvYmUuY29tIiwKICAgICJvd25lcl9pZCI6ICIxMjM0NTY3ODkwQUJDREVGMTIzNDU2NzhA\nQWRvYmVPcmciLAogICAgInJlcXVlc3RfdHlwZSI6ICJSRUdVTEFSIiwKICAgICJyZXF1ZXN0b3Jfc3lzdGVtIjogIkFB\nVUkiLAogICAgImZ1bGZpbGxtZW50X2lkIjogIjEyMzQ1Njc4OTBhYmNkZWYxMjM0NTY3ODkwYWJjZGVmMTIzNDU2Nzg5\nMGFiY2RlZjEyMzQ1Njc4OTBhYmNkZWYiLAogICAgImNyZWF0ZV9kYXRlIjogIjIwMjQtMDEtMjJUMDk6MjA6MDEuMTIz\nNDVaIiwKICAgICJpdGVtcyI6IFsKICAgICAgICB7CiAgICAgICAgICAgICJleHRlcm5hbF9pdGVtX2lkIjogIjEyMzQ1\nLWFiY2QtMTIzNC0xMjM0LTEyMzQ0MzIxIiwKICAgICAgICAgICAgInF1YW50aXR5IjogIlVOTElNSVRFRCIsCiAgICAg\nICAgICAgICJvZmZlcl9pZCI6ICIxMjM0NTY3ODkwQUJDREVGMTIzNDU2Nzg5MEFCQ0RFRiIsCiAgICAgICAgICAgICJh\nY2NlcHRlZF90ZXJtcyI6IHsKICAgICAgICAgICAgICAgICJjb250cmFjdF9pZCI6ICIxMjM0NTY3ODkwQUJDREVGMTIz\nNCIsCiAgICAgICAgICAgICAgICAiYWNjZXB0ZWRfYWdyZWVtZW50IjogIklOSVRJQUwiCiAgICAgICAgICAgIH0sCiAg\nICAgICAgICAgICJmdWxmaWxsYWJsZV9pdGVtc19jb21wbGV0ZWQiOiBbCiAgICAgICAgICAgICAgICB7CiAgICAgICAg\nICAgICAgICAgICAgImlkIjogIjEyM2U0NTY3LWU4OWItMTJkMy1hNDU2LTQyNjYxNDE3NDAwMCIsCiAgICAgICAgICAg\nICAgICAgICAgImNvZGUiOiAiZHhfZXhhbXBsZV9zb2x1dGlvbiIsCiAgICAgICAgICAgICAgICAgICAgImZ1bGZpbGxt\nZW50X2RldGFpbHMiOiB7CiAgICAgICAgICAgICAgICAgICAgICAgICJmdWxmaWxsYWJsZV9lbnRpdHlfcmVzb3VyY2Vf\nbG9jYXRvciI6ICJodHRwczovL2V4YW1wbGUuY29tLzEyMzQ1Njc4OTBBQkNERUYxMjM0NTY3OEBBZG9iZU9yZyIsCiAg\nICAgICAgICAgICAgICAgICAgICAgICJmdWxmaWxsYWJsZV9lbnRpdHlfcmVzb3VyY2VfbmFtZSI6ICJFeGFtcGxlIFNv\nbHV0aW9uIgogICAgICAgICAgICAgICAgICAgIH0KICAgICAgICAgICAgICAgIH0KICAgICAgICAgICAgXQogICAgICAg\nIH0KICAgIF0KfQ==",
- "headers": {
- "x-request-id": [
- "123e4567-e89b-12d3-a456-426614174000"
- "miso-trace-id": [
- "12345678abcdef12:12345678abcdef12:12345678abcdef12:1"
- "com-adobe-hoolihan-source-partition": [
- "0"
- "com-adobe-hoolihan-source-offset": [
- "1234"
- "com-adobe-hoolihan-publish-time": [
- "1705915000000"
- "x-api-key": [
- "example_publisher_client_id"
- "com-adobe-hoolihan-publisher": [
- "example_publisher_client_id"
- "com-adobe-hoolihan-source-topic": [
- "example_source_topic"
- "com-adobe-hoolihan-on-behalf-of": [
- "example_other_client_id"
- "Content-Type": [
- "application/json"
Response samples
- 202
Content typeapplication/json[- {
- "status": "accepted",
- "requestId": "123e4567-e89b-12d3-a456-426614174000"
- {
- "status": "rejected"
Request samples
- Payload
Content typeapplication/json{- "forwardedHost": "blog.adobe.com, main--blog--adobecom.hlx.live, main--blog--adobecom.hlx.live, main--blog--adobecom.hlx-fastly.page"
Request samples
- Payload
Content typeapplication/json{- "forwardedHost": "blog.adobe.com, main--blog--adobecom.hlx.live, main--blog--adobecom.hlx.live, main--blog--adobecom.hlx-fastly.page"
Request samples
- Payload
Content typeapplication/json{- "domain": "www.example.com"
Request samples
- Payload
Content typeapplication/json{- "domain": "www.example.com"
Process setup completed events for site integration with analytics
Not implemented yet (will be via https://github.com/adobe/spacecat-api-service/issues/237). Process setup completed events for site integration with analytics.
@@ -1833,7 +1833,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/hooks/site-integration/analytics/{hookSecret}Production server
-https://spacecat.experiencecloud.live/api/v1/hooks/site-integration/analytics/{hookSecret}Request samples
- Payload
Content typeapplication/jsonExample{- "siteId": "a31fa5e4-90be-4440-a063-e6d6aa5a127a",
- "dataCollection": {
- "type": "adobe-tags",
- "environments": {
- "dataStore": {
- "type": "adobe-analytics",
- "id": "ageo1xxpnwexamplerumanalytics"
- "dataMapping": {
- "type": "adobe-analytics",
- "mappings": {
- "All Page Views": "event4",
- "Page URL": "evar2",
- "Data Source": "evar3",
- "Site Domain": "evar4"
Request samples
- Payload
Content typeapplication/jsonExample{- "siteId": "a31fa5e4-90be-4440-a063-e6d6aa5a127a",
- "dataCollection": {
- "type": "adobe-tags",
- "environments": {
- "dataStore": {
- "type": "adobe-analytics",
- "id": "ageo1xxpnwexamplerumanalytics"
- "dataMapping": {
- "type": "adobe-analytics",
- "mappings": {
- "All Page Views": "event4",
- "Page URL": "evar2",
- "Data Source": "evar3",
- "Site Domain": "evar4"
Request samples
- Payload
Content typeapplication/json{- "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
- "imsUserAccessToken": "eyJhbGciOiJIUzI1NiJ9.eyJpZCI6IjEyMzQ1IiwidHlwZSI6ImFjY2Vzc190b2tlbiIsImNsaWVudF9pZCI6ImV4YW1wbGVfYXBwIiwidXNlcl9pZCI6Ijk4NzY1NDc4OTBBQkNERUYxMjM0NTY3OEBhYmNkZWYxMjM0NTY3ODkuZSIsImFzIjoiaW1zLW5hMSIsImFhX2lkIjoiMTIzNDU2Nzg5MEFCQ0RFRjEyMzQ1Njc4QGFkb2JlLmNvbSIsImNyZWF0ZWRfYXQiOiIxNzEwMjQ3MDAwMDAwIn0.MRDpxgxSHDj4DmA182hPnjMAnKkly-VUJ_bXpQ-J8EQ"
Request samples
- Payload
Content typeapplication/json{- "imsOrgId": "1234567890ABCDEF12345678@AdobeOrg",
- "imsUserAccessToken": "eyJhbGciOiJIUzI1NiJ9.eyJpZCI6IjEyMzQ1IiwidHlwZSI6ImFjY2Vzc190b2tlbiIsImNsaWVudF9pZCI6ImV4YW1wbGVfYXBwIiwidXNlcl9pZCI6Ijk4NzY1NDc4OTBBQkNERUYxMjM0NTY3OEBhYmNkZWYxMjM0NTY3ODkuZSIsImFzIjoiaW1zLW5hMSIsImFhX2lkIjoiMTIzNDU2Nzg5MEFCQ0RFRjEyMzQ1Njc4QGFkb2JlLmNvbSIsImNyZWF0ZWRfYXQiOiIxNzEwMjQ3MDAwMDAwIn0.MRDpxgxSHDj4DmA182hPnjMAnKkly-VUJ_bXpQ-J8EQ"
Request samples
- Payload
Content typeapplication/json{- "name": "Example API Key",
- "features": [
- "imports"
- "domains": [
- "example.com"
Response samples
- 201
Content typeapplication/json{- "id": "123e4567-e89b-12d3-a456-426614174000",
- "name": "string",
- "scopes": [
- {
- "name": "imports.write",
- "domains": [
- "www.example.com"
- "createdAt": "2024-01-19T14:20:30Z",
- "expiresAt": "2024-01-19T14:20:30Z",
- "deletedAt": "2024-01-19T14:20:30Z",
- "revokedAt": "2024-01-19T14:20:30Z",
- "apiKey": "string"
Request samples
- Payload
Content typeapplication/json{- "name": "Example API Key",
- "features": [
- "imports"
- "domains": [
- "example.com"
Response samples
- 201
Content typeapplication/json{- "id": "123e4567-e89b-12d3-a456-426614174000",
- "name": "string",
- "scopes": [
- {
- "name": "imports.write",
- "domains": [
- "www.example.com"
- "createdAt": "2024-01-19T14:20:30Z",
- "expiresAt": "2024-01-19T14:20:30Z",
- "deletedAt": "2024-01-19T14:20:30Z",
- "revokedAt": "2024-01-19T14:20:30Z",
- "apiKey": "string"
Get all API keys owned by the given IMS client
This endpoint can be used to list all the API keys created by the client.
Authorizations:
ims_keyheader Parameters
x-gw-ims-org-id stringExample: 1234567890ABCDEF12345678@AdobeOrgIMS Organization Id of the client.
@@ -1907,7 +1907,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/tools/api-keysProduction server
-https://spacecat.experiencecloud.live/api/v1/tools/api-keysResponse samples
- 200
Content typeapplication/json[- {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "name": "string",
- "scopes": [
- {
- "name": "imports.write",
- "domains": [
- "www.example.com"
- "createdAt": "2024-01-19T14:20:30Z",
- "expiresAt": "2024-01-19T14:20:30Z",
- "deletedAt": "2024-01-19T14:20:30Z",
- "revokedAt": "2024-01-19T14:20:30Z"
Response samples
- 200
Content typeapplication/json[- {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "name": "string",
- "scopes": [
- {
- "name": "imports.write",
- "domains": [
- "www.example.com"
- "createdAt": "2024-01-19T14:20:30Z",
- "expiresAt": "2024-01-19T14:20:30Z",
- "deletedAt": "2024-01-19T14:20:30Z",
- "revokedAt": "2024-01-19T14:20:30Z"
Delete an API key
This endpoint can be used to delete an API key. The API key will be marked as deleted in the system and will no longer be valid for authentication. Only keys created by this IMS client can be deleted by it.
@@ -1975,7 +1975,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/tools/import/jobsProduction server
-https://spacecat.experiencecloud.live/api/v1/tools/import/jobsResponse samples
- 202
Content typeapplication/json{- "id": "12d6ac8e-d5e4-4788-90eb-b69e10e745fd",
- "status": "RUNNING",
- "startTime": "2024-01-19T14:20:30Z",
- "urlCount": 25,
- "successCount": 15,
- "failedCount": 0
Response samples
- 202
Content typeapplication/json{- "id": "12d6ac8e-d5e4-4788-90eb-b69e10e745fd",
- "status": "RUNNING",
- "startTime": "2024-01-19T14:20:30Z",
- "urlCount": 25,
- "successCount": 15,
- "failedCount": 0
Query the status of an import job
This endpoint can be used to query the status of an import job, given its jobId.
Authorizations:
scoped_api_keypath Parameters
jobId requiredstring <uuid> (Id)Example: 123e4567-e89b-12d3-a456-426614174000The job ID in uuid format
@@ -1995,7 +1995,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/tools/import/jobs/{jobId}Production server
-https://spacecat.experiencecloud.live/api/v1/tools/import/jobs/{jobId}Response samples
- 200
Content typeapplication/json{- "id": "12d6ac8e-d5e4-4788-90eb-b69e10e745fd",
- "status": "RUNNING",
- "startTime": "2024-01-19T14:20:30Z",
- "urlCount": 25,
- "successCount": 15,
- "failedCount": 0
Response samples
- 200
Content typeapplication/json{- "id": "12d6ac8e-d5e4-4788-90eb-b69e10e745fd",
- "status": "RUNNING",
- "startTime": "2024-01-19T14:20:30Z",
- "urlCount": 25,
- "successCount": 15,
- "failedCount": 0
Request samples
- Payload
Content typeapplication/json[- {
- "op": "replace",
- "path": "/status",
- "value": "STOPPED"
Request samples
- Payload
Content typeapplication/json[- {
- "op": "replace",
- "path": "/status",
- "value": "STOPPED"
Query the progress of an import job
This endpoint can be used to query the progress of an import job, given its jobId.
Authorizations:
scoped_api_keypath Parameters
jobId requiredstring <uuid> (Id)Example: 123e4567-e89b-12d3-a456-426614174000The job ID in uuid format
@@ -2075,7 +2075,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/tools/import/jobs/{jobId}/progressProduction server
-https://spacecat.experiencecloud.live/api/v1/tools/import/jobs/{jobId}/progressResponse samples
- 200
Content typeapplication/json{- "pending": 0,
- "redirect": 0,
- "running": 0,
- "completed": 1,
- "failed": 0
Response samples
- 200
Content typeapplication/json{- "pending": 0,
- "redirect": 0,
- "running": 0,
- "completed": 1,
- "failed": 0
Request a pre-signed URL to download the result of an import job as a .zip archive
This endpoint can be used to download an archive of an import job, which will include @@ -2099,7 +2099,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">
Development server
https://spacecat.experiencecloud.live/api/ci/tools/import/jobs/{jobId}/resultProduction server
-https://spacecat.experiencecloud.live/api/v1/tools/import/jobs/{jobId}/resultResponse samples
- 200
Content typeapplication/json{- "jobId": "12d6ac8e-d5e4-4788-90eb-b69e10e745fd",
Response samples
- 200
Content typeapplication/json{- "jobId": "12d6ac8e-d5e4-4788-90eb-b69e10e745fd",
Request samples
- Payload
Content typeapplication/json{- "processingType": "default",
- "maxScrapeAge": 24,
- "options": {
- "pageLoadTimeout": 200,
- "enableJavascript": true,
- "hideConsentBanners": true
- "customHeaders": { },
Response samples
- 202
Content typeapplication/json{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "processingType": "string",
- "options": { },
- "startedAt": "2019-08-24T14:15:22Z",
- "status": "RUNNING",
- "urlCount": 0,
- "successCount": 0,
- "failedCount": 0,
- "redirectCount": 0,
- "customHeaders": { }
Request samples
- Payload
Content typeapplication/json{- "processingType": "default",
- "maxScrapeAge": 24,
- "options": {
- "pageLoadTimeout": 200,
- "enableJavascript": true,
- "hideConsentBanners": true
- "customHeaders": { },
Response samples
- 202
Content typeapplication/json{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "processingType": "string",
- "options": { },
- "startedAt": "2019-08-24T14:15:22Z",
- "status": "RUNNING",
- "urlCount": 0,
- "successCount": 0,
- "failedCount": 0,
- "redirectCount": 0,
- "customHeaders": { }
Response samples
- 200
Content typeapplication/json{- "id": "12d6ac8e-d5e4-4788-90eb-b69e10e745fd",
- "processingType": "default",
- "options": {
- "enableJavascript": true,
- "hideConsentBanners": true
- "startedAt": "2024-01-19T14:20:30Z",
- "endedAt": "2024-01-19T14:20:30Z",
- "duration": "33771,",
- "status": "COMPLETE",
- "urlCount": 10,
- "successCount": 9,
- "failedCount": 1
Response samples
- 200
Content typeapplication/json{- "id": "12d6ac8e-d5e4-4788-90eb-b69e10e745fd",
- "processingType": "default",
- "options": {
- "enableJavascript": true,
- "hideConsentBanners": true
- "startedAt": "2024-01-19T14:20:30Z",
- "endedAt": "2024-01-19T14:20:30Z",
- "duration": "33771,",
- "status": "COMPLETE",
- "urlCount": 10,
- "successCount": 9,
- "failedCount": 1
Get Scrape Job URL Results
⚠️ EXPERIMENTAL / PROTOTYPE @@ -2165,7 +2165,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">
Development server
https://spacecat.experiencecloud.live/api/ci/tools/scrape/jobs/{jobId}/resultsProduction server
-https://spacecat.experiencecloud.live/api/v1/tools/scrape/jobs/{jobId}/resultsResponse samples
- 200
Content typeapplication/json{- "jobId": "123e4567-e89b-12d3-a456-426614174000",
- "results": [
- {
- "status": "COMPLETE",
- "path": "scrapes/12d6ac8e-d5e4-4788-90eb-b69e10e74abc/page1.html"
Response samples
- 200
Content typeapplication/json{- "jobId": "123e4567-e89b-12d3-a456-426614174000",
- "results": [
- {
- "status": "COMPLETE",
- "path": "scrapes/12d6ac8e-d5e4-4788-90eb-b69e10e74abc/page1.html"
Get Scrape Jobs by Date Range
⚠️ EXPERIMENTAL / PROTOTYPE @@ -2185,7 +2185,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">
Development server
https://spacecat.experiencecloud.live/api/ci/tools/scrape/jobs/by-date-range/{startDate}/{endDate}/all-jobsProduction server
-https://spacecat.experiencecloud.live/api/v1/tools/scrape/jobs/by-date-range/{startDate}/{endDate}/all-jobsResponse samples
- 200
Content typeapplication/json[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "processingType": "string",
- "options": { },
- "startedAt": "2019-08-24T14:15:22Z",
- "status": "RUNNING",
- "urlCount": 0,
- "successCount": 0,
- "failedCount": 0,
- "redirectCount": 0,
- "customHeaders": { }
Response samples
- 200
Content typeapplication/json[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "processingType": "string",
- "options": { },
- "startedAt": "2019-08-24T14:15:22Z",
- "status": "RUNNING",
- "urlCount": 0,
- "successCount": 0,
- "failedCount": 0,
- "redirectCount": 0,
- "customHeaders": { }
Get Scrape Jobs by Base URL
⚠️ EXPERIMENTAL / PROTOTYPE @@ -2203,7 +2203,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">
Development server
https://spacecat.experiencecloud.live/api/ci/tools/scrape/jobs/by-base-url/{base64BaseUrl}Production server
-https://spacecat.experiencecloud.live/api/v1/tools/scrape/jobs/by-base-url/{base64BaseUrl}Response samples
- 200
Content typeapplication/json[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "processingType": "string",
- "options": { },
- "startedAt": "2019-08-24T14:15:22Z",
- "status": "RUNNING",
- "urlCount": 0,
- "successCount": 0,
- "failedCount": 0,
- "redirectCount": 0,
- "customHeaders": { }
Response samples
- 200
Content typeapplication/json[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "processingType": "string",
- "options": { },
- "startedAt": "2019-08-24T14:15:22Z",
- "status": "RUNNING",
- "urlCount": 0,
- "successCount": 0,
- "failedCount": 0,
- "redirectCount": 0,
- "customHeaders": { }
Get Scrape Jobs by Base URL and Processing Type
⚠️ EXPERIMENTAL / PROTOTYPE @@ -2223,7 +2223,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">
Development server
https://spacecat.experiencecloud.live/api/ci/tools/scrape/jobs/by-base-url/{base64BaseUrl}/by-processingtype/{processingType}Production server
-https://spacecat.experiencecloud.live/api/v1/tools/scrape/jobs/by-base-url/{base64BaseUrl}/by-processingtype/{processingType}Response samples
- 200
Content typeapplication/json[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "processingType": "string",
- "options": { },
- "startedAt": "2019-08-24T14:15:22Z",
- "status": "RUNNING",
- "urlCount": 0,
- "successCount": 0,
- "failedCount": 0,
- "redirectCount": 0,
- "customHeaders": { }
Response samples
- 200
Content typeapplication/json[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "processingType": "string",
- "options": { },
- "startedAt": "2019-08-24T14:15:22Z",
- "status": "RUNNING",
- "urlCount": 0,
- "successCount": 0,
- "failedCount": 0,
- "redirectCount": 0,
- "customHeaders": { }
Response samples
- 200
Content typeapplication/json{- "items": [
- {
- "key": "about-us/scrape.json",
- "name": "scrape.json",
- "size": 2048,
- "lastModified": "2025-04-11T00:44:31Z"
- {
- "key": "about-us/screenshot-desktop-fullpage.png",
- "name": "screenshot-desktop-fullpage.png",
- "size": 123456,
- "lastModified": "2025-04-11T00:44:31Z"
- "nextPageToken": "string"
Response samples
- 200
Content typeapplication/json{- "items": [
- {
- "key": "about-us/scrape.json",
- "name": "scrape.json",
- "size": 2048,
- "lastModified": "2025-04-11T00:44:31Z"
- {
- "key": "about-us/screenshot-desktop-fullpage.png",
- "name": "screenshot-desktop-fullpage.png",
- "size": 123456,
- "lastModified": "2025-04-11T00:44:31Z"
- "nextPageToken": "string"
Request samples
- Payload
Content typeapplication/jsonExample{Response samples
- 202
- 400
- 503
Content typeapplication/json{- "jobId": "screenshot-job-12345",
- "status": "PENDING",
- "message": "Screenshot job has been queued for processing"
Response samples
- 200
- 400
- 404
- 500
Content typeapplication/json{- "jobId": "b97e531e-119a-4312-996a-da2a6e57d72a",
- "results": {
- "screenshots": [
- {
- "fileName": "screenshot-iphone-6-viewport-withBanner.png",
- "contentType": "image/png",
- "screenshotTime": 583
- {
- "fileName": "screenshot-iphone-6-viewport-withoutBanner.png",
- "contentType": "image/png",
- "screenshotTime": 307
- {
- "fileName": "screenshot-desktop-viewport-withBanner.png",
- "contentType": "image/png",
- "screenshotTime": 2261
- {
- "fileName": "screenshot-desktop-viewport-withoutBanner.png",
- "contentType": "image/png",
- "screenshotTime": 8717
- "dimensionsDevice": "desktop",
- "scrapeTime": 21835,
- "dimensions": {
- "iPhone 6": {
- "bannerSelector": ".truste-consent-content",
- "overlaySelector": "div#truste-consent-track",
- "wrapperSelector": "div#truste-consent-track",
- "bannerDimensions": {
- "x": 22.5,
- "y": 15,
- "width": 330,
- "height": 586.9375,
- "top": 15,
- "right": 352.5,
- "bottom": 601.9375,
- "left": 22.5
- "overlayOpacity": "1",
- "overlayBGColor": "rgba(0, 0, 0, 0)"
- "desktop": {
- "bannerSelector": ".truste-consent-content",
- "overlaySelector": "div#truste-consent-track",
- "wrapperSelector": "div#truste-consent-track",
- "bannerDimensions": {
- "x": 715,
- "y": 15,
- "width": 490,
- "height": 620,
- "top": 15,
- "right": 1205,
- "bottom": 635,
- "left": 715
- "overlayOpacity": "1",
- "overlayBGColor": "rgba(0, 0, 0, 0)"
Response samples
- 200
Content typeapplication/json{ }Response samples
- 200
Content typeapplication/json{ }Get LLMO sheet data with sheet type
Retrieves data from the external LLMO data endpoint for a specific site with a specified sheet type. @@ -2431,7 +2431,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">
Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/sheet-data/{sheetType}/{dataSource}Production server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/sheet-data/{sheetType}/{dataSource}Response samples
- 200
Content typeapplication/json{ }Response samples
- 200
Content typeapplication/json{ }Get LLMO configuration
Retrieves the LLMO (Large Language Model Optimizer) configuration for a specific site. This includes the data folder, brand information, and questions configuration.
@@ -2449,7 +2449,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/configProduction server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/configResponse samples
- 200
Content typeapplication/json{- "dataFolder": "adobe",
- "brand": "adobe",
- "questions": {
- "Human": [
- {
- "key": "123e4567-e89b-12d3-a456-426614174000",
- "question": "What is the main value proposition of this product?",
- "source": "human",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "high",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "creative software",
- "tags": [
- "product",
- "pricing",
- "features"
- {
- "key": "456e7890-e89b-12d3-a456-426614174001",
- "question": "How does this service solve customer problems?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "medium",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "customer support",
- "tags": [
- "support",
- "benefits"
- "AI": [
- {
- "key": "789e0123-e89b-12d3-a456-426614174002",
- "question": "What are the key features that differentiate this product?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "high",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "features comparison",
- "tags": [
- "features",
- "differentiation"
- {
- "key": "012e3456-e89b-12d3-a456-426614174003",
- "question": "How does this compare to competitors in the market?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "medium",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "competitive analysis",
- "tags": [
- "competitive",
- "analysis"
- "customerIntent": [
- {
- "key": "target_audience",
- "value": "small business owners"
- {
- "key": "primary_goal",
- "value": "increase conversions"
- {
- "key": "user_persona",
- "value": "marketing director"
- "cdnlogsFilter": [
- {
- "key": "host",
- "value": [
- "example.com",
- "abc.com"
- "type": "include"
- {
- "key": "status",
- "value": [
- "404",
- "500"
- "type": "exclude"
- "cdnBucketConfig": {
- "bucketName": "my-cdn-logs-bucket",
- "orgId": "org-12345",
- "cdnProvider": "aem-cs-fastly"
Response samples
- 200
Content typeapplication/json{- "dataFolder": "adobe",
- "brand": "adobe",
- "questions": {
- "Human": [
- {
- "key": "123e4567-e89b-12d3-a456-426614174000",
- "question": "What is the main value proposition of this product?",
- "source": "human",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "high",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "creative software",
- "tags": [
- "product",
- "pricing",
- "features"
- {
- "key": "456e7890-e89b-12d3-a456-426614174001",
- "question": "How does this service solve customer problems?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "medium",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "customer support",
- "tags": [
- "support",
- "benefits"
- "AI": [
- {
- "key": "789e0123-e89b-12d3-a456-426614174002",
- "question": "What are the key features that differentiate this product?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "high",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "features comparison",
- "tags": [
- "features",
- "differentiation"
- {
- "key": "012e3456-e89b-12d3-a456-426614174003",
- "question": "How does this compare to competitors in the market?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "medium",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "competitive analysis",
- "tags": [
- "competitive",
- "analysis"
- "customerIntent": [
- {
- "key": "target_audience",
- "value": "small business owners"
- {
- "key": "primary_goal",
- "value": "increase conversions"
- {
- "key": "user_persona",
- "value": "marketing director"
- "cdnlogsFilter": [
- {
- "key": "host",
- "value": [
- "example.com",
- "abc.com"
- "type": "include"
- {
- "key": "status",
- "value": [
- "404",
- "500"
- "type": "exclude"
- "cdnBucketConfig": {
- "bucketName": "my-cdn-logs-bucket",
- "orgId": "org-12345",
- "cdnProvider": "aem-cs-fastly"
Get LLMO questions
Retrieves all LLMO questions (both human and AI) for a specific site. Returns an object with Human and AI question arrays.
@@ -2467,7 +2467,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/questionsProduction server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/questionsResponse samples
- 200
Content typeapplication/json{- "Human": [
- {
- "key": "123e4567-e89b-12d3-a456-426614174000",
- "question": "What is the main value proposition of this product?",
- "source": "human",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "high",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "creative software",
- "tags": [
- "product",
- "pricing",
- "features"
- {
- "key": "456e7890-e89b-12d3-a456-426614174001",
- "question": "How does this service solve customer problems?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "medium",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "customer support",
- "tags": [
- "support",
- "benefits"
- "AI": [
- {
- "key": "789e0123-e89b-12d3-a456-426614174002",
- "question": "What are the key features that differentiate this product?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "high",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "features comparison",
- "tags": [
- "features",
- "differentiation"
- {
- "key": "012e3456-e89b-12d3-a456-426614174003",
- "question": "How does this compare to competitors in the market?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "medium",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "competitive analysis",
- "tags": [
- "competitive",
- "analysis"
Response samples
- 200
Content typeapplication/json{- "Human": [
- {
- "key": "123e4567-e89b-12d3-a456-426614174000",
- "question": "What is the main value proposition of this product?",
- "source": "human",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "high",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "creative software",
- "tags": [
- "product",
- "pricing",
- "features"
- {
- "key": "456e7890-e89b-12d3-a456-426614174001",
- "question": "How does this service solve customer problems?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "medium",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "customer support",
- "tags": [
- "support",
- "benefits"
- "AI": [
- {
- "key": "789e0123-e89b-12d3-a456-426614174002",
- "question": "What are the key features that differentiate this product?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "high",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "features comparison",
- "tags": [
- "features",
- "differentiation"
- {
- "key": "012e3456-e89b-12d3-a456-426614174003",
- "question": "How does this compare to competitors in the market?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "medium",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "competitive analysis",
- "tags": [
- "competitive",
- "analysis"
Add LLMO questions
Adds new questions to the LLMO configuration for a specific site. Questions can be added to both Human and AI categories.
@@ -2489,7 +2489,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/questionsProduction server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/questionsRequest samples
- Payload
Content typeapplication/json{- "Human": [
- {
- "question": "What is the main value proposition of this product?",
- "source": "human",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "high",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "creative software",
- "tags": [
- "product",
- "pricing",
- "features"
- "AI": [
- {
- "question": "What are the key features that differentiate this product?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "high",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "features comparison",
- "tags": [
- "features",
- "differentiation"
Response samples
- 200
Content typeapplication/json{- "Human": [
- {
- "key": "123e4567-e89b-12d3-a456-426614174000",
- "question": "What is the main value proposition of this product?",
- "source": "human",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "high",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "creative software",
- "tags": [
- "product",
- "pricing",
- "features"
- {
- "key": "456e7890-e89b-12d3-a456-426614174001",
- "question": "How does this service solve customer problems?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "medium",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "customer support",
- "tags": [
- "support",
- "benefits"
- "AI": [
- {
- "key": "789e0123-e89b-12d3-a456-426614174002",
- "question": "What are the key features that differentiate this product?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "high",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "features comparison",
- "tags": [
- "features",
- "differentiation"
- {
- "key": "012e3456-e89b-12d3-a456-426614174003",
- "question": "How does this compare to competitors in the market?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "medium",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "competitive analysis",
- "tags": [
- "competitive",
- "analysis"
Request samples
- Payload
Content typeapplication/json{- "Human": [
- {
- "question": "What is the main value proposition of this product?",
- "source": "human",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "high",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "creative software",
- "tags": [
- "product",
- "pricing",
- "features"
- "AI": [
- {
- "question": "What are the key features that differentiate this product?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "high",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "features comparison",
- "tags": [
- "features",
- "differentiation"
Response samples
- 200
Content typeapplication/json{- "Human": [
- {
- "key": "123e4567-e89b-12d3-a456-426614174000",
- "question": "What is the main value proposition of this product?",
- "source": "human",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "high",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "creative software",
- "tags": [
- "product",
- "pricing",
- "features"
- {
- "key": "456e7890-e89b-12d3-a456-426614174001",
- "question": "How does this service solve customer problems?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "medium",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "customer support",
- "tags": [
- "support",
- "benefits"
- "AI": [
- {
- "key": "789e0123-e89b-12d3-a456-426614174002",
- "question": "What are the key features that differentiate this product?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "high",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "features comparison",
- "tags": [
- "features",
- "differentiation"
- {
- "key": "012e3456-e89b-12d3-a456-426614174003",
- "question": "How does this compare to competitors in the market?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "medium",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "competitive analysis",
- "tags": [
- "competitive",
- "analysis"
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.
@@ -2509,7 +2509,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">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
- 200
Content typeapplication/json{- "Human": [
- {
- "key": "123e4567-e89b-12d3-a456-426614174000",
- "question": "What is the main value proposition of this product?",
- "source": "human",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "high",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "creative software",
- "tags": [
- "product",
- "pricing",
- "features"
- {
- "key": "456e7890-e89b-12d3-a456-426614174001",
- "question": "How does this service solve customer problems?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "medium",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "customer support",
- "tags": [
- "support",
- "benefits"
- "AI": [
- {
- "key": "789e0123-e89b-12d3-a456-426614174002",
- "question": "What are the key features that differentiate this product?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "high",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "features comparison",
- "tags": [
- "features",
- "differentiation"
- {
- "key": "012e3456-e89b-12d3-a456-426614174003",
- "question": "How does this compare to competitors in the market?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "medium",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "competitive analysis",
- "tags": [
- "competitive",
- "analysis"
Response samples
- 200
Content typeapplication/json{- "Human": [
- {
- "key": "123e4567-e89b-12d3-a456-426614174000",
- "question": "What is the main value proposition of this product?",
- "source": "human",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "high",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "creative software",
- "tags": [
- "product",
- "pricing",
- "features"
- {
- "key": "456e7890-e89b-12d3-a456-426614174001",
- "question": "How does this service solve customer problems?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "medium",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "customer support",
- "tags": [
- "support",
- "benefits"
- "AI": [
- {
- "key": "789e0123-e89b-12d3-a456-426614174002",
- "question": "What are the key features that differentiate this product?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "high",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "features comparison",
- "tags": [
- "features",
- "differentiation"
- {
- "key": "012e3456-e89b-12d3-a456-426614174003",
- "question": "How does this compare to competitors in the market?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "medium",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "competitive analysis",
- "tags": [
- "competitive",
- "analysis"
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.
@@ -2547,7 +2547,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">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
- Payload
Content typeapplication/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",
- "tags": [
- "product",
- "pricing",
- "features"
Response samples
- 200
Content typeapplication/json{- "Human": [
- {
- "key": "123e4567-e89b-12d3-a456-426614174000",
- "question": "What is the main value proposition of this product?",
- "source": "human",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "high",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "creative software",
- "tags": [
- "product",
- "pricing",
- "features"
- {
- "key": "456e7890-e89b-12d3-a456-426614174001",
- "question": "How does this service solve customer problems?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "medium",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "customer support",
- "tags": [
- "support",
- "benefits"
- "AI": [
- {
- "key": "789e0123-e89b-12d3-a456-426614174002",
- "question": "What are the key features that differentiate this product?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "high",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "features comparison",
- "tags": [
- "features",
- "differentiation"
- {
- "key": "012e3456-e89b-12d3-a456-426614174003",
- "question": "How does this compare to competitors in the market?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "medium",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "competitive analysis",
- "tags": [
- "competitive",
- "analysis"
Request samples
- Payload
Content typeapplication/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",
- "tags": [
- "product",
- "pricing",
- "features"
Response samples
- 200
Content typeapplication/json{- "Human": [
- {
- "key": "123e4567-e89b-12d3-a456-426614174000",
- "question": "What is the main value proposition of this product?",
- "source": "human",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "high",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "creative software",
- "tags": [
- "product",
- "pricing",
- "features"
- {
- "key": "456e7890-e89b-12d3-a456-426614174001",
- "question": "How does this service solve customer problems?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "medium",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "customer support",
- "tags": [
- "support",
- "benefits"
- "AI": [
- {
- "key": "789e0123-e89b-12d3-a456-426614174002",
- "question": "What are the key features that differentiate this product?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "high",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "features comparison",
- "tags": [
- "features",
- "differentiation"
- {
- "key": "012e3456-e89b-12d3-a456-426614174003",
- "question": "How does this compare to competitors in the market?",
- "source": "ai",
- "country": "US",
- "product": "Adobe Creative Cloud",
- "volume": "medium",
- "importTime": "2024-01-20T12:00:00Z",
- "keyword": "competitive analysis",
- "tags": [
- "competitive",
- "analysis"
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.
@@ -2565,7 +2565,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/customer-intentProduction server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/customer-intentResponse samples
- 200
Content typeapplication/json[- {
- "key": "target_audience",
- "value": "small business owners"
- {
- "key": "primary_goal",
- "value": "increase conversions"
- {
- "key": "user_persona",
- "value": "marketing director"
Response samples
- 200
Content typeapplication/json[- {
- "key": "target_audience",
- "value": "small business owners"
- {
- "key": "primary_goal",
- "value": "increase conversions"
- {
- "key": "user_persona",
- "value": "marketing director"
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.
@@ -2587,7 +2587,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/customer-intentProduction server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/customer-intentRequest samples
- Payload
Content typeapplication/json[- {
- "key": "target_audience",
- "value": "small business owners"
- {
- "key": "primary_goal",
- "value": "increase conversions"
Response samples
- 200
Content typeapplication/json[- {
- "key": "target_audience",
- "value": "small business owners"
- {
- "key": "primary_goal",
- "value": "increase conversions"
- {
- "key": "user_persona",
- "value": "marketing director"
Request samples
- Payload
Content typeapplication/json[- {
- "key": "target_audience",
- "value": "small business owners"
- {
- "key": "primary_goal",
- "value": "increase conversions"
Response samples
- 200
Content typeapplication/json[- {
- "key": "target_audience",
- "value": "small business owners"
- {
- "key": "primary_goal",
- "value": "increase conversions"
- {
- "key": "user_persona",
- "value": "marketing director"
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.
@@ -2607,7 +2607,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">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
- 200
Content typeapplication/json[- {
- "key": "target_audience",
- "value": "small business owners"
- {
- "key": "primary_goal",
- "value": "increase conversions"
- {
- "key": "user_persona",
- "value": "marketing director"
Response samples
- 200
Content typeapplication/json[- {
- "key": "target_audience",
- "value": "small business owners"
- {
- "key": "primary_goal",
- "value": "increase conversions"
- {
- "key": "user_persona",
- "value": "marketing director"
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.
@@ -2631,7 +2631,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">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
- Payload
Content typeapplication/json{- "key": "updated_target_audience",
- "value": "enterprise customers"
Response samples
- 200
Content typeapplication/json[- {
- "key": "target_audience",
- "value": "small business owners"
- {
- "key": "primary_goal",
- "value": "increase conversions"
- {
- "key": "user_persona",
- "value": "marketing director"
Request samples
- Payload
Content typeapplication/json{- "key": "updated_target_audience",
- "value": "enterprise customers"
Response samples
- 200
Content typeapplication/json[- {
- "key": "target_audience",
- "value": "small business owners"
- {
- "key": "primary_goal",
- "value": "increase conversions"
- {
- "key": "user_persona",
- "value": "marketing director"
Update LLMO CDN logs filter configuration
Updates the CDN logs filter configuration for a specific site.
Authorizations:
api_keypath Parameters
siteId requiredstring <uuid> (Id)Example: 123e4567-e89b-12d3-a456-426614174000The site ID in uuid format
@@ -2649,7 +2649,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/cdn-logs-filterProduction server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/cdn-logs-filterRequest samples
- Payload
Content typeapplication/json{- "cdnlogsFilter": [
- {
- "key": "host",
- "value": [
- "example.com",
- "abc.com"
- "type": "include"
- {
- "key": "status",
- "value": [
- "404",
- "500"
- "type": "exclude"
Response samples
- 200
Content typeapplication/json[- {
- "key": "host",
- "value": [
- "example.com",
- "abc.com"
- "type": "include"
- {
- "key": "status",
- "value": [
- "404",
- "500"
- "type": "exclude"
Request samples
- Payload
Content typeapplication/json{- "cdnlogsFilter": [
- {
- "key": "host",
- "value": [
- "example.com",
- "abc.com"
- "type": "include"
- {
- "key": "status",
- "value": [
- "404",
- "500"
- "type": "exclude"
Response samples
- 200
Content typeapplication/json[- {
- "key": "host",
- "value": [
- "example.com",
- "abc.com"
- "type": "include"
- {
- "key": "status",
- "value": [
- "404",
- "500"
- "type": "exclude"
Update LLMO CDN bucket config configuration
Updates the CDN bucket config configuration for a specific site.
Authorizations:
api_keypath Parameters
siteId requiredstring <uuid> (Id)Example: 123e4567-e89b-12d3-a456-426614174000The site ID in uuid format
@@ -2667,7 +2667,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/llmo/cdn-logs-bucket-configProduction server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/llmo/cdn-logs-bucket-configRequest samples
- Payload
Content typeapplication/json{- "cdnBucketConfig": {
- "bucketName": "my-cdn-logs-bucket",
- "orgId": "org-12345",
- "cdnProvider": "aem-cs-fastly"
Response samples
- 200
Content typeapplication/json{- "bucketName": "my-cdn-logs-bucket",
- "orgId": "org-12345",
- "cdnProvider": "aem-cs-fastly"
Request samples
- Payload
Content typeapplication/json{- "cdnBucketConfig": {
- "bucketName": "my-cdn-logs-bucket",
- "orgId": "org-12345",
- "cdnProvider": "aem-cs-fastly"
Response samples
- 200
Content typeapplication/json{- "bucketName": "my-cdn-logs-bucket",
- "orgId": "org-12345",
- "cdnProvider": "aem-cs-fastly"
List all entitlements for an organization
This endpoint retrieves all entitlements associated with a specific organization.
@@ -2687,7 +2687,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/organizations/{organizationId}/entitlementsProduction server
-https://spacecat.experiencecloud.live/api/v1/organizations/{organizationId}/entitlementsResponse samples
- 200
Content typeapplication/json[- {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "organizationId": "987fcdeb-51a2-43d7-9876-543210987654",
- "productCode": "LLMO",
- "tier": "FREE_TRIAL",
- "quotas": {
- "llmo_trial_prompts": 100
- "createdAt": "2024-01-15T10:30:00Z",
- "updatedAt": "2024-01-15T10:30:00Z",
- "updatedBy": "system"
https://spacecat.experiencecloud.live/api/v1/organizations/{organizationId}/entitlementsResponse samples
- 200
Content typeapplication/json[- {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "organizationId": "987fcdeb-51a2-43d7-9876-543210987654",
- "productCode": "LLMO",
- "tier": "FREE_TRIAL",
- "quotas": {
- "llmo_trial_prompts": 100
- "createdAt": "2024-01-15T10:30:00Z",
- "updatedAt": "2024-01-15T10:30:00Z",
- "updatedBy": "system"
List all site enrollments for a specific site
This endpoint retrieves all site enrollments associated with a specific site.
@@ -2707,7 +2707,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/site-enrollmentsProduction server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/site-enrollmentsResponse samples
- 200
Content typeapplication/json[- {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "siteId": "987fcdeb-51a2-43d7-9876-543210987654",
- "entitlementId": "456e4567-e89b-12d3-a456-426614174000",
- "createdAt": "2024-01-15T10:30:00Z",
- "updatedAt": "2024-01-15T10:30:00Z",
- "updatedBy": "system"
Response samples
- 200
Content typeapplication/json[- {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "siteId": "987fcdeb-51a2-43d7-9876-543210987654",
- "entitlementId": "456e4567-e89b-12d3-a456-426614174000",
- "createdAt": "2024-01-15T10:30:00Z",
- "updatedAt": "2024-01-15T10:30:00Z",
- "updatedBy": "system"
List all trial users for an organization
This endpoint retrieves all trial users associated with a specific organization.
@@ -2727,7 +2727,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/organizations/{organizationId}/trial-usersProduction server
-https://spacecat.experiencecloud.live/api/v1/organizations/{organizationId}/trial-usersResponse samples
- 200
Content typeapplication/json[- {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "organizationId": "987fcdeb-51a2-43d7-9876-543210987654",
- "emailId": "user123@adobe.com",
- "firstName": "John",
- "lastName": "Doe",
- "externalUserId": "1234567890",
- "provider": "IMS",
- "status": "INVITED",
- "lastSeenAt": "2024-01-15T10:30:00Z",
- "metadata": {
- "origin": "INVITED"
- "createdAt": "2024-01-15T10:30:00Z",
- "updatedAt": "2024-01-15T10:30:00Z",
- "updatedBy": "system"
Response samples
- 200
Content typeapplication/json[- {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "organizationId": "987fcdeb-51a2-43d7-9876-543210987654",
- "emailId": "user123@adobe.com",
- "firstName": "John",
- "lastName": "Doe",
- "externalUserId": "1234567890",
- "provider": "IMS",
- "status": "INVITED",
- "lastSeenAt": "2024-01-15T10:30:00Z",
- "metadata": {
- "origin": "INVITED"
- "createdAt": "2024-01-15T10:30:00Z",
- "updatedAt": "2024-01-15T10:30:00Z",
- "updatedBy": "system"
Invite a trial user to an organization
This endpoint allows inviting a new trial user to an organization by providing their email address.
Authorizations:
ims_keypath Parameters
organizationId requiredstring <uuid> (Id)Example: 123e4567-e89b-12d3-a456-426614174000The organization ID in uuid format
@@ -2749,7 +2749,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/organizations/{organizationId}/trial-user-inviteProduction server
-https://spacecat.experiencecloud.live/api/v1/organizations/{organizationId}/trial-user-inviteRequest samples
- Payload
Content typeapplication/json{- "emailId": "user@example.com"
Response samples
- 201
Content typeapplication/json{- "id": "123e4567-e89b-12d3-a456-426614174000",
- "organizationId": "987fcdeb-51a2-43d7-9876-543210987654",
- "emailId": "user123@adobe.com",
- "firstName": "John",
- "lastName": "Doe",
- "externalUserId": "1234567890",
- "provider": "IMS",
- "status": "INVITED",
- "lastSeenAt": "2024-01-15T10:30:00Z",
- "metadata": {
- "origin": "INVITED"
- "createdAt": "2024-01-15T10:30:00Z",
- "updatedAt": "2024-01-15T10:30:00Z",
- "updatedBy": "system"
https://spacecat.experiencecloud.live/api/v1/organizations/{organizationId}/trial-user-inviteRequest samples
- Payload
Content typeapplication/json{- "emailId": "user@example.com"
Response samples
- 201
Content typeapplication/json{- "id": "123e4567-e89b-12d3-a456-426614174000",
- "organizationId": "987fcdeb-51a2-43d7-9876-543210987654",
- "emailId": "user123@adobe.com",
- "firstName": "John",
- "lastName": "Doe",
- "externalUserId": "1234567890",
- "provider": "IMS",
- "status": "INVITED",
- "lastSeenAt": "2024-01-15T10:30:00Z",
- "metadata": {
- "origin": "INVITED"
- "createdAt": "2024-01-15T10:30:00Z",
- "updatedAt": "2024-01-15T10:30:00Z",
- "updatedBy": "system"
List all user activities for a specific site
This endpoint retrieves all user activities associated with a specific site.
@@ -2769,7 +2769,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/user-activitiesProduction server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/user-activitiesResponse samples
- 200
Content typeapplication/json[- {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "siteId": "987fcdeb-51a2-43d7-9876-543210987654",
- "trialUserId": "456e4567-e89b-12d3-a456-426614174000",
- "entitlementId": "789e4567-e89b-12d3-a456-426614174000",
- "type": "SIGN_IN",
- "details": {
- "browser": "Chrome",
- "ip": "192.168.1.1"
- "productCode": "LLMO",
- "createdAt": "2024-01-15T10:30:00Z",
- "updatedAt": "2024-01-15T10:30:00Z",
- "updatedBy": "system"
Response samples
- 200
Content typeapplication/json[- {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "siteId": "987fcdeb-51a2-43d7-9876-543210987654",
- "trialUserId": "456e4567-e89b-12d3-a456-426614174000",
- "entitlementId": "789e4567-e89b-12d3-a456-426614174000",
- "type": "SIGN_IN",
- "details": {
- "browser": "Chrome",
- "ip": "192.168.1.1"
- "productCode": "LLMO",
- "createdAt": "2024-01-15T10:30:00Z",
- "updatedAt": "2024-01-15T10:30:00Z",
- "updatedBy": "system"
Create a new user activity
This endpoint creates a new user activity record for the logged-in user.
Authorizations:
ims_keypath Parameters
siteId requiredstring <uuid> (Id)Example: 123e4567-e89b-12d3-a456-426614174000The site ID in uuid format
@@ -2793,7 +2793,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/user-activitiesProduction server
-https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/user-activitiesRequest samples
- Payload
Content typeapplication/json{- "type": "SIGN_IN",
- "details": {
- "browser": "Chrome",
- "ip": "192.168.1.1"
- "productCode": "LLMO"
Response samples
- 201
Content typeapplication/json{- "id": "123e4567-e89b-12d3-a456-426614174000",
- "siteId": "987fcdeb-51a2-43d7-9876-543210987654",
- "trialUserId": "456e4567-e89b-12d3-a456-426614174000",
- "entitlementId": "789e4567-e89b-12d3-a456-426614174000",
- "type": "SIGN_IN",
- "details": {
- "browser": "Chrome",
- "ip": "192.168.1.1"
- "productCode": "LLMO",
- "createdAt": "2024-01-15T10:30:00Z",
- "updatedAt": "2024-01-15T10:30:00Z",
- "updatedBy": "system"
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/user-activitiesRequest samples
- Payload
Content typeapplication/json{- "type": "SIGN_IN",
- "details": {
- "browser": "Chrome",
- "ip": "192.168.1.1"
- "productCode": "LLMO"
Response samples
- 201
Content typeapplication/json{- "id": "123e4567-e89b-12d3-a456-426614174000",
- "siteId": "987fcdeb-51a2-43d7-9876-543210987654",
- "trialUserId": "456e4567-e89b-12d3-a456-426614174000",
- "entitlementId": "789e4567-e89b-12d3-a456-426614174000",
- "type": "SIGN_IN",
- "details": {
- "browser": "Chrome",
- "ip": "192.168.1.1"
- "productCode": "LLMO",
- "createdAt": "2024-01-15T10:30:00Z",
- "updatedAt": "2024-01-15T10:30:00Z",
- "updatedBy": "system"
List all organization identity providers for an organization
This endpoint retrieves all identity provider mappings for a specific organization.
@@ -2813,7 +2813,7 @@ " class="sc-eVqvcJ sc-fszimp kIppRw drqpJr">Development server
https://spacecat.experiencecloud.live/api/ci/organizations/{organizationId}/organization-identity-providerProduction server
-https://spacecat.experiencecloud.live/api/v1/organizations/{organizationId}/organization-identity-providerResponse samples
- 200
Content typeapplication/json[- {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "organizationId": "987fcdeb-51a2-43d7-9876-543210987654",
- "provider": "IMS",
- "externalId": "org123@adobe.com",
- "metadata": {
- "domain": "adobe.com",
- "ssoEnabled": true
- "createdAt": "2024-01-15T10:30:00Z",
- "updatedAt": "2024-01-15T10:30:00Z",
- "updatedBy": "system"
https://spacecat.experiencecloud.live/api/v1/organizations/{organizationId}/organization-identity-providerResponse samples
- 200
Content typeapplication/json[- {
- "id": "123e4567-e89b-12d3-a456-426614174000",
- "organizationId": "987fcdeb-51a2-43d7-9876-543210987654",
- "provider": "IMS",
- "externalId": "org123@adobe.com",
- "metadata": {
- "domain": "adobe.com",
- "ssoEnabled": true
- "createdAt": "2024-01-15T10:30:00Z",
- "updatedAt": "2024-01-15T10:30:00Z",
- "updatedBy": "system"
Response samples
- 200
- 429
Content typeapplication/json{- "message": "Triggered 1 of 2 audits for https://sandbox.example.com",
- "siteId": "123e4567-e89b-12d3-a456-426614174000",
- "results": [
- {
- "auditType": "meta-tags",
- "status": "triggered"
- {
- "auditType": "alt-text",
- "status": "skipped",
- "nextAllowedAt": "2025-08-15T15:37:48.419Z",
- "minutesRemaining": 45
Response samples
- 200
- 429
Content typeapplication/json{- "message": "Triggered 1 of 2 audits for https://sandbox.example.com",
- "siteId": "123e4567-e89b-12d3-a456-426614174000",
- "results": [
- {
- "auditType": "meta-tags",
- "status": "triggered"
- {
- "auditType": "alt-text",
- "status": "skipped",
- "nextAllowedAt": "2025-08-15T15:37:48.419Z",
- "minutesRemaining": 45
Get all reports for a site
Retrieves all reports generated for the specified site, including their current status and download links. +Reports can be in various states: processing, failed or success.
+Authorizations:
ims_keyscoped_api_keypath Parameters
siteId requiredstring <uuid> (Id)Example: 123e4567-e89b-12d3-a456-426614174000The site ID in uuid format
+Responses
Response samples
- 200
- 400
- 500
Content typeapplication/json{- "siteId": "550e8400-e29b-41d4-a716-446655440000",
- "count": 2,
- "reports": [
- {
- "id": "550e8400-e29b-41d4-a716-446655440001",
- "siteId": "550e8400-e29b-41d4-a716-446655440000",
- "reportType": "performance",
- "status": "success",
- "storagePath": "/reports/550e8400-e29b-41d4-a716-446655440000/performance/550e8400-e29b-41d4-a716-446655440001/",
- "reportPeriod": {
- "startDate": "2024-01-01",
- "endDate": "2024-01-31"
- "comparisonPeriod": {
- "startDate": "2023-12-01",
- "endDate": "2023-12-31"
- "createdAt": "2024-01-15T10:30:00Z",
- "updatedAt": "2024-01-15T11:45:00Z",
- "updatedBy": "user@example.com",
- "data": {
- "rawPresignedUrlExpiresAt": "2024-01-22T10:30:00Z",
- "mystiquePresignedUrl": "https://s3.amazonaws.com/bucket/reports/mystique/report.json?signature=...",
- "mystiquePresignedUrlExpiresAt": "2024-01-22T10:30:00Z"
- {
- "id": "550e8400-e29b-41d4-a716-446655440002",
- "siteId": "550e8400-e29b-41d4-a716-446655440000",
- "reportType": "seo",
- "status": "processing",
- "storagePath": "/reports/550e8400-e29b-41d4-a716-446655440000/seo/550e8400-e29b-41d4-a716-446655440002/",
- "reportPeriod": {
- "startDate": "2024-02-01",
- "endDate": "2024-02-28"
- "comparisonPeriod": {
- "startDate": "2024-01-01",
- "endDate": "2024-01-31"
- "createdAt": "2024-02-15T10:30:00Z",
- "updatedAt": "2024-02-15T10:30:00Z",
- "updatedBy": "user@example.com"
Create a new report generation job
Initiates the generation of a new report for the specified site and report type. +The report will go through multiple phases: generation, AI enhancement via Mystique, and finalization.
+Authorizations:
ims_keyscoped_api_keypath Parameters
siteId requiredstring <uuid> (Id)Example: 123e4567-e89b-12d3-a456-426614174000The site ID in uuid format
+Request Body schema: application/json
requiredreportType requiredstringEnum: "optimization" "performance"The type of report to generate
+name requiredstringThe name of the report (required)
+requiredobjectrequiredobjectResponses
Request samples
- Payload
Content typeapplication/json{- "reportType": "performance",
- "name": "Hersheyland",
- "reportPeriod": {
- "startDate": "2024-01-01",
- "endDate": "2024-01-31"
- "comparisonPeriod": {
- "startDate": "2023-12-01",
- "endDate": "2023-12-31"
Response samples
- 200
- 400
- 409
- 500
Content typeapplication/json{- "message": "Report generation job queued successfully",
- "siteId": "550e8400-e29b-41d4-a716-446655440000",
- "reportType": "performance",
- "status": "processing",
- "jobId": "550e8400-e29b-41d4-a716-446655440001",
- "timestamp": "2024-01-15T10:30:00Z"
Get a specific report
Retrieves detailed information about a specific report, including download links +for base and enhanced versions. Only returns reports with 'success' status. +Reports that are still processing will return a 400 error.
+Authorizations:
ims_keyscoped_api_keypath Parameters
siteId requiredstring <uuid> (Id)Example: 123e4567-e89b-12d3-a456-426614174000The site ID in uuid format
+reportId requiredstring <uuid>The unique identifier of the report
+Responses
Response samples
- 200
- 400
- 409
- 500
Content typeapplication/json{- "id": "550e8400-e29b-41d4-a716-446655440001",
- "siteId": "550e8400-e29b-41d4-a716-446655440000",
- "reportType": "performance",
- "status": "success",
- "storagePath": "/reports/550e8400-e29b-41d4-a716-446655440000/performance/550e8400-e29b-41d4-a716-446655440001/",
- "reportPeriod": {
- "startDate": "2024-01-01",
- "endDate": "2024-01-31"
- "comparisonPeriod": {
- "startDate": "2023-12-01",
- "endDate": "2023-12-31"
- "createdAt": "2024-01-15T10:30:00Z",
- "updatedAt": "2024-01-15T11:45:00Z",
- "updatedBy": "user@example.com",
- "data": {
- "rawPresignedUrlExpiresAt": "2024-01-22T10:30:00Z",
- "mystiquePresignedUrl": "https://s3.amazonaws.com/bucket/reports/mystique/report.json?signature=...",
- "mystiquePresignedUrlExpiresAt": "2024-01-22T10:30:00Z"
Update enhanced report data
Updates the enhanced report data in S3 storage for a specific report. +This endpoint only updates the enhanced report (Mystique analysis) and leaves the raw report unchanged. +Only reports with 'success' status can be updated.
+Authorizations:
ims_keyscoped_api_keypath Parameters
siteId requiredstring <uuid> (Id)Example: 123e4567-e89b-12d3-a456-426614174000The site ID in uuid format
+reportId requiredstring <uuid>The unique identifier of the report
+Request Body schema: application/json
requiredrequiredobjectThe enhanced report data to update
+Responses
Request samples
- Payload
Content typeapplication/json{- "data": {
- "summary": "Updated performance analysis",
- "insights": [
- "Improved Core Web Vitals",
- "Better SEO optimization"
- "recommendations": [
- "Optimize images",
- "Minimize CSS"
Response samples
- 200
- 400
- 500
Content typeapplication/json{- "message": "Enhanced report updated successfully",
- "siteId": "550e8400-e29b-41d4-a716-446655440000",
- "reportId": "550e8400-e29b-41d4-a716-446655440001",
- "updatedAt": "2024-01-15T11:45:00Z"
Delete a specific report
Deletes a specific report from the database and removes its associated files from S3 storage. +For successful reports, this includes both the raw report data and enhanced Mystique analysis files. +This action cannot be undone.
+Authorizations:
ims_keyscoped_api_keypath Parameters
siteId requiredstring <uuid> (Id)Example: 123e4567-e89b-12d3-a456-426614174000The site ID in uuid format
+reportId requiredstring <uuid>The unique identifier of the report
+Responses
Response samples
- 200
- 400
- 500
Content typeapplication/json{- "message": "Report deleted successfully",
- "siteId": "60189e9c-7d12-438c-b9ca-6998d9c364b1",
- "reportId": "836df459-dc40-4aa1-972a-6eb0a864dff9"
Get all application configurations
Authorizations:
admin_keyResponses
Production server
-https://spacecat.experiencecloud.live/api/v1/configurationsResponse samples
- 200
Content typeapplication/json[- {
- "version": "string",
- "jobs": [
- {
- "group": "string",
- "interval": "string",
- "type": "string"
- "queues": {
- "audits": "string",
- "imports": "string",
- "reports": "string"
Get the latest application configuration
Authorizations:
admin_keyResponses
Production server
-https://spacecat.experiencecloud.live/api/v1/configurations/latestResponse samples
- 200
Content typeapplication/json{- "version": "string",
- "jobs": [
- {
- "group": "string",
- "interval": "string",
- "type": "string"
- "queues": {
- "audits": "string",
- "imports": "string",
- "reports": "string"
Get a specific version of the application configuration
Authorizations:
admin_keypath Parameters
version requiredstringResponses
Response samples
- 200
Content typeapplication/json{- "version": "string",
- "jobs": [
- {
- "group": "string",
- "interval": "string",
- "type": "string"
- "queues": {
- "audits": "string",
- "imports": "string",
- "reports": "string"
Get a specific version of the application configuration
Authorizations:
admin_keypath Parameters
version requiredstringResponses
Production server
-https://spacecat.experiencecloud.live/api/v1/configurations/{version}Response samples
- 200
Content typeapplication/json{- "version": "string",
- "jobs": [
- {
- "group": "string",
- "interval": "string",
- "type": "string"
- "queues": {
- "audits": "string",
- "imports": "string",
- "reports": "string"
Response samples
- 200
Content typeapplication/json{- "version": "string",
- "jobs": [
- {
- "group": "string",
- "interval": "string",
- "type": "string"
- "queues": {
- "audits": "string",
- "imports": "string",
- "reports": "string"
Enable or disable audits for sites
Use this endpoint to enable or disable specific audit types for your sites.
Authorizations:
admin_keyRequest Body schema: application/json
requiredArray
