Recommender API
Recommender API endpoints from Google
AI & machine learning#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Recommender API endpoints from Google
Endpoints 9
projects.locations.recommenders.recommendations
- GETGets the requested recommendation
/v1/:nameGets the requested recommendation. Requires the recommender.*.get IAM permission for the specified recommender. - GETLists recommendations for the specified Cloud Resource
/v1/:parent/recommendations?filter=string&pageSize=0&pageToken=stringLists recommendations for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified recommender. - POSTMarks the Recommendation State as Claimed
/v1/:name:markClaimedMarks the Recommendation State as Claimed. Users can use this method to indicate to the Recommender API that they are starting to apply the recommendation… - POSTMark the Recommendation State as Dismissed
/v1/:name:markDismissedMark the Recommendation State as Dismissed. Users can use this method to indicate to the Recommender API that an ACTIVE recommendation has to be marked back… - POSTMarks the Recommendation State as Failed
/v1/:name:markFailedMarks the Recommendation State as Failed. Users can use this method to indicate to the Recommender API that they have applied the recommendation themselves,… - POSTMarks the Recommendation State as Succeeded
/v1/:name:markSucceededMarks the Recommendation State as Succeeded. Users can use this method to indicate to the Recommender API that they have applied the recommendation…
projects.locations.recommenders
- PATCHUpdates a Recommender Config
/v1/:name?updateMask=string&validateOnly=trueUpdates a Recommender Config. This will create a new revision of the config.
projects.locations.insightTypes.insights
- GETLists insights for the specified Cloud Resource
/v1/:parent/insights?filter=string&pageSize=0&pageToken=stringLists insights for the specified Cloud Resource. Requires the recommender.*.list IAM permission for the specified insight type. - POSTMarks the Insight State as Accepted
/v1/:name:markAcceptedMarks the Insight State as Accepted. Users can use this method to indicate to the Recommender API that they have applied some action based on the insight.…
API details
- Base URL
https://recommender.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 1 scope
An API key in the key query parameter - Operations
- 9 operations on 8 pathsPOST 5GET 3PATCH 1
- Main resources
- projects.locations.recommenders.recommendations 6projects.locations.insightTypes.insights 2projects.locations.recommenders 1
- Response formats
application/json- Description format
- Google API Discovery, API version
v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Recommender API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Recommender API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Gets the requested recommendation” (GET /v1/:name), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Recommender API?
Recommender API endpoints from Google It is listed under AI & machine learning and has 9 endpoints.
Who publishes the Recommender API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Recommender API?
Requests go to https://recommender.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Recommender API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 1 scope; an API key in the key query parameter.
How many endpoints does the Recommender API have?
9 operations on 8 paths (5 POST, 3 GET, 1 PATCH). The largest groups are projects.locations.recommenders.recommendations, projects.locations.insightTypes.insights, projects.locations.recommenders.
Is forking the Recommender API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.