Get prompt detail

The full picture for one prompt: headline numbers, the entity leaderboard for that question, and the per-engine split — in one request rather than three.

Use this when the question is “how am I doing on this specific question”, which is the natural follow-up once Prompt metrics has told you which prompt to look at.


GET /v1/brands/{brand_id}/prompts/{prompt_id}

Authorization

Header	Type	Required
`Authorization`	`Bearer asky_sk_…`	required

Path parameters

Parameter	Type	Required	Description
`brand_id`	`uuid`	required	From List brands
`prompt_id`	`uuid`	required	From List prompts

Query parameters

Parameter	Type	Required	Description
`start_date`	`YYYY-MM-DD`	optional	Inclusive lower bound, YYYY-MM-DD in UTC. Narrows the population before metrics are computed.
`end_date`	`YYYY-MM-DD`	optional	Inclusive upper bound, YYYY-MM-DD in UTC. Narrows the population before metrics are computed.
`engine`	`string`, repeatable	optional	Restrict to these AI search engines, by slug. From List engines. Narrows the population before metrics are computed.
`country`	`string`, repeatable	optional	Restrict to these execution country codes. Narrows the population before metrics are computed.

Request

cURL


curl --request GET \
  --url 'https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/prompts/7c2f5a91-3b8e-4d06-9a44-1e7b30c9f852' \
  --header 'Authorization: Bearer <api-key>'

Python


import requests
 
url = "https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/prompts/7c2f5a91-3b8e-4d06-9a44-1e7b30c9f852"
 
headers = {"Authorization": "Bearer <api-key>"}
 
response = requests.get(url, headers=headers)
 
print(response.text)

JavaScript


const options = {method: 'GET', headers: {Authorization: 'Bearer <api-key>'}};
 
fetch('https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/prompts/7c2f5a91-3b8e-4d06-9a44-1e7b30c9f852', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP


<?php
 
$curl = curl_init();
 
curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/prompts/7c2f5a91-3b8e-4d06-9a44-1e7b30c9f852",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <api-key>"
  ],
]);
 
$response = curl_exec($curl);
$err = curl_error($curl);
 
curl_close($curl);
 
if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Go


package main
 
import (
    "fmt"
    "net/http"
    "io"
)
 
func main() {
 
    url := "https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/prompts/7c2f5a91-3b8e-4d06-9a44-1e7b30c9f852"
 
    req, _ := http.NewRequest("GET", url, nil)
 
    req.Header.Add("Authorization", "Bearer <api-key>")
 
    res, _ := http.DefaultClient.Do(req)
 
    defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)
 
    fmt.Println(string(body))
 
}

Ruby


require 'uri'
require 'net/http'
 
url = URI("https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/prompts/7c2f5a91-3b8e-4d06-9a44-1e7b30c9f852")
 
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
 
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <api-key>'
 
response = http.request(request)
puts response.read_body

Response

200


{
  "data": {
    "period": { "start_date": "2026-08-06", "end_date": "2026-08-13" },
    "prompt": {
      "id": "7c2f5a91-3b8e-4d06-9a44-1e7b30c9f852",
      "prompt_text": "best AI visibility tracking tools",
      "topic_id": "4beb0694-7c2e-488b-84c1-613738e7eaf6",
      "is_active": true
    },
    "kpis": {
      "responses": 84,
      "mentioned_responses": 35,
      "mention_rate_pct": 41.7,
      "cited_responses": 20,
      "citation_rate_pct": 23.8,
      "avg_position": 2.4
    },
    "leaderboard": [
      { "rank": 1, "name": "Peec AI", "is_our_brand": false, "visibility_pct": 46.4, "mention_count": 39, "avg_rank": 2.1, "citation_rate_pct": 27.4 },
      { "rank": 2, "name": "Asky", "is_our_brand": true, "visibility_pct": 41.7, "mention_count": 35, "avg_rank": 2.4, "citation_rate_pct": 23.8 }
    ],
    "by_engine": [
      { "provider": "openai", "model_used": "ChatGPT", "executions": 42, "mention_rate_pct": 47.6, "citation_rate_pct": 28.6 }
    ]
  },
  "request_id": "req_15fd8a904c3b47e2b8a6"
}

401


{
  "error": {
    "code": "token_expired",
    "message": "This API key has expired. Roll it in Settings to get a replacement.",
    "request_id": "req_8f21c0aa47b1490d2e63"
  }
}

404


{
  "error": {
    "code": "not_found",
    "message": "Not found.",
    "request_id": "req_5b0e77d213a94f6a8ce1"
  }
}

429


{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Retry after 24 seconds.",
    "request_id": "req_31c9ba7f0e5d4a118cc2"
  }
}

Response fields

Field	Type	Description
`data.period`	`object`	required. `{ start_date, end_date }` actually used. Defaults differ between endpoints, so read it before comparing
`data.prompt`	`object`	required. `{ id, prompt_text, topic_id, is_active }`
`data.kpis`	`object`	required. Headline counts and rates for this prompt
`data.kpis.responses`	`integer`	required
`data.kpis.mention_rate_pct`	`number \| null`
`data.kpis.citation_rate_pct`	`number \| null`
`data.kpis.avg_position`	`number \| null`
`data.leaderboard`	`object[]`	required. You and every competitor on this prompt, ranked
`data.by_engine`	`object[]`	required. `{ provider, model_used, executions, mention_rate_pct, citation_rate_pct }`
`request_id`	`string`	required. Also returned as the `x-request-id` header. Quote it when contacting support

Errors

Status	Code	When
400	`invalid_request`	A parameter is unknown or malformed. The message names it
401	`invalid_token`	The key is missing, malformed, or does not exist
401	`token_expired`	The key passed its expiry date
401	`token_revoked`	The key was revoked
404	`not_found`	The brand does not exist, or this key is not allowed to reach it. The two are deliberately indistinguishable
429	`rate_limited`	Over 300 requests per minute. See the `Retry-After` header

Notes

The leaderboard is scoped to this prompt only. A brand that leads overall can sit third here, which is exactly the kind of thing an aggregate number hides.

Note the default window is 7 days, shorter than the 30-day default on Prompt metrics. Set both dates explicitly if you are comparing the two.