Check the status of the running DV query - and retrieve the resulting data
| Parameter | Mandatory | Description | Examples | More Info |
|---|---|---|---|---|
| API | Yes | The API area | dataviewer.json | |
| Action | Yes | The action to perform | action=checkstatus | |
| Task ID | Yes | Task ID for the running DV call | taskid=12556 | |
| General | Yes | Parameters described in overview | user=user&password=user&version=3.9 | Overview |
Note: To get the task ID first run the Start endpoint.
Example request:
http://<SERVER>/jsonapi/dataviewer.json?user=user&password=user&version=3.9&action=checkstatus&taskid=12668
Here is the formatted output as displayed in Synergist.
Example response:
{
"taskID": 12549,
"status": "DONE0",
"result": {
"DataTable": {
"Columns": [
{
"Heading": "Charge code",
"Section": "Keys",
"Type": "Text"
},
{
"Heading": "Data type",
"Section": "Keys",
"Type": "Text"
},
{
"Heading": "03/10/2021 - 31/10/2021",
"Section": "Values",
"Type": "Numeric"
},
{
"Heading": "Nov 21",
"Section": "Values",
"Type": "Numeric"
},
{
"Heading": "Dec 21",
"Section": "Values",
"Type": "Numeric"
},
{
"Heading": "Jan 22",
"Section": "Values",
"Type": "Numeric"
},
{
"Heading": "Feb 22",
"Section": "Values",
"Type": "Numeric"
},
{
"Heading": "Mar 22",
"Section": "Values",
"Type": "Numeric"
},
{
"Heading": "Total",
"Section": "Totals",
"Type": "Numeric"
}
],
"Rows": [
{
"RowType": "Body",
"RowData": [
"Account handlers",
"Time Estimate",
"0.37",
"0.40",
"0.38",
"0.37",
"0.37",
"21.42",
"23.30"
]
},
{
"RowType": "Body",
"RowData": [
"Alter",
"Time Estimate",
"0.03",
"0.03",
"0.03",
"0.03",
"0.03",
"0.03",
"0.16"
]
},
{
"RowType": "Body",
"RowData": [
"Amaze🤷♀️",
"Time Estimate",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"2.00",
"2.00"
]
},
{
"RowType": "Body",
"RowData": [
"Junior Design",
"Time Estimate",
"0.03",
"0.03",
"0.03",
"0.03",
"0.03",
"10.03",
"10.16"
]
},
{
"RowType": "Body",
"RowData": [
"Artwork & Director",
"Time Estimate",
"0.03",
"33.03",
"0.03",
"0.03",
"0.03",
"18.03",
"51.16"
]
},
{
"RowType": "Body",
"RowData": [
"Business Research Time",
"Time Estimate",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"1.00",
"1.00"
]
},
{
"RowType": "Body",
"RowData": [
"charge",
"Time Estimate",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"1.00",
"1.00"
]
},
{
"RowType": "Body",
"RowData": [
"COL NEW",
"Time Estimate",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"1.00",
"1.00"
]
},
{
"RowType": "Body",
"RowData": [
"Consultancy",
"Time Estimate",
"0.10",
"0.08",
"0.06",
"0.05",
"0.05",
"5.06",
"5.40"
]
},
{
"RowType": "Body",
"RowData": [
"Copy Writing",
"Time Estimate",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"20.00",
"20.00"
]
},
{
"RowType": "Body",
"RowData": [
"Senior Mac Work",
"Time Estimate",
"0.03",
"0.03",
"0.03",
"0.03",
"0.03",
"0.03",
"0.16"
]
},
{
"RowType": "Body",
"RowData": [
"farting around",
"Time Estimate",
"0.05",
"0.06",
"0.06",
"0.05",
"0.05",
"0.06",
"0.33"
]
},
{
"RowType": "Body",
"RowData": [
"Creative Design",
"Time Estimate",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"2.00",
"2.00"
]
},
{
"RowType": "Body",
"RowData": [
"a charge code with a very long",
"Time Estimate",
"0.00",
"0.00",
"0.00",
"0.00",
"0.00",
"1.00",
"1.00"
]
},
{
"RowType": "Body",
"RowData": [
"HTML mockups",
"Time Estimate",
"0.38",
"0.42",
"0.40",
"0.38",
"0.38",
"0.44",
"2.38"
]
},
{
"RowType": "Body",
"RowData": [
"Employee Training",
"Time Estimate",
"0.03",
"0.03",
"0.03",
"0.03",
"0.03",
"0.03",
"0.16"
]
},
{
"RowType": "Totals",
"RowData": [
"TOTALS",
"",
"1.05",
"34.11",
"1.05",
"1.00",
"1.00",
"83.13",
"121.34"
]
}
]
},
"ResultText": ""
},
"responsecode": 1,
"responsestatus": "OK",
"errorcode": 0,
"errormessage": "",
"responsemessage": "",
"warningmessage": "",
"success": true,
"synversion": "12.90029",
"synapiversion": 3.9
}