MetriBeacon
Menu

GET Read subscriber and delivery states

/api/v1/status-pages/{id}/subscribers

Authenticated page administration with active-session, ownership, page-role and CSRF checks. Sources, members, domains, delivery rules and whole-page withdrawal require the owner. Editors save drafts; publishers release approved content. version detects parallel edits. Public delivery acknowledges matching publication revisions before publication or revocation is complete.

On this page

Access and permissions

Authenticated page administration with active-session, ownership, page-role and CSRF checks. Sources, members, domains, delivery rules and whole-page withdrawal require the owner. Editors save drafts; publishers release approved content. version detects parallel edits. Public delivery acknowledges matching publication revisions before publication or revocation is complete.

Browser session: __Host-mb_session cookie.

Machine management credentials in Authorization: Bearer. Check the permissions (scopes) required by the operation.

Parameters and headers

FieldLocationType and limitsRequiredMeaning
idPathstring; {"format":"uuid"}YesUUID of the status page resource
tableURL querystring; {"enum":["1"]}NoSet to 1 for a filtered cursor page; omitting table parameters preserves the original response.
qURL querystring; {"maxLength":128}NoCase-insensitive literal search in the documented text fields, applied before the page limit.
limitURL queryinteger; {"default":50,"maximum":100,"minimum":1}NoPage size, 1–100; default 50. A following page exists only when another matching row is available.
cursorURL querystring; {"maxLength":4096}NoOpaque next_cursor from the preceding page. Keep resource, account, filters, sort and limit unchanged; collection cursors expire after 15 minutes.
sortURL querystring; {"enum":["newest","oldest","name_asc","name_desc"]}NoStable order with the record ID as a tie breaker: newest, oldest, name_asc or name_desc.
channelURL querystringNoExact field filter; omit the parameter to include all values.
confirmationURL querystringNoExact field filter; omit the parameter to include all values.
languageURL querystringNoExact field filter; omit the parameter to include all values.
counts_onlyURL querystring; {"enum":["1"]}NoReturn counts for the requested filter instead of table rows. Counts include search and other filters, excluding this filter selection, sorting and pagination.
count_filterURL querystring; {"enum":["confirmation","channel","language"]}NoDeclared table filter to count. Requires counts_only=1.
snapshotURL querystring; {"format":"date-time"}NoOptional snapshot from the corresponding table page.

Request body

No request body.

Responses

application/json

FieldType and limitsRequiredMeaning
$object | objectYes—
$ (anyOf 1)objectNo—
$ (anyOf 1).failedintegerYes—
$ (anyOf 1).queuedintegerYes—
$ (anyOf 1).subscribersarray<object; {"additionalProperties":true}>Yes—
$ (anyOf 1).subscribers[]object; {"additionalProperties":true}Yes—
$ (anyOf 1).limitinteger; {"maximum":100,"minimum":1}No—
$ (anyOf 1).next_cursorstringNoCursor for the next matching page; empty when no following page exists.
$ (anyOf 1).snapshotstring; {"format":"date-time"}NoUTC snapshot bound to the cursor; later-created rows do not enter that page sequence.
$ (anyOf 2)objectNo—
$ (anyOf 2).filter_countsTableFilterCountsYes—
$ (anyOf 2).filter_counts.fieldstringYes—
$ (anyOf 2).filter_counts.totalinteger; {"minimum":0}Yes—
$ (anyOf 2).filter_counts.valuesobjectYes—
$ (anyOf 2).filter_counts.completebooleanYes—
$ (anyOf 2).filter_counts.snapshotstring; {"format":"date-time"}Yes—
$ (anyOf 2).filter_counts.counted_atstring; {"format":"date-time"}Yes—
Stable error codes
status_page_operation

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
status_page_operation

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
status_page_operation

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
status_page_operation

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
status_page_operation

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—
Stable error codes
status_page_operation
status_pages_disabled

application/problem+json

