Skip to main content

Customer API — Introduction

The Customer API provides secure and standardized access to monthly usage metrics of the Hand Talk Plugin.
It was designed to allow external developers, BI teams, partners, and automated systems to consume consolidated accessibility and performance data.

What this API provides

The Customer API gives access to consolidated metrics from the previous month of usage of the Hand Talk Plugin, including:

  • Translation volume
    (total accumulated, daily, and monthly)

  • Assistive Resources usage
    Indicators that reflect user interactions with accessibility features.

  • User distribution by location and device
    Helps identify regions and platforms with higher engagement.

  • Most accessed pages
    Main URLs where the plugin showed higher activity.

The API is read-only, ensuring stability and security.

Base URL​

https://api.handtalk.me/

All documented endpoints use this URL as the entry point.

Quick example​

A minimal authenticated request to fetch reports:

curl -X GET "https://customer-api.handtalk.me/api/reports"
  -H "Authorization: Bearer {token}"
  -H "Content-Type: application/json"