Fetchply Docs
API reference

Get agent analytics

GET
/api/v1/agents/{id}/analytics

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.

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/analytics"
{
  "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"
    }
  ]
}

Get agent overview GET

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.

List unanswered questions GET

Questions the agent could not answer in the period: the most actionable training signal. Returns 403 with the required plan on plans without advanced analytics. Requires the `read:analytics` permission.