Inspect report recipient confirmation REST API

GET

/api/report-recipient-confirmations/{opaque_token}

curl --request GET \
  --url http://127.0.0.1:25737/api/report-recipient-confirmations/example

Returns non-sensitive team, report, cadence, site-domain, and expiry metadata without changing consent.

Parameters

Path Parameters

opaque_token

required

string

Single-use opaque report-recipient confirmation token.

Responses

200

Confirmation metadata

Media typeapplication/json

object

expires_at

required

string format: date-time

preset

required

string

report_name

required

string

schedule

required

object

frequency

required

string

Allowed values: daily weekly monthly

local_time

required

string

/^([01][0-9]|2[0-3]):(00|15|30|45)$/

monthly_day

integer

>= 1 <= 28

timezone

required

IANA timezone name.

string

weekly_day

integer

<= 6

sites

required

Array<object>

object

domain

string

id

string format: uuid

team_name

required

string

Example

{
  "schedule": {
    "frequency": "daily"
  }
}

400

Invalid confirmation

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}

410

Expired confirmation

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}