Field guide / Analytics APIReviewable source / main

Analytics API

AIOps suggestion lifecycle (generate, review, accept, implement, reject) and cost/capacity analytics readouts.

18 routes

Response metadata: x-api-version, x-request-id, and traceresponse apply to normal routed responses and are omitted from the per-operation header tables below.

GET`/api/analytics/aiops-contract`

request access

Aiops contract.

Permissions

Access class	Credential	Scoping
`request`	An authenticated session or API bearer token is required.	The access class is enforced first; site and environment scopes narrow resources on scoped operations.

HTTP request

GET https://<your-host>/api/analytics/aiops-contract

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Name	Type	Requirement	Description
`Authorization`	`string`	Optional	Human credential alternative: supply one `Bearer rys_...` session token, `ryk_...` API token, or validated identity-provider JWT here. Do not combine it with `X-Ryuki-Session-Id` or the session cookie; conflicting carriers fail closed.
`X-Ryuki-Session-Id`	`string`	Optional	Opaque `rys_...` session-token carrier used by the portal for mutations. Administrative session UUIDs cannot authenticate. Supply exactly one credential carrier per request.
`traceparent`	`string`	Optional	Optional correlation input. When the second dash-separated segment has 32 characters, Ryuki reuses it as the request correlation identifier; this is not full W3C validation.

Request body

This operation does not accept a request body.

Response

Status	Description	Body
`200`	OK	`Value`

`200` response body

Structure: Value.

Name	Type	Requirement	Description
`source`	`string`	Required	Origin or authority of the returned data.
`providerCallsEnabled`	`boolean`	Required	Value of `providerCallsEnabled` returned in the response body.
`liveCorrelationAllowed`	`boolean`	Required	Value of `liveCorrelationAllowed` returned in the response body.
`liveRemediationAllowed`	`boolean`	Required	Value of `liveRemediationAllowed` returned in the response body.
`automationDispatchAllowed`	`boolean`	Required	Value of `automationDispatchAllowed` returned in the response body.
`rawOperationRowsAllowed`	`boolean`	Required	Value of `rawOperationRowsAllowed` returned in the response body.
`rawProviderPayloadsAllowed`	`boolean`	Required	Value of `rawProviderPayloadsAllowed` returned in the response body.
`suggestionTypes`	`array<JSON value>`	Required	Value of `suggestionTypes` returned in the response body.
`suggestionStatuses`	`array<JSON value>`	Required	Value of `suggestionStatuses` returned in the response body.
`endpoints`	`JSON value`	Required	Value of `endpoints` returned in the response body.
`sites`	`array<JSON value>`	Required	Value of `sites` returned in the response body.
`requiredGuards`	`array<JSON value>`	Required	Value of `requiredGuards` returned in the response body.
`blockedReasons`	`array<JSON value>`	Required	Value of `blockedReasons` returned in the response body.

Errors

JSON failures use one of the platform error envelopes and include the request correlation metadata when routing reaches the API middleware. See Errors for the exact shapes, authentication failures, retry guidance, and transport-level exceptions.

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/analytics/aiops-contract'

Schematic response body

Illustrative shape generated from the extracted field types, not a recorded live response. Values are placeholders; null marks a field whose type could not be resolved.

Success status: 200

{
  "source": "<string>",
  "providerCallsEnabled": false,
  "liveCorrelationAllowed": false,
  "liveRemediationAllowed": false,
  "automationDispatchAllowed": false,
  "rawOperationRowsAllowed": false,
  "rawProviderPayloadsAllowed": false,
  "suggestionTypes": [],
  "suggestionStatuses": [],
  "endpoints": null,
  "sites": [],
  "requiredGuards": [],
  "blockedReasons": []
}

POST`/api/analytics/aiops/accept/{id}`

execute access

Aiops accept.

Permissions

Access class	Credential	Scoping
`execute`	An authenticated session or API bearer token is required.	The access class is enforced first; site and environment scopes narrow resources on scoped operations.

HTTP request

POST https://<your-host>/api/analytics/aiops/accept/{id}

Path parameters

Name	Type	Requirement	Description
`id`	`string`	Required	Identifier of the target resource in the request path.

Query parameters

This operation has no query parameters.

Request headers

