Stats Index

Operation Summary:

This is an index of available stats reports

Resource URL:

https://api.compendiumblog.com/app/stats

HTTP method:

GET

HTTP Status Codes:

200 OK

Response Representations:

JSON (application/json)

Permitted Roles:

Any Authenticated User

Any User

Required Parameters:

n/a

Optional Parameters:

n/a

Response Values:

Success: The report was generated successfully.
Error: The requested resource could not be generated.

Response Structure:

JSON Responses are single-member objects which have a property name based on the type of result. The Success result will look like:

{"Success" : {
         "ReportName" : {
             "Title" : "Report Title",
             "Metric" : "Metric being reported on",
             "ReportOptions" : [options],
             "Doc" : "Report documentation",
             "Uri" : "Relative URI to access the report" } 
          ...
         }
}

The Error result will be a flat array of objects, which have keys for the message name and explanatory text.

{
     "Error" : [
       { "Name" : string, "Message" : string },
       { "Name" : string, "Message" : string },
       ...   
    ]
 }

Error Types:

n/a

Compendium Documentation

Help