Signalby Metrics Hive
Start

List prompt performance

GET
/brands/{brandId}/prompt-performance

Per-prompt mention rates over the window. The analytics counterpart to GET /prompts?brandId=, which returns prompt configuration rather than results.

A prompt the brand stopped tracking is not sampled, so it has no results over the window and does not appear here.

Authorization

BearerAuth
headerAuthorizationBearer <token>

An organization key (signal_…) created under Organization Settings → API Keys.

Path Parameters

brandId*string

Brand identifier.

Query Parameters

start*string

Inclusive lower bound of the window, an ISO 8601 timestamp such as 2026-01-01T00:00:00Z. Aligned down to the quarter hour, the grain analytics are aggregated at; where a response repeats the window, it repeats the aligned one. A bare YYYY-MM-DD is rejected: that is /prompts/{promptId}/snapshot's spelling and means a local calendar day there.

Formatdate-time
end*string

Exclusive upper bound of the window, an ISO 8601 timestamp, also aligned down to the quarter hour. The window is half-open: a run at exactly end is outside it. start and end inside one quarter-hour bucket leave an empty window and are rejected.

Formatdate-time
model?string

Restrict to one model, e.g. chatgpt. See GET /models.

tags?string

Comma-separated prompt tags. Only prompts carrying at least one of them are counted.

Response Body

List prompt performance

application/json
  1. response
brandId*string
range*

The window the response was computed over, echoed back as the half-open instants it resolved to.

data*array<>

Every prompt sampled over the window, with its results.

Example Request
curl -X GET 'https://app.signal.metricshive.com/api/v1/brands/string/prompt-performance?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z'
Example Response
{
  "brandId": "string",
  "range": {
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z"
  },
  "data": [
    {
      "promptId": "b5415d63-4390-40ec-8c2b-33a2db2f5c67",
      "value": "string",
      "tags": [
        "string"
      ],
      "totalRuns": 0,
      "brandMentionRate": 0,
      "competitorMentionRate": 0,
      "lastRunAt": "2019-08-24T14:15:22Z",
      "firstEvaluatedAt": "2019-08-24T14:15:22Z",
      "sentiment": {
        "positive": 0,
        "neutral": 0,
        "negative": 0,
        "mixed": 0,
        "score": 0
      },
      "position": {
        "average": 1
      }
    }
  ]
}