The following documentation is provided to let users of the Speak Benefits status page programmatically access various elements on the page. Endpoints are displayed with examples using cURL and our embeded javascript widget (if available).

• Javascript library

1. Summary
2. Status
3. Incidents
   • Unresolved
   • All
4. Scheduled maintenances
   • Upcoming
   • Active
   • All

A wrapper for the page status api, exposing convenient actions useful for embedding your status anywhere.

Get a summary of the status page, including a status indicator, component statuses, unresolved incidents, and any upcoming or in-progress scheduled maintenances.

## using JS widget
<script type="text/javascript" src="https://cdn.statuspage.io/se-v2.js"></script>
<script>
  var sp = new StatusPage.page({ page : 'dc0t2lxm2p57' });
  sp.summary({
    success : function(data) {
      console.log(data.components[0].status);
    }
  });
</script>

## using cURL
curl https://status.speakbenefits.com/api/v2/summary.json
            

{
  "page": {
    "id": "dc0t2lxm2p57",
    "name": "Speak Benefits",
    "url": "https://status.speakbenefits.com",
    "updated_at": "2024-11-21T03:18:34Z"
  },
  "status": {
    "description": "Partial System Outage",
    "indicator": "major"
  }
  "components": [
    {
      "created_at": "2014-05-03T01:22:07.274Z",
      "description": null,
      "id": "b13yz5g2cw10",
      "name": "API",
      "page_id": "dc0t2lxm2p57",
      "position": 1,
      "status": "partial_outage",
      "updated_at": "2014-05-14T20:34:43.340Z"
    },
    {
      "created_at": "2014-05-03T01:22:07.286Z",
      "description": null,
      "id": "9397cnvk62zn",
      "name": "Management Portal",
      "page_id": "dc0t2lxm2p57",
      "position": 2,
      "status": "major_outage",
      "updated_at": "2014-05-14T20:34:44.470Z"
    }
  ],
  "incidents": [
    {
      "created_at": "2014-05-14T14:22:39.441-06:00",
      "id": "cp306tmzcl0y",
      "impact": "critical",
      "incident_updates": [
        {
          "body": "Our master database has ham sandwiches flying out of the rack, and we're working our hardest to stop the bleeding. The whole site is down while we restore functionality, and we'll provide another update within 30 minutes.",
          "created_at": "2014-05-14T14:22:40.301-06:00",
          "display_at": "2014-05-14T14:22:40.301-06:00",
          "id": "jdy3tw5mt5r5",
          "incident_id": "cp306tmzcl0y",
          "status": "identified",
          "updated_at": "2014-05-14T14:22:40.301-06:00"
        }
      ],
      "monitoring_at": null,
      "name": "Unplanned Database Outage",
      "page_id": "dc0t2lxm2p57",
      "resolved_at": null,
      "shortlink": "http://stspg.co:5000/Q0E",
      "status": "identified",
      "updated_at": "2014-05-14T14:35:21.711-06:00"
    }
  ],
  "scheduled_maintenances": [
    {
      "created_at": "2014-05-14T14:24:40.430-06:00",
      "id": "w1zdr745wmfy",
      "impact": "none",
      "incident_updates": [
        {
          "body": "Our data center has informed us that they will be performing routine network maintenance. No interruption in service is expected. Any issues during this maintenance should be directed to our support center",
          "created_at": "2014-05-14T14:24:41.913-06:00",
          "display_at": "2014-05-14T14:24:41.913-06:00",
          "id": "qq0vx910b3qj",
          "incident_id": "w1zdr745wmfy",
          "status": "scheduled",
          "updated_at": "2014-05-14T14:24:41.913-06:00"
        }
      ],
      "monitoring_at": null,
      "name": "Network Maintenance (No Interruption Expected)",
      "page_id": "dc0t2lxm2p57",
      "resolved_at": null,
      "scheduled_for": "2014-05-17T22:00:00.000-06:00",
      "scheduled_until": "2014-05-17T23:30:00.000-06:00",
      "shortlink": "http://stspg.co:5000/Q0F",
      "status": "scheduled",
      "updated_at": "2014-05-14T14:24:41.918-06:00"
    },
    {
      "created_at": "2014-05-14T14:27:17.303-06:00",
      "id": "k7mf5z1gz05c",
      "impact": "minor",
      "incident_updates": [
        {
          "body": "Scheduled maintenance is currently in progress. We will provide updates as necessary.",
          "created_at": "2014-05-14T14:34:20.036-06:00",
          "display_at": "2014-05-14T14:34:20.036-06:00",
          "id": "drs62w8df6fs",
          "incident_id": "k7mf5z1gz05c",
          "status": "in_progress",
          "updated_at": "2014-05-14T14:34:20.036-06:00"
        },
        {
          "body": "We will be performing rolling upgrades to our web tier with a new kernel version so that Heartbleed will stop making us lose sleep at night. Increased load and latency is expected, but the app should still function appropriately. We will provide updates every 30 minutes with progress of the reboots.",
          "created_at": "2014-05-14T14:27:18.845-06:00",
          "display_at": "2014-05-14T14:27:18.845-06:00",
          "id": "z40y7398jqxc",
          "incident_id": "k7mf5z1gz05c",
          "status": "scheduled",
          "updated_at": "2014-05-14T14:27:18.845-06:00"
        }
      ],
      "monitoring_at": null,
      "name": "Web Tier Recycle",
      "page_id": "dc0t2lxm2p57",
      "resolved_at": null,
      "scheduled_for": "2014-05-14T14:30:00.000-06:00",
      "scheduled_until": "2014-05-14T16:30:00.000-06:00",
      "shortlink": "http://stspg.co:5000/Q0G",
      "status": "in_progress",
      "updated_at": "2014-05-14T14:35:12.258-06:00"
    }
  ]
}
          