Name	Type	Requirement	Description
`Authorization`	`string`	Optional	Human credential alternative: supply one `Bearer rys_...` session token, `ryk_...` API token, or validated identity-provider JWT here. Do not combine it with `X-Ryuki-Session-Id` or the session cookie; conflicting carriers fail closed.
`X-Ryuki-Session-Id`	`string`	Optional	Opaque `rys_...` session-token carrier used by the portal for mutations. Administrative session UUIDs cannot authenticate. Supply exactly one credential carrier per request.
`Idempotency-Key`	`string`	Optional	Optional at-most-once retry key for human mutations. When omitted, the idempotency middleware passes the request through without deduplication.
`traceparent`	`string`	Optional	Optional correlation input. When the second dash-separated segment has 32 characters, Ryuki reuses it as the request correlation identifier; this is not full W3C validation.

Request body

This operation does not accept a request body.

Response

Status	Description	Body
`200`	OK	`Value`

`200` response body

Structure: Value.

Name	Type	Requirement	Description
`source`	`string`	Required	Origin or authority of the returned data.
`id`	`JSON value`	Required	Identifier of the returned resource.
`status`	`JSON value`	Required	Current operation or resource status.
`implementation_plan`	`JSON value`	Required	Value of `implementation_plan` returned in the response body.
`updated_at`	`JSON value`	Required	RFC 3339 timestamp when the resource was last updated.

Errors

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/analytics/aiops/accept/<id>'

Schematic response body

Illustrative shape generated from the extracted field types, not a recorded live response. Values are placeholders; null marks a field whose type could not be resolved.

Success status: 200

{
  "source": "<string>",
  "id": null,
  "status": null,
  "implementation_plan": null,
  "updated_at": null
}

POST`/api/analytics/aiops/generate`

execute access

Aiops generate.

Permissions

Access class	Credential	Scoping
`execute`	An authenticated session or API bearer token is required.	The access class is enforced first; site and environment scopes narrow resources on scoped operations.

HTTP request

POST https://<your-host>/api/analytics/aiops/generate

Path parameters

This operation has no path parameters.

Query parameters

Name	Type	Requirement	Description
`site`	`string`	Optional	Site identifier used to scope or filter the operation.

Request headers

Name	Type	Requirement	Description
`Authorization`	`string`	Optional	Human credential alternative: supply one `Bearer rys_...` session token, `ryk_...` API token, or validated identity-provider JWT here. Do not combine it with `X-Ryuki-Session-Id` or the session cookie; conflicting carriers fail closed.
`X-Ryuki-Session-Id`	`string`	Optional	Opaque `rys_...` session-token carrier used by the portal for mutations. Administrative session UUIDs cannot authenticate. Supply exactly one credential carrier per request.
`Idempotency-Key`	`string`	Optional	Optional at-most-once retry key for human mutations. When omitted, the idempotency middleware passes the request through without deduplication.
`traceparent`	`string`	Optional	Optional correlation input. When the second dash-separated segment has 32 characters, Ryuki reuses it as the request correlation identifier; this is not full W3C validation.

Request body

This operation does not accept a request body.

Response

Status	Description	Body
`200`	OK	`Value`

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/analytics/aiops/generate'

POST`/api/analytics/aiops/implement/{id}`

execute access

Implement aiops.

Permissions

Access class	Credential	Scoping
`execute`	An authenticated session or API bearer token is required.	The access class is enforced first; site and environment scopes narrow resources on scoped operations.

HTTP request

POST https://<your-host>/api/analytics/aiops/implement/{id}

Path parameters

Name	Type	Requirement	Description
`id`	`string`	Required	Identifier of the target resource in the request path.

Query parameters

This operation has no query parameters.

Request headers

Name	Type	Requirement	Description
`Authorization`	`string`	Optional	Human credential alternative: supply one `Bearer rys_...` session token, `ryk_...` API token, or validated identity-provider JWT here. Do not combine it with `X-Ryuki-Session-Id` or the session cookie; conflicting carriers fail closed.
`X-Ryuki-Session-Id`	`string`	Optional	Opaque `rys_...` session-token carrier used by the portal for mutations. Administrative session UUIDs cannot authenticate. Supply exactly one credential carrier per request.
`Idempotency-Key`	`string`	Optional	Optional at-most-once retry key for human mutations. When omitted, the idempotency middleware passes the request through without deduplication.
`traceparent`	`string`	Optional	Optional correlation input. When the second dash-separated segment has 32 characters, Ryuki reuses it as the request correlation identifier; this is not full W3C validation.

Request body

This operation does not accept a request body.

Response

