GET /API/PublicReporting/

Basic Intro

Returns your existing Public Reporting pages in your account.
NOTE: Authentication required

Parameters
Parameter Type Restrictions Description Required
id String - The ID of the public reporting page - Leave empty to retrieve all pages. No

Response Codes

Success

  • HTTP 200 - Success - Results can be found in the output

User Error

  • HTTP 400 - Request Failed - Generic Error: Please check output for more information.
  • HTTP 404 - Not Found - Nothing was found on this account.
  • HTTP 405 - Invalid Method - Invalid method used. Only supports GET.

Account Issues

  • HTTP 401 - Authorization Required - Provide Correct Username and API key
  • HTTP 429 - API Usage Limit Exceeded - Your limit was exceeded. Check your account for more information.

Example Output

Example Request to retrieve all Public Reporting Pages;
Curl Request

curl -H "API: [APIKey]" -H "Username: [Username]" -X GET https://app.statuscake.com/API/PublicReporting/

Output (JSON Format)
{
    "success": true,            // Returns false on error
    "message": "",              // Additional information, if available
    "data": [
        {
            "id": "Xyzzy1",                                     // Unique Page Identifier
            "title": "Example Page",                            // Title of the page
            "url": "https://uptime.statuscake.com/Xyzzy1",      // Permanent URL of the page
            "cname" "uptime.example.com",                       // Cname for the page
            "password_protected": false,                        // True if the page is protected with a password (Actual password not returned)
            "created": "2018-09-24 10:04:00+00:00"              // UTC timestamp of the creation of the page
        },
        { ... }
    ]
}
Example Request to retrieve a single Public Reporting Page;
Curl Request

curl -H "API: [APIKey]" -H "Username: [Username]" -X GET https://app.statuscake.com/API/PublicReporting/?id=Xyzzy1

Output (JSON Format)
{
    "success": true,            // Returns false on error
    "message": "",              // Additional information, if available
    "data": {
        "id": "Xyzzy1",                                     // Unique Page Identifier
        "title": "Example Page",                            // Title of the page
        "url": "https://uptime.statuscake.com/Xyzzy1",      // Permanent URL of the page
        "cname" "uptime.example.com",                       // Cname for the page
        "password_protected": false,                        // True if the page is protected with a password (Actual password not returned)
        "twitter": "",                                      // Twitter handle to display on page
        "display_annotations": false,                       // True if annotations are displayed
        "display_orbs": false,                              // True if orbs are used rather than percentage values
        "search_indexing": false,                           // True if search indexing is enabled
        "sort_alphabetical": false,                         // True if tests are sorted by alphabetical value
        "use_tags": false,                                  // True if tests are selected by tags, rather than by ID
        "tests_or_tags": [                                  // List of included tests or tags
            "123456"
        ],
        "tags_inclusive": false,                            // False if all tags must be on the tests, true if tests can have any of the provided tags
        "announcement": "",                                 // Announcement that is displayed on the page
        "bg_color": "#ff4500",                              // Background colour value
        "header_color": "#787878",                          // Header colour value
        "title_color": "#ffffff",                           // Header text colour value
        "created": "2018-05-23T10:12:45+00:00",             // UTC timestamp of the creation of the page
        "visits": 19                                        // Amount of times the page has been viewed
    }
}