Get the status rollup for the whole page. This endpoint includes an indicator - one of none, minor, major, or critical, as well as a human description of the blended component status. Examples of the blended status include "All Systems Operational", "Partial System Outage", and "Major Service Outage".

## using JS widget
<script type="text/javascript" src="https://cdn.statuspage.io/se-v2.js"></script>
<script>
  var sp = new StatusPage.page({ page : 'dc0t2lxm2p57' });
  sp.status({
    success : function(data) {
      console.log(data.status.indicator);
    }
  });
</script>

## using cURL
curl https://status.speakbenefits.com/api/v2/status.json
            

{
  "page":{
    "id":"dc0t2lxm2p57",
    "name":"Speak Benefits",
    "url":"https://status.speakbenefits.com",
    "updated_at": "2024-11-21T03:18:34Z"
  },
  "status": {
    "description": "Partial System Outage",
    "indicator": "major"
  }
}
          

Get the components for the page. Each component is listed along with its status - one of operational, degraded_performance, partial_outage, or major_outage.

## using JS widget
<script type="text/javascript" src="https://cdn.statuspage.io/se-v2.js"></script>
<script>
  var sp = new StatusPage.page({ page : 'dc0t2lxm2p57' });
  sp.components({
    success: function(data) {
      console.log(data.components[0].name);
    }
  })
</script>

## using cURL
curl https://status.speakbenefits.com/api/v2/components.json
            

{
  "page": {
    "id": "dc0t2lxm2p57",
    "name": "Speak Benefits",
    "url": "https://status.speakbenefits.com",
    "updated_at": "2024-11-21T03:18:34Z"
  },
  "components": [
    {
      "created_at": "2014-05-03T01:22:07.274Z",
      "description": null,
      "group": false,
      "group_id": null,
      "id": "b13yz5g2cw10",
      "name": "API",
      "only_show_if_degraded": false,
      "page_id": "dc0t2lxm2p57",
      "position": 1,
      "showcase": true,
      "start_date": null,
      "status": "partial_outage",
      "updated_at": "2014-05-14T20:34:43.340Z"
    },
    {
      "created_at": "2014-05-03T01:22:07.286Z",
      "description": null,
      "group": false,
      "group_id": null,
      "id": "9397cnvk62zn",
      "name": "Management Portal",
      "only_show_if_degraded": false,
      "page_id": "dc0t2lxm2p57",
      "position": 2,
      "showcase": true,
      "start_date": null,
      "status": "major_outage",
      "updated_at": "2014-05-14T20:34:44.470Z"
    }
  ]
}
          

Incidents are the cornerstone of any status page, being composed of many incident updates. Each incident usually goes through a progression of statuses listed below, with an impact calculated from a blend of component statuses (or an optional override).

Status: Investigating, Identified, Monitoring, Resolved, or Postmortem

Impact: None (black), Minor (yellow), Major (orange), or Critical (red)

Get a list of any unresolved incidents. This endpoint will only return incidents in the Investigating, Identified, or Monitoring state.

