Signalby Metrics Hive
Start

Get report status and data

GET
/reports/{reportId}

Poll a report's status. When completed, returns per-prompt snapshot data with raw mention counts. Consumers are responsible for computing SoV and other derived metrics from the raw data.

Requires an instance admin key; organization keys receive 403.

Authorization

BearerAuth
headerAuthorizationBearer <token>

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

Path Parameters

reportId*string

The ID of the report

Formatuuid

Query Parameters

kMentions?integer

Number of top competitor entities to return in each prompt's mentionsTopK

Range1 <= value <= 50
Default5

Response Body

Report status and data. When status is 'completed', includes per-prompt snapshot data with raw mention counts.

application/json
  1. response
reportId*string
Formatuuid
status*string
Value in"pending""processing""completed""failed"
progress?integer

Generation progress percentage (0-100). Available while processing.

brandName*string
brandAliases*array<string>
brandWebsite*string
createdAt*string
Formatdate-time
completedAt*|
Formatdate-time
prompts?array<>

Per-prompt snapshot data. Only present when status is 'completed'.

unstable?

Derived stats (SoV, visibility, etc.). Format may change between versions. Only present when status is 'completed'.

Example Request
curl -X GET 'https://app.signal.metricshive.com/api/v1/reports/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{
  "reportId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "status": "completed",
  "brandName": "Acme Corp",
  "brandAliases": [
    "Acme"
  ],
  "brandWebsite": "acme.com",
  "createdAt": "2026-04-08T10:00:00Z",
  "completedAt": "2026-04-08T10:05:00Z",
  "prompts": [
    {
      "promptValue": "best project management tools",
      "totalRuns": 4,
      "mentions": {
        "mentionsTotal": 7,
        "brandMentionsTotal": 3,
        "competitorMentionsTotal": 4,
        "mentionsTopK": [
          {
            "entity": "Competitor A",
            "count": 2
          },
          {
            "entity": "Competitor B",
            "count": 2
          }
        ]
      }
    }
  ],
  "unstable": {
    "sov": 0.42,
    "visibility": 0.6,
    "totalPrompts": 70,
    "totalPromptRuns": 280,
    "promptsWithBrandMentions": 28,
    "promptRunsWithBrandMentions": 168,
    "competitors": [
      {
        "name": "Competitor A",
        "sov": 0.35,
        "visibility": 0.35,
        "promptsWithMentions": 45,
        "promptRunsWithMentions": 98
      },
      {
        "name": "Competitor B",
        "sov": 0.15,
        "visibility": 0.15,
        "promptsWithMentions": 20,
        "promptRunsWithMentions": 42
      }
    ]
  }
}