Ferndesk

Get a report

Returns one report's numbers for a range, as Reporting shows them in Ferndesk: support_overview, ai_agent and satisfaction for Support and the AI agent, and help_center, searches and articles for the help center. Each number comes with a daily series, and with compare also its value over the period before the range.

GET /v1/reports/{name}
Bearer token scope reports:read

Path parameters

· 1
name string · enum required

values

  • support_overview
  • ai_agent
  • satisfaction
  • help_center
  • searches
  • articles

Query parameters

· 3
from string | string required

Start of the range, inclusive: an ISO 8601 timestamp or a YYYY-MM-DD day (UTC midnight).

to string | string required

End of the range, exclusive. At most 190 days after from.

compare string · default: false· enum

Also return each metric over the period of the same length right before the range.

values

  • true
  • false

Responses