FieldType and limitsRequiredMeaning
$ProblemYes—
$.codestringYesStable machine-readable error code
$.detailstringYesShort localized explanation without internal error details
$.instancestringYesUnique relative identifier /api/v1/requests/{request_id}; not a retrievable resource
$.messagestringYesTemporarily identical to detail for existing clients
$.message_keystringYesStable translation key for changing the displayed language without another request
$.message_paramsobject; {"additionalProperties":true}YesNamed, safely rendered message parameters; never arbitrary HTML
$.request_idstring; {"pattern":"^[0-9a-f]{32}$"}YesServer-generated diagnostic identifier. It contains no login token or credential.
$.statusinteger; {"maximum":599,"minimum":400}Yes—
$.titlestringYesLocalized HTTP status title
$.typestring; {"const":"about:blank"}Yes—

Retries and asynchronous work

This operation reads or validates without applying a resource mutation. Respect rate limits and credential lifetime.

Request examples

Replace demo IDs, timestamps and placeholders with your own values. For a retry, keep the same IDs, time and content. These examples do not run requests on this page.

Keep login links, codes, cookies and keys private. Do not print them in logs or share them in support requests.

shell
curl --request GET --cookie '__Host-mb_session=SESSION; __Host-mb_csrf=CSRF' --header 'X-CSRF-Token: CSRF' 'https://metribeacon.com/api/v1/status-pages/11111111-1111-4111-8111-111111111111/subscribers'
python
import requests
response = requests.request("GET","https://metribeacon.com/api/v1/status-pages/11111111-1111-4111-8111-111111111111/subscribers",cookies={"__Host-mb_session":"SESSION","__Host-mb_csrf":"CSRF"},headers={"X-CSRF-Token":"CSRF"})
response.raise_for_status()
javascript
const response = await fetch("https://metribeacon.com/api/v1/status-pages/11111111-1111-4111-8111-111111111111/subscribers", {signal:AbortSignal.timeout(10000),method:"GET",credentials:"same-origin",headers:{"Content-Type":"application/json","X-CSRF-Token":csrf}});
if (!response.ok) throw new Error(String(response.status));
go
package main

import (
  "fmt"
  "net/http"
  "time"
)

func main() {
  if err := requestStatus(); err != nil { panic("request failed; credentials and response omitted") }
}

func requestStatus() error {
  req, err := http.NewRequest("GET", "https://metribeacon.com/api/v1/status-pages/11111111-1111-4111-8111-111111111111/subscribers", nil)
  if err != nil { return err }
  req.AddCookie(&http.Cookie{Name:"__Host-mb_session",Value:"SESSION"})
  req.AddCookie(&http.Cookie{Name:"__Host-mb_csrf",Value:"CSRF"})
  req.Header.Set("X-CSRF-Token","CSRF")
  client := &http.Client{Timeout: 10*time.Second}
  response, err := client.Do(req)
  if err != nil { return err }
  defer response.Body.Close()
  fmt.Println(response.StatusCode)
  return nil
}
  • HTTP API, OAuth and MCP

    Find the user API endpoints, their permissions, fields, examples and response formats.

  • POST Register a signed webhook and verify its receiver

    Authenticated page administration with active-session, ownership, page-role and CSRF checks. Sources, members, domains, delivery rules and whole-page withdrawal require the owner. Editors save drafts; publishers release approved content. version detects parallel edits. Public delivery acknowledges matching publication revisions before publication or revocation is complete.

  • DELETE Remove a page subscriber

    Authenticated page administration with active-session, ownership, page-role and CSRF checks. Sources, members, domains, delivery rules and whole-page withdrawal require the owner. Editors save drafts; publishers release approved content. version detects parallel edits. Public delivery acknowledges matching publication revisions before publication or revocation is complete.

  • DELETE Revoke or delete public delivery

    Authenticated page administration with active-session, ownership, page-role and CSRF checks. Sources, members, domains, delivery rules and whole-page withdrawal require the owner. Editors save drafts; publishers release approved content. version detects parallel edits. Public delivery acknowledges matching publication revisions before publication or revocation is complete.