FruxonDocs
ApiAgent reviews

Lists the agent's recommendation cards.

Cards waiting on an admin — `OPEN` and `RECURRING` — come first, then the newest. With no `status`, every card but the `CANDIDATE`s still gathering evidence. `totalCount` is always set, so `status=OPEN&status=RECURRING&pageSize=1` is the tab's badge. Agent admins only.

GET
/v1/tenants/{tenant}/agents/{agent}/recommendations
AuthorizationBearer <token>

JWT Authorization header using the Bearer scheme. Enter 'Bearer' [space] and then your token.

In: header

Path Parameters

agent*string

The agent ID.

tenant*string

The tenant identifier

Query Parameters

PageSize?integer

The maximum number of items to return per page

Formatint32
PageToken.Skip?integer
Formatint32
PageToken.Cursor?string

Opaque pagination token returned by an external service. Pass it back unchanged rather than interpreting it as an offset.

status?array<AgentRecommendationStatus>

Only cards in these statuses.

Response Body

curl -X GET "https://api.fruxon.com/v1/tenants/string/agents/string/recommendations"
{
  "items": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "kind": "ADD_TOOLS",
      "category": "MISSING_CAPABILITY",
      "severity": "LOW",
      "status": "CANDIDATE",
      "title": "string",
      "summary": "string",
      "need": "string",
      "patch": {
        "tools": [],
        "instructionText": "string",
        "replaceAnchor": "string",
        "adviceMarkdown": "string",
        "feature": "string"
      },
      "evidenceCount": 0,
      "customerCount": 0,
      "firstSeenAt": 0,
      "lastSeenAt": 0,
      "baseRevision": 0,
      "changedSince": 0,
      "changedAt": 0,
      "appliedRevision": 0,
      "previousRevision": 0,
      "appliedBy": "string",
      "appliedAt": 0,
      "dismissedBy": "string",
      "dismissedAt": 0,
      "dismissReason": "NOT_RELEVANT",
      "dismissNote": "string",
      "obsoleteReason": "string",
      "comparison": {
        "id": null,
        "patchRevision": null,
        "cardRunId": null,
        "otherRunId": null,
        "regressionRunId": null,
        "cardTurns": null,
        "otherTurns": null,
        "regressionTurns": null,
        "sandboxRouting": null,
        "baseRevision": 0,
        "startedAt": 0,
        "startedBy": "string",
        "recheck": null
      },
      "patchRevision": 0,
      "revisions": [],
      "version": 0
    }
  ],
  "nextPageToken": "string",
  "totalCount": 0
}
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}