Status	Description	Body
`200`	OK	`Value`

`200` response body

Structure: Value.

Name	Type	Requirement	Description
`source`	`string`	Required	Origin or authority of the returned data.
`id`	`JSON value`	Required	Identifier of the returned resource.
`status`	`JSON value`	Required	Current operation or resource status.
`updated_at`	`JSON value`	Required	RFC 3339 timestamp when the resource was last updated.
`note`	`string`	Required	Value of `note` returned in the response body.

Errors

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/analytics/aiops/implement/<id>'

Schematic response body

Illustrative shape generated from the extracted field types, not a recorded live response. Values are placeholders; null marks a field whose type could not be resolved.

Success status: 200

{
  "source": "<string>",
  "id": null,
  "status": null,
  "updated_at": null,
  "note": "<string>"
}

POST`/api/analytics/aiops/reject/{id}`

execute access

Reject aiops.

Permissions

Access class	Credential	Scoping
`execute`	An authenticated session or API bearer token is required.	The access class is enforced first; site and environment scopes narrow resources on scoped operations.

HTTP request

POST https://<your-host>/api/analytics/aiops/reject/{id}

Path parameters

Name	Type	Requirement	Description
`id`	`string`	Required	Identifier of the target resource in the request path.

Query parameters

This operation has no query parameters.

Request headers

Name	Type	Requirement	Description
`Authorization`	`string`	Optional	Human credential alternative: supply one `Bearer rys_...` session token, `ryk_...` API token, or validated identity-provider JWT here. Do not combine it with `X-Ryuki-Session-Id` or the session cookie; conflicting carriers fail closed.
`Content-Type`	`string`	Required	Required by the resolved Axum `Json<T>` request extractor; send `application/json`.
`X-Ryuki-Session-Id`	`string`	Optional	Opaque `rys_...` session-token carrier used by the portal for mutations. Administrative session UUIDs cannot authenticate. Supply exactly one credential carrier per request.
`Idempotency-Key`	`string`	Optional	Optional at-most-once retry key for human mutations. When omitted, the idempotency middleware passes the request through without deduplication.
`traceparent`	`string`	Optional	Optional correlation input. When the second dash-separated segment has 32 characters, Ryuki reuses it as the request correlation identifier; this is not full W3C validation.

Request body

JSON structure: AiopsRejectRequest.

Name	Type	Requirement	Description
`reason`	`string`	Required	Human-readable reason recorded with the operation and its audit trail.

Response

Status	Description	Body
`200`	OK	`Value`

`200` response body

Structure: Value.

Name	Type	Requirement	Description
`source`	`string`	Required	Origin or authority of the returned data.
`id`	`JSON value`	Required	Identifier of the returned resource.
`status`	`JSON value`	Required	Current operation or resource status.
`rejection_reason`	`JSON value`	Required	Value of `rejection_reason` returned in the response body.
`updated_at`	`JSON value`	Required	RFC 3339 timestamp when the resource was last updated.

Errors

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{"reason":"<string>"}' \
  'https://<your-host>/api/analytics/aiops/reject/<id>'

Schematic response body

Illustrative shape generated from the extracted field types, not a recorded live response. Values are placeholders; null marks a field whose type could not be resolved.

Success status: 200

{
  "source": "<string>",
  "id": null,
  "status": null,
  "rejection_reason": null,
  "updated_at": null
}

POST`/api/analytics/aiops/review/{id}`

execute access

Aiops review.

Permissions

Access class	Credential	Scoping
`execute`	An authenticated session or API bearer token is required.	The access class is enforced first; site and environment scopes narrow resources on scoped operations.

HTTP request

POST https://<your-host>/api/analytics/aiops/review/{id}

Path parameters

Name	Type	Requirement	Description
`id`	`string`	Required	Identifier of the target resource in the request path.

Query parameters

This operation has no query parameters.

Request headers

Name	Type	Requirement	Description
`Authorization`	`string`	Optional	Human credential alternative: supply one `Bearer rys_...` session token, `ryk_...` API token, or validated identity-provider JWT here. Do not combine it with `X-Ryuki-Session-Id` or the session cookie; conflicting carriers fail closed.
`X-Ryuki-Session-Id`	`string`	Optional	Opaque `rys_...` session-token carrier used by the portal for mutations. Administrative session UUIDs cannot authenticate. Supply exactly one credential carrier per request.
`Idempotency-Key`	`string`	Optional	Optional at-most-once retry key for human mutations. When omitted, the idempotency middleware passes the request through without deduplication.
`traceparent`	`string`	Optional	Optional correlation input. When the second dash-separated segment has 32 characters, Ryuki reuses it as the request correlation identifier; this is not full W3C validation.

