Get an AWS recommendation

get

https://api.doit.com/ps4commitments/v1/aws/organizations/{managementAccountId}/recommendations/{serviceId}

Returns the recommendation for one commitment type (serviceId) on the AWS organization, including analysis metrics and time-bucketed eligible spend. Use granularity to choose the eligible-spend bucket size (defaults to day).

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

managementAccountId

string

required

^\d{12}$

12-digit AWS management (payer) account ID (the account that owns the AWS Organization) that scopes the request.

serviceId

string

enum

required

Commitment type whose recommendation to retrieve. Must be an onboarded commitment type for the AWS organization (compute or database).

Show Details

compute	Compute commitment type (Savings Plans).
database	Database commitment type (Savings Plans).

Allowed:

Query Params

granularity

string

enum

Defaults to day

Time bucket size for eligible-spend data points on the recommendation response. If omitted, defaults to day. Coarser buckets return min/max/median usage; hour returns per-hour totals.

Show Details

hour	One point per hour (typically last 24 hours of eligible usage).
day	One point per day (typically last 21 days).
week	One point per week (typically last 16 weeks).
month	One point per month (typically last 6 months).

Allowed:

Headers

X-Tenant-Id

string

Customer (tenant) ID for the request. This is separate from authentication: you still pass your personal or service account API token in the Authorization header (Bearer <token>). See Get Started.

When to omit (most callers): If your personal or service account token belongs to a single customer, omit this header. The API resolves that customer from the token.

When to send: If your credential can access more than one customer, set X-Tenant-Id to the customer ID you want to act on. Omitting it returns 400 with code tenant_id_required. If the value conflicts with the tenants your credential may access, the request returns 400 with code tenant_id_mismatch. Prefer this header over the legacy customerContext query parameter, which only applies to legacy API keys and is ignored by personal and service account tokens.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200Commitment type recommendation together with the eligible-spend time series used for analysis and charting.

400Syntactically malformed request, missing required parameter, or unsupported parameter value.

401Missing or invalid credentials.

403Authenticated but not authorized to perform this request.

404The requested resource does not exist.

500Unexpected server error.

503Service temporarily unavailable; retry after the indicated delay.