Fetchply Docs
API reference
GET
/api/v1/agents/{id}/overview

One call answering "how is my agent doing": performance, demand, and items needing attention over the period (7d, 30d, or 90d). Requires the read:analytics permission.

Authorization

BearerAuth read:analytics
AuthorizationBearer <token>

In: header

Scope: read:analytics

Path Parameters

id*string

Query Parameters

period?string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/agents/string/overview"
{
  "property1": null,
  "property2": null
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}
{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

Send a message to an agent POST

Send a visitor message to an agent and receive its reply as JSON. Each delivered message uses one message credit from the account plan. Conversations appear in the dashboard Inbox under the API channel. Requires the `write:chat` permission.

Get agent analytics GET

Top questions, unanswered queries, satisfaction ratings, and visitor locations for the period. On plans without advanced analytics the advanced sections are empty and `advancedAnalytics` is false. Requires the `read:analytics` permission.