/analysis/{site_id}/{report_id} - GET

Method description

Runs the report {report_id} using the tagging information from client {site_id}

URI Parameters

Parameter nameRequiredDescription
site_id(tick)site_id identifier on the system
report_id(tick)report to run. See available reports id's to know what param value use in depending on the data you want to retrieve

Check available reports to know about additional parameters for a specific report.

Responses

200 - successful information retrieve

Type: application/json

Example application/json
{
  "data": {
    ...
  },
  "params": {
    ...
  }
}    	

Since every report will use a different output that fits its needs, look at the specific output information at available reports.

401 - the user performing the action doesn't meet the security criteria

Type: application/json

Example application/json
{
    "code": 401,
    "error": "HTTP 401 Unauthorized"
}
403 - the token provided isn't valid anymore

Type: application/json

Example application/json
{
    "code": 403,
    "error": "HTTP 403 Forbidden"
}
404 - the instance or report doesn't exist

Type: application/json

Example application/json
{
    "code": 404,
    "error": "Not Found"
}