Request body

This operation does not accept a request body.

Response

Status	Description	Body
`200`	OK	`Value`

`200` response body

Structure: Value.

Name	Type	Requirement	Description
`source`	`string`	Required	Origin or authority of the returned data.
`id`	`JSON value`	Required	Identifier of the returned resource.
`status`	`JSON value`	Required	Current operation or resource status.
`reviewer`	`JSON value`	Required	Value of `reviewer` returned in the response body.
`updated_at`	`JSON value`	Required	RFC 3339 timestamp when the resource was last updated.

Errors

Examples

Request

curl --silent --show-error --globoff \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  'https://<your-host>/api/analytics/aiops/review/<id>'

Schematic response body

Illustrative shape generated from the extracted field types, not a recorded live response. Values are placeholders; null marks a field whose type could not be resolved.

Success status: 200

{
  "source": "<string>",
  "id": null,
  "status": null,
  "reviewer": null,
  "updated_at": null
}

GET`/api/analytics/aiops/savings`

audit access

Aiops savings.

Permissions

Access class	Credential	Scoping
`audit`	An authenticated session or API bearer token is required.	The access class is enforced first; site and environment scopes narrow resources on scoped operations.

HTTP request

GET https://<your-host>/api/analytics/aiops/savings

Path parameters

This operation has no path parameters.

Query parameters

Name	Type	Requirement	Description
`site`	`string`	Optional	Site identifier used to scope or filter the operation.

Request headers

Name	Type	Requirement	Description
`Authorization`	`string`	Optional	Human credential alternative: supply one `Bearer rys_...` session token, `ryk_...` API token, or validated identity-provider JWT here. Do not combine it with `X-Ryuki-Session-Id` or the session cookie; conflicting carriers fail closed.
`X-Ryuki-Session-Id`	`string`	Optional	Opaque `rys_...` session-token carrier used by the portal for mutations. Administrative session UUIDs cannot authenticate. Supply exactly one credential carrier per request.
`traceparent`	`string`	Optional	Optional correlation input. When the second dash-separated segment has 32 characters, Ryuki reuses it as the request correlation identifier; this is not full W3C validation.

Request body

This operation does not accept a request body.

Response

Status	Description	Body
`200`	OK	`Value`

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/analytics/aiops/savings'

GET`/api/analytics/aiops/stats`

audit access

Aiops stats.

Permissions

Access class	Credential	Scoping
`audit`	An authenticated session or API bearer token is required.	The access class is enforced first; site and environment scopes narrow resources on scoped operations.

HTTP request

GET https://<your-host>/api/analytics/aiops/stats

Path parameters

This operation has no path parameters.

Query parameters

Name	Type	Requirement	Description
`site`	`string`	Optional	Site identifier used to scope or filter the operation.

Request headers

Name	Type	Requirement	Description
`Authorization`	`string`	Optional	Human credential alternative: supply one `Bearer rys_...` session token, `ryk_...` API token, or validated identity-provider JWT here. Do not combine it with `X-Ryuki-Session-Id` or the session cookie; conflicting carriers fail closed.
`X-Ryuki-Session-Id`	`string`	Optional	Opaque `rys_...` session-token carrier used by the portal for mutations. Administrative session UUIDs cannot authenticate. Supply exactly one credential carrier per request.
`traceparent`	`string`	Optional	Optional correlation input. When the second dash-separated segment has 32 characters, Ryuki reuses it as the request correlation identifier; this is not full W3C validation.

Request body

This operation does not accept a request body.

Response

Status	Description	Body
`200`	OK	`Value`

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/analytics/aiops/stats'

GET`/api/analytics/aiops/type`

audit access

Aiops type.

Permissions

Access class	Credential	Scoping
`audit`	An authenticated session or API bearer token is required.	The access class is enforced first; site and environment scopes narrow resources on scoped operations.

HTTP request

GET https://<your-host>/api/analytics/aiops/type

Path parameters

This operation has no path parameters.

Query parameters

Name	Type	Requirement	Description
`type`	`string`	Required	Value supplied for the `type` query parameter.

Request headers

