Using the Public Reporting API

In this article we’ll take you through the functions of the Public Reporting API, if you are looking for more in depth programming-related info please instead check out our API Docs. We’ll go through each endpoint individually below:

Get All Pages

GET /API/PublicReporting/
Lists all public reporting pages on the account

Get Single Page

GET /API/PublicReporting/?id=PUBLIC_ID
Shows details of the page for that ID

Required Fields

  • id (String) – Provided as URL parameter

Create New Page

POST /API/PublicReporting/Update/
Creates a new page with the settings provided.

Required Fields

  • title (String) – Title of the Public Reporting page

Optional Fields

Any fields not provided will use the default value, or an empty string

  • cname (String) – Cname for the page, eg: uptime.statuscake.com, leave empty for no Cname
  • password (String) – Password protection for the page, leave empty for no password
  • twitter (String) – Twitter handle, without the @, leave empty for no Twitter
  • display_annotations (Bool) – Set to true to show annotations for statusperiods [Default: false]
  • display_orbs (Bool) – Set to true to display uptime as colored orbs [Default: true]
  • search_indexing (Bool) – Set to false to disable search engine indexing [Default: true]
  • sort_alphabetical (Bool) – Set to true to order tests by alphabetical name [Default: false]
  • use_tags (Bool) – Set to true to select tests by their tag, rather than ID [Default: false]
  • tests_or_tags (String) – Comma separated list of either Test IDs or Tags to display on the page
  • tags_inclusive (Bool) – Set to true to select all tests that include one or more of the provided tags [Default: false]
  • announcement (String) – Text to display at the top of the Public Reporting page
  • bg_color (String) – HEX value for the background colour [Default: #F5F5F5]
  • header_color (String) – HEX value for the header colour [Default: #F8F8F8]
  • title_color (String) – HEX value for the header text colour [Default: #FFFFFF]

Update Existing Page

POST /API/PublicReporting/Update/
Updates an existing page with the settings provided.

Required Fields

  • id (String) – ID of the page (Important, without it, a new page is created)

Optional Fields

Any fields not provided will not be updated

  • title (String) – Title for the page
  • cname (String) – Cname for the page, eg: uptime.statuscake.com, leave empty for no Cname
  • password (String) – Password protection for the page, leave empty for no password
  • twitter (String) – Twitter handle, without the @, leave empty for no Twitter
  • display_annotations (Bool) – Set to true to show annotations for statusperiods
  • display_orbs (Bool) – Set to true to display uptime as colored orbs
  • search_indexing (Bool) – Set to false to disable search engine indexing
  • sort_alphabetical (Bool) – Set to true to order tests by alphabetical name
  • use_tags (Bool) – Set to true to select tests by their tag, rather than ID
  • tests_or_tags (String) – Comma separated list of either Test IDs or Tags to display on the page
  • tags_inclusive (Bool) – Set to true to select all tests that include one or more of the provided tags
  • announcement (String) – Text to display at the top of the Public Reporting page
  • bg_color (String) – HEX value for the background colour
  • header_color (String) – HEX value for the header colour
  • title_color (String) – HEX value for the header text colour

Delete Existing Page

DELETE /API/PublicReporting/Update/?id=PUBLIC_ID
Deletes public reporting page with that ID
Note: id must be provided as a URL parameter. DELETE does not support body content.

Related Articles