VEverdun
site summaries

Get Site Summary Settings

This site's summary settings; the defaults with is_default: true when no row exists. Readable by a customer-side login — it is their own report's schedule.

get/sites/{site_id}/summary-settings

Request

  • Base URL
    https://api.verdun.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.verdun.ai/sites/{site_id}/summary-settings
  • Auth
    HTTP bearer

Path parameters

site_idstring uuid required

Response

Successful Response

site_idstring required

Site UUID these settings belong to.

email_enabledboolean required

Whether the daily e-mail is sent for this site at all. Defaults to false — a site opts in.

send_local_timestring required

24h HH:MM wall clock in the site's timezone. The noon pivot reads off it: a morning send closes last night, an evening send closes today.

send_on_quiet_daysboolean required

Send even when nothing happened. False skips the mail and records a skipped_quiet send row.

min_outage_minutesinteger required

Shortest camera outage worth reporting, in minutes. Quantised to 5-minute telemetry buckets downstream, so the rendered value reads 'about N min'.

sectionsobject required

Which of the four e-mail sections render: narrative, stats, escalations, outages. Always all four keys.

is_defaultboolean required

True when NO settings row exists and these are the defaults. A row that happens to equal the defaults reads false.

Example response

{
  "site_id": "3f1e0d2c-1111-4222-8333-444455556666",
  "send_local_time": "07:00",
  "send_on_quiet_days": true,
  "min_outage_minutes": 10,
  "sections": {
    "escalations": true,
    "narrative": true,
    "outages": true,
    "stats": true
  },
  "is_default": true
}

Changes

No recorded changes to this operation across all 2 revisions of this API.