Name	Type	Requirement	Description
`Authorization`	`string`	Optional	Human credential alternative: supply one `Bearer rys_...` session token, `ryk_...` API token, or validated identity-provider JWT here. Do not combine it with `X-Ryuki-Session-Id` or the session cookie; conflicting carriers fail closed.
`X-Ryuki-Session-Id`	`string`	Optional	Opaque `rys_...` session-token carrier used by the portal for mutations. Administrative session UUIDs cannot authenticate. Supply exactly one credential carrier per request.
`traceparent`	`string`	Optional	Optional correlation input. When the second dash-separated segment has 32 characters, Ryuki reuses it as the request correlation identifier; this is not full W3C validation.

Request body

This operation does not accept a request body.

Response

Status	Description	Body
`200`	OK	`Value`

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/analytics/aiops/type?type=<type>'

GET`/api/analytics/capacity`

audit access

Analytics capacity.

Permissions

Access class	Credential	Scoping
`audit`	An authenticated session or API bearer token is required.	The access class is enforced first; site and environment scopes narrow resources on scoped operations.

HTTP request

GET https://<your-host>/api/analytics/capacity

Path parameters

This operation has no path parameters.

Query parameters

Name	Type	Requirement	Description
`site`	`string`	Optional	Site code to analyze. Defaults to `DEFRA` only when scope resolution is unambiguous; an out-of-scope value is rejected.

Request headers

Name	Type	Requirement	Description
`Authorization`	`string`	Optional	Human credential alternative: supply one `Bearer rys_...` session token, `ryk_...` API token, or validated identity-provider JWT here. Do not combine it with `X-Ryuki-Session-Id` or the session cookie; conflicting carriers fail closed.
`X-Ryuki-Session-Id`	`string`	Optional	Opaque `rys_...` session-token carrier used by the portal for mutations. Administrative session UUIDs cannot authenticate. Supply exactly one credential carrier per request.
`traceparent`	`string`	Optional	Optional correlation input. When the second dash-separated segment has 32 characters, Ryuki reuses it as the request correlation identifier; this is not full W3C validation.

Request body

This operation does not accept a request body.

Response

Status	Description	Body
`200`	OK	`Value`

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/analytics/capacity'

GET`/api/analytics/capacity/cluster`

audit access

Analytics capacity cluster.

Permissions

Access class	Credential	Scoping
`audit`	An authenticated session or API bearer token is required.	The access class is enforced first; site and environment scopes narrow resources on scoped operations.

HTTP request

GET https://<your-host>/api/analytics/capacity/cluster

Path parameters

This operation has no path parameters.

Query parameters

Name	Type	Requirement	Description
`site`	`string`	Optional	Site code to analyze; subject to the caller's site scope.
`cluster`	`string`	Optional	Cluster name within the selected site. Defaults to `defra-general-cluster`.

Request headers

Name	Type	Requirement	Description
`Authorization`	`string`	Optional	Human credential alternative: supply one `Bearer rys_...` session token, `ryk_...` API token, or validated identity-provider JWT here. Do not combine it with `X-Ryuki-Session-Id` or the session cookie; conflicting carriers fail closed.
`X-Ryuki-Session-Id`	`string`	Optional	Opaque `rys_...` session-token carrier used by the portal for mutations. Administrative session UUIDs cannot authenticate. Supply exactly one credential carrier per request.
`traceparent`	`string`	Optional	Optional correlation input. When the second dash-separated segment has 32 characters, Ryuki reuses it as the request correlation identifier; this is not full W3C validation.

Request body

This operation does not accept a request body.

Response

Status	Description	Body
`200`	OK	`Value`

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/analytics/capacity/cluster'

GET`/api/analytics/capacity/forecast`

audit access

Analytics capacity forecast.

Permissions

Access class	Credential	Scoping
`audit`	An authenticated session or API bearer token is required.	The access class is enforced first; site and environment scopes narrow resources on scoped operations.

HTTP request

GET https://<your-host>/api/analytics/capacity/forecast

Path parameters

This operation has no path parameters.

Query parameters

Name	Type	Requirement	Description
`site`	`string`	Optional	Site code to forecast; subject to the caller's site scope.
`months`	`integer`	Optional	Forecast horizon in months. Defaults to `6`.

Request headers