## using JS widget
<script type="text/javascript" src="https://cdn.statuspage.io/se-v2.js"></script>
<script>
  var sp = new StatusPage.page({ page : 'dc0t2lxm2p57' });
  sp.incidents({
    filter : 'unresolved',
    success: function(data) {
      console.log(data.incidents[0].status);
    }
  })
</script>

## using cURL
curl https://status.speakbenefits.com/api/v2/incidents/unresolved.json
      

{
  "page":{
    "id":"dc0t2lxm2p57",
    "name":"Speak Benefits",
    "url":"https://status.speakbenefits.com",
    "updated_at": "2024-11-21T03:18:34Z"
  },
  "incidents": [
    {
      "created_at": "2014-05-14T14:22:39.441-06:00",
      "id": "cp306tmzcl0y",
      "impact": "critical",
      "incident_updates": [
        {
          "body": "Our master database has ham sandwiches flying out of the rack, and we're working our hardest to stop the bleeding. The whole site is down while we restore functionality, and we'll provide another update within 30 minutes.",
          "created_at": "2014-05-14T14:22:40.301-06:00",
          "display_at": "2014-05-14T14:22:40.301-06:00",
          "id": "jdy3tw5mt5r5",
          "incident_id": "cp306tmzcl0y",
          "status": "identified",
          "updated_at": "2014-05-14T14:22:40.301-06:00"
        }
      ],
      "monitoring_at": null,
      "name": "Unplanned Database Outage",
      "page_id": "dc0t2lxm2p57",
      "resolved_at": null,
      "shortlink": "http://stspg.co:5000/Q0E",
      "status": "identified",
      "updated_at": "2014-05-14T14:35:21.711-06:00"
    }
  ]
}
          

Get a list of the 50 most recent incidents. This includes all unresolved incidents as described above, as well as those in the Resolved and Postmortem state.

## using JS widget
<script type="text/javascript" src="https://cdn.statuspage.io/se-v2.js"></script>
<script>
  var sp = new StatusPage.page({ page : 'dc0t2lxm2p57' });
  sp.incidents({
    success : function(data) {
      console.log(data.incidents[0].name);
    }
  });
</script>

## using cURL
curl https://status.speakbenefits.com/api/v2/incidents.json
            

{
  "page":{
    "id":"dc0t2lxm2p57",
    "name":"Speak Benefits",
    "url":"https://status.speakbenefits.com",
    "updated_at": "2024-11-21T03:18:34Z"
  },
  "incidents": [
    {
      "created_at": "2014-05-14T14:22:39.441-06:00",
      "id": "cp306tmzcl0y",
      "impact": "critical",
      "incident_updates": [
        {
          "body": "Our master database has ham sandwiches flying out of the rack, and we're working our hardest to stop the bleeding. The whole site is down while we restore functionality, and we'll provide another update within 30 minutes.",
          "created_at": "2014-05-14T14:22:40.301-06:00",
          "display_at": "2014-05-14T14:22:40.301-06:00",
          "id": "jdy3tw5mt5r5",
          "incident_id": "cp306tmzcl0y",
          "status": "identified",
          "updated_at": "2014-05-14T14:22:40.301-06:00"
        }
      ],
      "monitoring_at": null,
      "name": "Unplanned Database Outage",
      "page_id": "dc0t2lxm2p57",
      "resolved_at": null,
      "shortlink": "http://stspg.co:5000/Q0E",
      "status": "identified",
      "updated_at": "2014-05-14T14:35:21.711-06:00"
    },
    {
      "created_at": "2014-05-12T14:22:39.441-06:00",
      "id": "2z5g29qrrxvl",
      "impact": "minor",
      "incident_updates": [
        {
          "body": "A small display issue with the display of the website was discovered after a recent deploy. The deploy has been rolled back and the website is again functioning correctly.",
          "created_at": "2014-05-12T14:22:40.301-06:00",
          "display_at": "2014-05-12T14:22:40.301-06:00",
          "id": "vlzc06gtjnrl",
          "incident_id": "2z5g29qrrxvl",
          "status": "resolved",
          "updated_at": "2014-05-12T14:22:40.301-06:00"
        }
      ],
      "monitoring_at": null,
      "name": "Unplanned Database Outage",
      "page_id": "dc0t2lxm2p57",
      "resolved_at": "2014-05-12T14:22:40.301-06:00",
      "shortlink": "http://stspg.co:5000/Q0R",
      "status": "resolved",
      "updated_at": "2014-05-12T14:22:40.301-06:00"
    }
  ]
}
          

