REST API

Available on Growth and Agency. Pull visibility data into your own dashboards, or trigger scans from CI when you ship content.

Authentication

Send your API key as a bearer token. Find it in Settings.

curl http://www.queryque.com/api/v1/projects \
  -H "Authorization: Bearer ph_live_..."

Endpoints

Method	Path	Returns
GET	/api/v1/projects	All brands with current headline metrics
GET	/api/v1/projects/:id	One brand, plus per-engine and competitor breakdown
GET	/api/v1/projects/:id/prompts	Tracked prompts with latest per-prompt metrics
GET	/api/v1/projects/:id/history	Scan-by-scan history (?limit=, max 180)
GET	/api/v1/projects/:id/runs	Every graded answer in the latest scan (?include_answers=true)
POST	/api/v1/projects/:id/scan	Trigger a scan now; returns the resulting scores

Example response

GET /api/v1/projects

{
  "data": [
    {
      "id": 1,
      "name": "Northwind Analytics",
      "brand": "Northwind",
      "domain": "northwind.com",
      "competitors": ["Amplitude", "Mixpanel", "Heap"],
      "last_scan_at": "2026-07-28T09:14:02+00:00",
      "visibility": 62.8,
      "share_of_voice": 28.4,
      "mention_rate": 71.2
    }
  ]
}

Trigger a scan after a content deploy

Useful in CI — publish a comparison page, then measure whether the answers move.

curl -X POST http://www.queryque.com/api/v1/projects/1/scan \
  -H "Authorization: Bearer $PROMPTHAWK_KEY"

{"data":{"scan_id":42,"visibility":64.1,"share_of_voice":29.8,
         "mention_rate":73.4,"runs":160}}

Errors

401	Missing or invalid API key
402	Subscription is not active
403	Plan does not include API access
404	Project not found for this account