Name	Type	Requirement	Description
`Authorization`	`string`	Optional	Human credential alternative: supply one `Bearer rys_...` session token, `ryk_...` API token, or validated identity-provider JWT here. Do not combine it with `X-Ryuki-Session-Id` or the session cookie; conflicting carriers fail closed.
`X-Ryuki-Session-Id`	`string`	Optional	Opaque `rys_...` session-token carrier used by the portal for mutations. Administrative session UUIDs cannot authenticate. Supply exactly one credential carrier per request.
`traceparent`	`string`	Optional	Optional correlation input. When the second dash-separated segment has 32 characters, Ryuki reuses it as the request correlation identifier; this is not full W3C validation.

Request body

This operation does not accept a request body.

Response

Status	Description	Body
`200`	OK	`Value`

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/analytics/capacity/forecast'

GET`/api/analytics/contract`

audit access

Analytics contract.

Permissions

Access class	Credential	Scoping
`audit`	An authenticated session or API bearer token is required.	The access class is enforced first; site and environment scopes narrow resources on scoped operations.

HTTP request

GET https://<your-host>/api/analytics/contract

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Name	Type	Requirement	Description
`Authorization`	`string`	Optional	Human credential alternative: supply one `Bearer rys_...` session token, `ryk_...` API token, or validated identity-provider JWT here. Do not combine it with `X-Ryuki-Session-Id` or the session cookie; conflicting carriers fail closed.
`X-Ryuki-Session-Id`	`string`	Optional	Opaque `rys_...` session-token carrier used by the portal for mutations. Administrative session UUIDs cannot authenticate. Supply exactly one credential carrier per request.
`traceparent`	`string`	Optional	Optional correlation input. When the second dash-separated segment has 32 characters, Ryuki reuses it as the request correlation identifier; this is not full W3C validation.

Request body

This operation does not accept a request body.

Response

Status	Description	Body
`200`	OK	`Value`

`200` response body

Structure: Value.

Name	Type	Requirement	Description
`source`	`string`	Required	Origin or authority of the returned data.
`providerCallsEnabled`	`boolean`	Required	Value of `providerCallsEnabled` returned in the response body.
`domains`	`array<JSON value>`	Required	Value of `domains` returned in the response body.
`endpoints`	`JSON value`	Required	Value of `endpoints` returned in the response body.
`metrics`	`array<JSON value>`	Required	Value of `metrics` returned in the response body.
`sites`	`array<JSON value>`	Required	Value of `sites` returned in the response body.
`signals`	`array<JSON value>`	Required	Value of `signals` returned in the response body.
`requiredGuards`	`array<JSON value>`	Required	Value of `requiredGuards` returned in the response body.
`blockedReasons`	`array<JSON value>`	Required	Value of `blockedReasons` returned in the response body.

Errors

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/analytics/contract'

Schematic response body

Illustrative shape generated from the extracted field types, not a recorded live response. Values are placeholders; null marks a field whose type could not be resolved.

Success status: 200

{
  "source": "<string>",
  "providerCallsEnabled": false,
  "domains": [],
  "endpoints": null,
  "metrics": [],
  "sites": [],
  "signals": [],
  "requiredGuards": [],
  "blockedReasons": []
}

GET`/api/analytics/cost-capacity-contract`

request access

Analytics cost capacity.

Permissions

Access class	Credential	Scoping
`request`	An authenticated session or API bearer token is required.	The access class is enforced first; site and environment scopes narrow resources on scoped operations.

HTTP request

GET https://<your-host>/api/analytics/cost-capacity-contract

Path parameters

This operation has no path parameters.

Query parameters

This operation has no query parameters.

Request headers

Name	Type	Requirement	Description
`Authorization`	`string`	Optional	Human credential alternative: supply one `Bearer rys_...` session token, `ryk_...` API token, or validated identity-provider JWT here. Do not combine it with `X-Ryuki-Session-Id` or the session cookie; conflicting carriers fail closed.
`X-Ryuki-Session-Id`	`string`	Optional	Opaque `rys_...` session-token carrier used by the portal for mutations. Administrative session UUIDs cannot authenticate. Supply exactly one credential carrier per request.
`traceparent`	`string`	Optional	Optional correlation input. When the second dash-separated segment has 32 characters, Ryuki reuses it as the request correlation identifier; this is not full W3C validation.

Request body

This operation does not accept a request body.

Response

Status	Description	Body
`200`	OK	`Value`

`200` response body

Structure: Value.