Scheduled maintenances are planned outages, upgrades, or general notices that you're working on infrastructure and disruptions may occurr. A close sibling of Incidents, each usually goes through a progression of statuses listed below, with an impact calculated from a blend of component statuses (or an optional override).

Status: Scheduled, In Progress, Verifying, or Completed

Impact: None (black), Minor (yellow), Major (orange), or Critical (red)

Get a list of any upcoming maintenances. This endpoint will only return scheduled maintenances still in the Scheduled state.

## using JS widget
<script type="text/javascript" src="https://cdn.statuspage.io/se-v2.js"></script>
<script>
  var sp = new StatusPage.page({ page : 'dc0t2lxm2p57' });
  sp.scheduled_maintenances({
    filter : 'upcoming',
    success : function(data) {
      console.log(data.scheduled_maintenances[0].scheduled_for);
    }
  });
</script>

## using cURL
curl https://status.speakbenefits.com/api/v2/scheduled-maintenances/upcoming.json
            

{
  "page":{
    "id":"dc0t2lxm2p57",
    "name":"Speak Benefits",
    "url":"https://status.speakbenefits.com",
    "updated_at": "2024-11-21T03:18:34Z"
  },
  "scheduled_maintenances": [
    {
      "created_at": "2014-05-14T14:24:40.430-06:00",
      "id": "w1zdr745wmfy",
      "impact": "none",
      "incident_updates": [
        {
          "body": "Our data center has informed us that they will be performing routine network maintenance. No interruption in service is expected. Any issues during this maintenance should be directed to our support center",
          "created_at": "2014-05-14T14:24:41.913-06:00",
          "display_at": "2014-05-14T14:24:41.913-06:00",
          "id": "qq0vx910b3qj",
          "incident_id": "w1zdr745wmfy",
          "status": "scheduled",
          "updated_at": "2014-05-14T14:24:41.913-06:00"
        }
      ],
      "monitoring_at": null,
      "name": "Network Maintenance (No Interruption Expected)",
      "page_id": "dc0t2lxm2p57",
      "resolved_at": null,
      "scheduled_for": "2014-05-17T22:00:00.000-06:00",
      "scheduled_until": "2014-05-17T23:30:00.000-06:00",
      "shortlink": "http://stspg.co:5000/Q0F",
      "status": "scheduled",
      "updated_at": "2014-05-14T14:24:41.918-06:00"
    }
  ]
}
          

Get a list of any active maintenances. This endpoint will only return scheduled maintenances in the In Progress or Verifying state.

## using JS widget
<script type="text/javascript" src="https://cdn.statuspage.io/se-v2.js"></script>
<script>
  var sp = new StatusPage.page({ page : 'dc0t2lxm2p57' });
  sp.scheduled_maintenances({
    filter : 'active',
    success : function(data) {
      console.log(data.scheduled_maintenances[0].status);
    }
  });
</script>

## using cURL
curl https://status.speakbenefits.com/api/v2/scheduled-maintenances/active.json
          

{
  "page":{
    "id":"dc0t2lxm2p57",
    "name":"Speak Benefits",
    "url":"https://status.speakbenefits.com",
    "updated_at": "2024-11-21T03:18:34Z"
  },
  "scheduled_maintenances": [
    {
      "created_at": "2014-05-14T14:27:17.303-06:00",
      "id": "k7mf5z1gz05c",
      "impact": "minor",
      "incident_updates": [
        {
          "body": "Scheduled maintenance is currently in progress. We will provide updates as necessary.",
          "created_at": "2014-05-14T14:34:20.036-06:00",
          "display_at": "2014-05-14T14:34:20.036-06:00",
          "id": "drs62w8df6fs",
          "incident_id": "k7mf5z1gz05c",
          "status": "in_progress",
          "updated_at": "2014-05-14T14:34:20.036-06:00"
        },
        {
          "body": "We will be performing rolling upgrades to our web tier with a new kernel version so that Heartbleed will stop making us lose sleep at night. Increased load and latency is expected, but the app should still function appropriately. We will provide updates every 30 minutes with progress of the reboots.",
          "created_at": "2014-05-14T14:27:18.845-06:00",
          "display_at": "2014-05-14T14:27:18.845-06:00",
          "id": "z40y7398jqxc",
          "incident_id": "k7mf5z1gz05c",
          "status": "scheduled",
          "updated_at": "2014-05-14T14:27:18.845-06:00"
        }
      ],
      "monitoring_at": null,
      "name": "Web Tier Recycle",
      "page_id": "dc0t2lxm2p57",
      "resolved_at": null,
      "scheduled_for": "2014-05-14T14:30:00.000-06:00",
      "scheduled_until": "2014-05-14T16:30:00.000-06:00",
      "shortlink": "http://stspg.co:5000/Q0G",
      "status": "in_progress",
      "updated_at": "2014-05-14T14:35:12.258-06:00"
    }
  ]
}
          

