Ferndesk

Analytics

Get feedback analytics

Helpfulness KPIs and recent feedback rollup. For a paginated, triageable feedback resource use /feedback. Metrics are computed from the analytics pipeline and may read as zero during a pipeline outage rather than erroring. Requires the analytics:read scope.

Required scope: analytics:read

GET /analytics/feedback

Get feedback analytics

curl --request GET \
  --url 'https://api.ferndesk.com/v1/analytics/feedback' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
  "key": "<string>"
}

Analytics payload

Authorizations

  • Authorization string required header

    All requests require a Bearer token in the Authorization header. API keys are prefixed with fdsk_ and should be kept secret. You can generate and manage keys from the Developer settings page.

    Keys can be restricted to any subset of these scopes (each endpoint lists the scope it requires via x-required-scopes):

    • content:read: Read and search help center articles, collections, sections, and translations
    • content:write: Create and edit article drafts, users, tasks; move articles and collections
    • content:publish: Publish, unpublish, restore, and trash content (make changes live)
    • analytics:read: Read help center reporting, analytics, and article feedback
    • conversations:read: Read AI assistant conversations and transcripts
    • webhooks:manage: Create and manage outbound webhook subscriptions

    Granting content:write or content:publish implies content:read. Keys minted before scoping have null scopes = full access (legacy mode).

Query Parameters

  • end_date string

    ISO date upper bound.

  • start_date string

    ISO date lower bound.

Response

application/json
  • [key: string] any additional