Name	Type	Requirement	Description
`source`	`string`	Required	Origin or authority of the returned data.
`providerCallsEnabled`	`boolean`	Required	Value of `providerCallsEnabled` returned in the response body.
`platformScope`	`array<JSON value>`	Required	Value of `platformScope` returned in the response body.
`domains`	`array<JSON value>`	Required	Value of `domains` returned in the response body.
`signals`	`array<JSON value>`	Required	Value of `signals` returned in the response body.
`requiredGuards`	`array<JSON value>`	Required	Value of `requiredGuards` returned in the response body.
`planSections`	`array<JSON value>`	Required	Value of `planSections` returned in the response body.
`blockedReasons`	`array<JSON value>`	Required	Value of `blockedReasons` returned in the response body.

Errors

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/analytics/cost-capacity-contract'

Schematic response body

Illustrative shape generated from the extracted field types, not a recorded live response. Values are placeholders; null marks a field whose type could not be resolved.

Success status: 200

{
  "source": "<string>",
  "providerCallsEnabled": false,
  "platformScope": [],
  "domains": [],
  "signals": [],
  "requiredGuards": [],
  "planSections": [],
  "blockedReasons": []
}

GET`/api/analytics/cost/summary`

audit access

Analytics cost summary.

Permissions

Access class	Credential	Scoping
`audit`	An authenticated session or API bearer token is required.	The access class is enforced first; site and environment scopes narrow resources on scoped operations.

HTTP request

GET https://<your-host>/api/analytics/cost/summary

Path parameters

This operation has no path parameters.

Query parameters

Name	Type	Requirement	Description
`site`	`string`	Optional	Site code to analyze. Defaults to `DEFRA` only when scope resolution is unambiguous; an out-of-scope value is rejected.

Request headers

Name	Type	Requirement	Description
`Authorization`	`string`	Optional	Human credential alternative: supply one `Bearer rys_...` session token, `ryk_...` API token, or validated identity-provider JWT here. Do not combine it with `X-Ryuki-Session-Id` or the session cookie; conflicting carriers fail closed.
`X-Ryuki-Session-Id`	`string`	Optional	Opaque `rys_...` session-token carrier used by the portal for mutations. Administrative session UUIDs cannot authenticate. Supply exactly one credential carrier per request.
`traceparent`	`string`	Optional	Optional correlation input. When the second dash-separated segment has 32 characters, Ryuki reuses it as the request correlation identifier; this is not full W3C validation.

Request body

This operation does not accept a request body.

Response

Status	Description	Body
`200`	OK	`Value`

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/analytics/cost/summary'

GET`/api/analytics/rightsizing`

audit access

Analytics rightsizing.

Permissions

Access class	Credential	Scoping
`audit`	An authenticated session or API bearer token is required.	The access class is enforced first; site and environment scopes narrow resources on scoped operations.

HTTP request

GET https://<your-host>/api/analytics/rightsizing

Path parameters

This operation has no path parameters.

Query parameters

Name	Type	Requirement	Description
`site`	`string`	Optional	Site code to analyze. Defaults to `DEFRA` only when scope resolution is unambiguous; an out-of-scope value is rejected.

Request headers

Name	Type	Requirement	Description
`Authorization`	`string`	Optional	Human credential alternative: supply one `Bearer rys_...` session token, `ryk_...` API token, or validated identity-provider JWT here. Do not combine it with `X-Ryuki-Session-Id` or the session cookie; conflicting carriers fail closed.
`X-Ryuki-Session-Id`	`string`	Optional	Opaque `rys_...` session-token carrier used by the portal for mutations. Administrative session UUIDs cannot authenticate. Supply exactly one credential carrier per request.
`traceparent`	`string`	Optional	Optional correlation input. When the second dash-separated segment has 32 characters, Ryuki reuses it as the request correlation identifier; this is not full W3C validation.

Request body

This operation does not accept a request body.

Response

Status	Description	Body
`200`	OK	`Value`

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/analytics/rightsizing'

GET`/api/analytics/trend`

audit access

Analytics trend.

Permissions

Access class	Credential	Scoping
`audit`	An authenticated session or API bearer token is required.	The access class is enforced first; site and environment scopes narrow resources on scoped operations.

HTTP request

GET https://<your-host>/api/analytics/trend

Path parameters

This operation has no path parameters.

Query parameters

Name	Type	Requirement	Description
`site`	`string`	Optional	Site code to analyze; subject to the caller's site scope.
`metric`	`string`	Optional	Trend metric name. Defaults to `cpu`; unsupported metrics return `400`.

