Reference

Public API

Pull your latest visibility metrics into any tool.

Threadly's public API exposes your workspace's latest visibility summary for reporting scripts, dashboards and automations. Create a key in Settings > API access.

Authentication

Keys start with thly_ and are shown exactly once at creation - Threadly stores only their SHA-256 hash. Send the key as a bearer token:

Request

curl -H "Authorization: Bearer thly_..." https://www.gothreadly.live/api/v1/summary

GET /api/v1/summary

Returns your brand, tracked competitors, the latest scan run, and the headline metrics: mention rate, citation share, share of voice, average position, and per-provider breakdown.

Response shape

{
  "brand": { "name", "domain", "competitors": [{ "name", "domain" }] },
  "latestRun": { "id", "startedAt", "finishedAt", "queryCount", "providerStatus" },
  "metrics": { "mentionRate", "citationShare", "shareOfVoice", "avgPosition", "perProvider" }
}
  • Rate limit: 120 requests per hour per workspace.
  • Revoke a key anytime in Settings > API access - it stops working immediately.
  • Key creation and revocation are recorded in the Activity log.