Skip to content

Get a signed link to an endpoint's stats page​

GET
/v1/endpoints/{id}/stats/embed

Returns a short-lived signed URL for a self-contained HTML page of this endpoint's stats (the same numbers as getEndpointStats) that anyone can open or embed in an <iframe> without an API key. Mint it on your server and hand only the URL to the browser; the key never leaves your server.

The page shows the endpoint's name (never its receive URL), totals, latency, a chart, and destinations by name and type (never their URLs, queue ARNs or payloads). It runs no script, loads nothing external, refreshes itself every few minutes, and offers 24h/7d/30d tabs. Anyone holding the URL can view the page until expires_at; nothing is stored, so a link can't be revoked on its own, and it keeps working after the API key that minted it is revoked. Keep ttl short and mint a fresh link per page view. The page answers 410 once expired, 404 for a malformed link or a deleted endpoint, 429 beyond 300 views per endpoint per minute, and 503 if the stats can't be read right now — each an HTML page with no data. The token is readable (it carries the org and endpoint ids) but can't be altered.

Authorizations​

apiKey

Scoped API key. Scopes are read ⊂ write ⊂ admin. A call needing more scope than the key holds returns 403 insufficient_scope.

Type
HTTP (bearer)

Parameters​

Path Parameters

id*
Type
string
Required

Query Parameters

window

The tab the page opens on.

Type
string
Valid values
"24h""7d""30d"
Default
"24h"
theme

auto follows the viewer's light/dark preference.

Type
string
Valid values
"auto""light""dark"
Default
"auto"
ttl

Link lifetime in seconds, 60 to 604800 (7 days).

Type
integer
Minimum
60
Maximum
604800
Default
3600

Responses​

The signed page URL.

application/json
JSON
{
  
"url": "https://api.emithook.com/embed/stats/v1.eyJvIjoi…",
  
"expires_at": "string",
  
"window": "string",
  
"theme": "string"
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Emithook · a Finnoto product