Recommendations

List ownership recommendations

Changed on

Lists the team ownership recommendations you can see, strongest first. By default it lists open ones: not rejected, and the team does not already own the entity. Archived entities and teams never appear.

get/api/v1/recommendations/ownership

Request

  • Base URL
    https://api.getcortexapp.com
  • URL
    https://api.getcortexapp.com/api/v1/recommendations/ownership
  • Auth
    HTTP bearer

Query parameters

entitiesstring[]

Only recommendations for these entities. A comma-delimited list of entity tags or CIDs, at most 1000. The whole request URL must stay under 8 KB, so split a long list across requests.

teamsstring[]

Only recommendations of these teams. A comma-delimited list of team tags or CIDs, at most 1000. The whole request URL must stay under 8 KB, so split a long list across requests.

confidence'HIGH' | 'LOW'

Only this confidence

status'OPEN' | 'PENDING' | 'REJECTED'

OPEN; PENDING for accepted ones waiting on a GitOps pull request; or REJECTED for rejected ones that can be restored

unownedOnlyboolean

Only entities that have no team owner yet

pageSizeinteger required

Number of results to return per page, between 1 and 1000. Default 250.

pageinteger required

Page number to return, 0-indexed. Default 0.

Response

A page of ownership recommendations

pageinteger required

Current page number, 0-indexed

totalinteger required

Total number of results

totalPagesinteger required

Total number of pages

Example response

{
  "recommendations": [
    {
      "confidence": "HIGH",
      "entity": {
        "id": "en2da8159dbeefb974",
        "name": "Checkout API",
        "tag": "checkout-api",
        "type": "service"
      },
      "id": "ptos3f7a1c09d2b84e6f5a0c71d9e8b2f4a6",
      "status": "OPEN",
      "team": {
        "id": "en9a01c4c0ffee0001",
        "name": "Payments",
        "tag": "payments"
      }
    }
  ]
}

Changes