Run Procedure
Results
Administration
User Guides

CSV API

The CSV API allows external programs to remotely download results in CSV format. It is designed to support the export of data programmatically.

Using HTTPS makes the data available via all major programming languages, web browsers, and command line utilities such as CURL.

Several columns of downloaded data are anonymized, including the institution and machine.

Column definitions for each data type can be found in the CSV Column Descriptions.

Parameters

Parameter names and values are case-insensitive.

If there are no values that satisfy the parameter specifications, then a zero length list will be returned.

If an invalid request is made, then a description of the error will be returned and the HTTP status will be 400. Valid requests will return a 200 status.

Parameters

Name Description Required Format Example Default
Type Type of data Yes Must be one of:
  • Center Dose
  • GapOffsetSkew
  • Collimator Centering
  • Collimator Position
  • Focal Spot
  • LeafPosition
  • Metadata Check
  • Symmetry And Flatness
  • VMAT T2-DR-GS
  • VMAT T2-DG-RS
  • VMAT T3MLCSpeed
  • Wedge Point
  • Winston Lutz
 		Winston Lutz NA
Machine Name of treatment machine Yes Must be one of the machine names listed for your institution. TB1 NA
Header Indicates whether or no a header line should be shown. No Must be one of true or false true false
Format Indicates either CSV or HTML format. HTML is useful for quickly testing queries interactively in the browser. No Must be one of CSV or HTML HTML CSV
One of:
  • TimeEQ : Time EQual to given time.
  • TimeGE : Time Greater than or Equal to given time.
  • TimeLE : Time Less than or Equal to given time.
  • TimeLT : Time Less than given time.
  • TimeGT : Time Greater than to given time.
 Specifies time range of data acquisition at the treatment machine. If specified, only one may be given. No One of:
    TimeXX=yyyyMMddTHHmmss.SSS

    Digits specifying year, month, day, literal T, hour, minute, second, millisecond.

    TimeXX=yyyyMMddTHHmmss

    Milliseconds defaults to zero.

    TimeXX=yyyyMMddTHHmm

    Seconds defaults to zero.

 TimeGE=20240515T145221.419

Data acquired treatment machine on or after May 15, 2024 14:52:21.419

 TimeGE=19700101T000000.000

Data acquired treatment machine on or after Jan 1, 1970
Count Number of rows to be retrieved No Integer greater than 0 5 1
Skip Number of rows to skip before retrieving the first row No Integer value 0 or greater 12 0

Examples

These may be copied and pasted into a browser.

Get the last record for Winston Lutz for machine TB5.
https://test.automatedqualityassurance.org/CsvApi?machine=TB5&type=Winston%20Lutz&TimeLE=21000101T000000

Get the second set of 4 Winston Lutz records for machine TB5:
https://test.automatedqualityassurance.org/CsvApi?machine=TB5&type=Winston%20Lutz&count=4&SKip=4

Get the last two records for Winston Lutz for machine TB5 with header line in HTML.
https://test.automatedqualityassurance.org/CsvApi?machine=TB5&type=Winston%20Lutz&TimeLE=21000101T000000&count=2&header=true&Format=HTML