Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Method description

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

URI Parameters

Parameter nameRequiredDescription
instancesite_id(tick)client 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

Code Block
titleExample application/json
collapsetrue
{
  "entitydata": {
    ...
  },
  "statusparams": "ok" {
    ...
  }
}    	

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

Code Block
titleExample application/json
collapsetrue
{
  "code": 401,
  "details": "The server could not verify that you are authorized to access the URL requested.  You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
  "message": "Unauthorized",
  "status": "error"
}
404 - the instance or report doesn't exist

Type: application/json

Code Block
titleExample application/json
collapsetrue
{
  "code": 404,
  "details": null,
  "message": "instancesite_id: instance not found",
  "status": "error"
}

...