From 0880612014462343023e015b95b961c137d653d8 Mon Sep 17 00:00:00 2001 From: ekremney Date: Wed, 5 Jun 2024 20:49:30 +0200 Subject: [PATCH] docs: api spec for the rum queries --- docs/index.html | 48 +++++++++++++++++++++-------- docs/openapi/api.yaml | 6 ++++ docs/openapi/rum-api.yaml | 63 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 104 insertions(+), 13 deletions(-) create mode 100644 docs/openapi/rum-api.yaml diff --git a/docs/index.html b/docs/index.html index ddb5b6e1..3723b4d6 100644 --- a/docs/index.html +++ b/docs/index.html @@ -425,7 +425,7 @@ -
SpaceCat logo
API docs by Redocly
SpaceCat logo
API docs by Redocly

SpaceCat API (1.40.0)

Download OpenAPI specification:Download

URL: https://github.com/adobe/spacecat-api-service License: Apache 2.0 Terms of Service

SpaceCat API (1.41.4)

Download OpenAPI specification:Download

URL: https://github.com/adobe/spacecat-api-service License: Apache 2.0 Terms of Service

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

-

Authentication

api_key

Security Scheme Type: API Key
Header parameter name: x-api-key

admin_key

Security Scheme Type: API Key
Header parameter name: x-api-key

site

Authentication

api_key

Security Scheme Type: API Key
Header parameter name: x-api-key

admin_key

Security Scheme Type: API Key
Header parameter name: x-api-key

domainkey

Security Scheme Type: API Key
Query parameter name: domainkey

site

Site operations

Retrieve all sites for an organization

This endpoint is useful for retrieving all sites for an organization.

@@ -1265,8 +1265,8 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX gayXgA">

The URLs to import

object (ImportOptions)

Optional configuration params, defined as a JSON object

-
importScript
string <base64>

The import.js mapping file

+
importScript
string <base64>

Optional import.js mapping file

Responses

Production server

-
https://spacecat.experiencecloud.live/api/v1/configurations/{version}

Response samples

Content type
application/json
{
  • "version": "string",
  • "jobs": [
    ],
  • "queues": {
    }
}

key event

Retrieve key events for a site

https://spacecat.experiencecloud.live/api/v1/configurations/{version}

Response samples

Content type
application/json
{
  • "version": "string",
  • "jobs": [
    ],
  • "queues": {
    }
}

rum

Execute the desired RUM query.

This endpoint is useful for retrieving a site by its ID.

+
Authorizations:
domainkey
path Parameters
query
required
string
Enum: "cwv" "404"

The type of RUM query to execute.

+
query Parameters
domain
required
string
Example: domain=www.aem.live

The domain for which to retrieve the RUM data.

+
domainkey
required
string

The domain-specific RUM bundler key.

+
interval
number
Default: 7

The time interval for which to retrieve data (in days).

+
granularity
required
string
Default: "daily"
Enum: "daily" "hourly"

The granularity of the RUM data retrieval.

+

Responses

Response samples

Content type
application/json
{ }

key event

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_key
path Parameters
siteId
required
string <uuid> (Id)
Example: 123e4567-e89b-12d3-a456-426614174000

The site ID in uuid format

@@ -1381,7 +1403,7 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX gayXgA">

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/key-events

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/key-events

Response samples

Content type
application/json
[
  • {
    }
]

Create a new key event for a site

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/key-events

Response samples

Content type
application/json
[
  • {
    }
]

Create a new key event for a site

The endpoint for creating new key events for a site

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

The site ID in uuid format

@@ -1399,7 +1421,7 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX gayXgA">

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/key-events

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/key-events

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "performance",
  • "time": "2024-01-19T14:20:30Z"
}

Response samples

Content type
application/json
{
  • "id": "a1b2c3d4-e5f6-7g8h-9i0j-k11l12m13n14",
  • "name": "Multiple 404s detected",
  • "type": "seo",
  • "time": "2023-12-15T09:30:00Z"
}

Delete a key event

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/key-events

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "performance",
  • "time": "2024-01-19T14:20:30Z"
}

Response samples

Content type
application/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_key
path Parameters
siteId
required
string <uuid> (Id)
Example: 123e4567-e89b-12d3-a456-426614174000

The site ID in uuid format

@@ -1441,7 +1463,7 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX gayXgA">

Development server

https://spacecat.experiencecloud.live/api/ci/sites/{siteId}/top-pages

Production server

-
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/top-pages

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve top pages for site by source

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/top-pages

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve top pages for site by source

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

Content type
application/json
[
  • {
    }
]

Retrieve top pages for site by source and geo

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/top-pages/{source}

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve top pages for site by source and geo

Not implemented yet. @@ -1489,7 +1511,7 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX gayXgA">

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

Content type
application/json
[
  • {
    }
]

experimental

Retrieve site metrics by source

https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/top-pages/{source}/{geo}

Response samples

Content type
application/json
[
  • {
    }
]

experimental

Retrieve site metrics by source

This endpoint is useful for retrieving site metrics by source.

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

The site ID in uuid format

@@ -1511,9 +1533,9 @@ " class="sc-eeDSqt sc-eBMFzZ bSgSrX gayXgA">

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

Content type
application/json
[
  • {
    }
]
+
https://spacecat.experiencecloud.live/api/v1/sites/{siteId}/metrics/{metric}/{source}

Response samples

Content type
application/json
[
  • {
    }
]