Request headers

Name	Type	Requirement	Description
`Authorization`	`string`	Optional	Human credential alternative: supply one `Bearer rys_...` session token, `ryk_...` API token, or validated identity-provider JWT here. Do not combine it with `X-Ryuki-Session-Id` or the session cookie; conflicting carriers fail closed.
`X-Ryuki-Session-Id`	`string`	Optional	Opaque `rys_...` session-token carrier used by the portal for mutations. Administrative session UUIDs cannot authenticate. Supply exactly one credential carrier per request.
`traceparent`	`string`	Optional	Optional correlation input. When the second dash-separated segment has 32 characters, Ryuki reuses it as the request correlation identifier; this is not full W3C validation.

Request body

This operation does not accept a request body.

Response

Status	Description	Body
`200`	OK	`Value`

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/analytics/trend'

GET`/api/analytics/waste`

audit access

Analytics waste.

Permissions

Access class	Credential	Scoping
`audit`	An authenticated session or API bearer token is required.	The access class is enforced first; site and environment scopes narrow resources on scoped operations.

HTTP request

GET https://<your-host>/api/analytics/waste

Path parameters

This operation has no path parameters.

Query parameters

Name	Type	Requirement	Description
`site`	`string`	Optional	Site code to analyze. Defaults to `DEFRA` only when scope resolution is unambiguous; an out-of-scope value is rejected.

Request headers

Name	Type	Requirement	Description
`Authorization`	`string`	Optional	Human credential alternative: supply one `Bearer rys_...` session token, `ryk_...` API token, or validated identity-provider JWT here. Do not combine it with `X-Ryuki-Session-Id` or the session cookie; conflicting carriers fail closed.
`X-Ryuki-Session-Id`	`string`	Optional	Opaque `rys_...` session-token carrier used by the portal for mutations. Administrative session UUIDs cannot authenticate. Supply exactly one credential carrier per request.
`traceparent`	`string`	Optional	Optional correlation input. When the second dash-separated segment has 32 characters, Ryuki reuses it as the request correlation identifier; this is not full W3C validation.

Request body

This operation does not accept a request body.

Response

Status	Description	Body
`200`	OK	`Value`

For 200, the known response body type is Value. Its field schema is unavailable, so no JSON shape is inferred.

Errors

Examples

Request

curl --silent --show-error --globoff \
  --request GET \
  --header 'Authorization: Bearer <token>' \
  'https://<your-host>/api/analytics/waste'

Last updated 2026-07-16 · Generated from the API route registrations.

Analytics API

GET/api/analytics/aiops-contract

Permissions

HTTP request

Path parameters

Query parameters

Request headers

Request body

Response

200 response body

Errors

Examples

Request

Schematic response body

POST/api/analytics/aiops/accept/{id}

Permissions

HTTP request

Path parameters

Query parameters

Request headers

Request body

Response

200 response body

Errors

Examples

Request

Schematic response body

POST/api/analytics/aiops/generate

Permissions

HTTP request

Path parameters

Query parameters

Request headers

Request body

Response

Errors

Examples

Request

POST/api/analytics/aiops/implement/{id}

Permissions

HTTP request

Path parameters

Query parameters

Request headers

Request body

Response

200 response body

Errors

Examples

Request

Schematic response body

POST/api/analytics/aiops/reject/{id}

Permissions

HTTP request

Path parameters

Query parameters

Request headers

Request body

Response

200 response body

Errors

Examples

Request

Schematic response body

POST/api/analytics/aiops/review/{id}

Permissions

HTTP request

Path parameters

Query parameters

Request headers

Request body

Response

200 response body

Errors

Examples

Request

Schematic response body

GET/api/analytics/aiops/savings

Permissions

HTTP request

GET`/api/analytics/aiops-contract`

`200` response body

POST`/api/analytics/aiops/accept/{id}`

`200` response body

POST`/api/analytics/aiops/generate`

POST`/api/analytics/aiops/implement/{id}`

`200` response body

POST`/api/analytics/aiops/reject/{id}`

`200` response body

POST`/api/analytics/aiops/review/{id}`

`200` response body

GET`/api/analytics/aiops/savings`

GET`/api/analytics/aiops/stats`

GET`/api/analytics/aiops/type`

GET`/api/analytics/capacity`

GET`/api/analytics/capacity/cluster`

GET`/api/analytics/capacity/forecast`

GET`/api/analytics/contract`