FruxonDocs
ApiKnowledge bases

Gets the runs and conversations a notice reached.

Production runs whose agent was given the notice while it was active, the conversations they belong to and the agents, and which of those conversations a later turn told that it ended (`toldItEnded`): after a withdrawal, the ones not told yet are where customers may still act on it. Runs are read from when the notice was posted until seven days after it ended. Up to 100 conversations with an agent you can open are listed, newest first, each with the ids its agent's Conversations tab opens it by; the others are counted in `otherConversations`.

GET
/v1/tenants/{tenant}/knowledgeBases/{knowledgeBase}/notices/{notice}/reach

Authorization

Bearer
AuthorizationBearer <token>

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

In: header

Path Parameters

knowledgeBase*string

The knowledge base id.

Formatuuid
notice*string

The notice id.

Formatuuid
tenant*string

The tenant identifier

Response Body

curl -X GET "https://api.fruxon.com/v1/tenants/string/knowledgeBases/497f6eca-6276-4993-bfeb-53cbbbba6f08/notices/497f6eca-6276-4993-bfeb-53cbbbba6f08/reach"
{
  "noticeId": "00000000-0000-0000-0000-000000000000",
  "runs": 0,
  "conversations": 0,
  "agents": 0,
  "toldItEnded": 0,
  "items": [
    {
      "agentId": "string",
      "sessionId": "string",
      "participantId": "00000000-0000-0000-0000-000000000000",
      "topicId": "00000000-0000-0000-0000-000000000000",
      "channelAddress": "string",
      "runId": "00000000-0000-0000-0000-000000000000",
      "runs": 0,
      "firstServedAt": 0,
      "lastServedAt": 0,
      "toldItEnded": false
    }
  ],
  "otherConversations": 0,
  "truncated": false
}
Empty
Empty
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}