Get a list of the 50 most recent scheduled maintenances. This includes scheduled maintenances as described in the above two endpoints, as well as those in the Completed state.

## using JS widget
<script type="text/javascript" src="https://cdn.statuspage.io/se-v2.js"></script>
<script>
  var sp = new StatusPage.page({ page : 'dc0t2lxm2p57' });
  sp.scheduled_maintenances({
    success : function(data) {
      console.log(data.scheduled_maintenances[0].name);
    }
  });
</script>

## using cURL
curl https://status.speakbenefits.com/api/v2/scheduled-maintenances.json
            

{
  "page":{
    "id":"dc0t2lxm2p57",
    "name":"Speak Benefits",
    "url":"https://status.speakbenefits.com",
    "updated_at": "2024-11-21T03:18:34Z"
  },
  "scheduled_maintenances": [
    {
      "created_at": "2014-05-14T14:24:40.430-06:00",
      "id": "w1zdr745wmfy",
      "impact": "none",
      "incident_updates": [
        {
          "body": "Our data center has informed us that they will be performing routine network maintenance. No interruption in service is expected. Any issues during this maintenance should be directed to our support center",
          "created_at": "2014-05-14T14:24:41.913-06:00",
          "display_at": "2014-05-14T14:24:41.913-06:00",
          "id": "qq0vx910b3qj",
          "incident_id": "w1zdr745wmfy",
          "status": "scheduled",
          "updated_at": "2014-05-14T14:24:41.913-06:00"
        }
      ],
      "monitoring_at": null,
      "name": "Network Maintenance (No Interruption Expected)",
      "page_id": "dc0t2lxm2p57",
      "resolved_at": null,
      "scheduled_for": "2014-05-17T22:00:00.000-06:00",
      "scheduled_until": "2014-05-17T23:30:00.000-06:00",
      "shortlink": "http://stspg.co:5000/Q0F",
      "status": "scheduled",
      "updated_at": "2014-05-14T14:24:41.918-06:00"
    },
    {
      "created_at": "2014-05-14T14:27:17.303-06:00",
      "id": "k7mf5z1gz05c",
      "impact": "minor",
      "incident_updates": [
        {
          "body": "Scheduled maintenance is currently in progress. We will provide updates as necessary.",
          "created_at": "2014-05-14T14:34:20.036-06:00",
          "display_at": "2014-05-14T14:34:20.036-06:00",
          "id": "drs62w8df6fs",
          "incident_id": "k7mf5z1gz05c",
          "status": "in_progress",
          "updated_at": "2014-05-14T14:34:20.036-06:00"
        },
        {
          "body": "We will be performing rolling upgrades to our web tier with a new kernel version so that Heartbleed will stop making us lose sleep at night. Increased load and latency is expected, but the app should still function appropriately. We will provide updates every 30 minutes with progress of the reboots.",
          "created_at": "2014-05-14T14:27:18.845-06:00",
          "display_at": "2014-05-14T14:27:18.845-06:00",
          "id": "z40y7398jqxc",
          "incident_id": "k7mf5z1gz05c",
          "status": "scheduled",
          "updated_at": "2014-05-14T14:27:18.845-06:00"
        }
      ],
      "monitoring_at": null,
      "name": "Web Tier Recycle",
      "page_id": "dc0t2lxm2p57",
      "resolved_at": null,
      "scheduled_for": "2014-05-14T14:30:00.000-06:00",
      "scheduled_until": "2014-05-14T16:30:00.000-06:00",
      "shortlink": "http://stspg.co:5000/Q0G",
      "status": "in_progress",
      "updated_at": "2014-05-14T14:35:12.258-06:00"
    }
  ]
}