List Run Results

GET 
/api/v1/runs/:runID/results

Get a collection of the results of a deploy or refresh run

Request

Path Parameters

runID integerrequired

The run ID.

Responses

200

A collection of results for a deploy or refresh run.

application/json

Schema

Schema

data

object[]

required

A collection of run results.

Array [

isRunning booleanrequired

If the queried run is still running.

name stringrequired

nodeID stringrequired

runState string

origin RunOrigins

Possible values: [API, CLI, UI, fivetranAPI]

queryResults

object[]

required

The query result returns the status of different stages such as Delete Table or Rename Table. See the queryResults name for the stage.

Array [

endTime date-time

error

object

errorString stringrequired

The error message.

errorDetail string

Additional detail about the error.

isRunning booleanrequired

If the queried run is still running.

name stringrequired

The name of the Stage the query ran on.

queryID string

rowsDeleted integer

rowsInserted integer

rowsUpdated integer

sql stringrequired

The SQL query run during the stage.

startTime date-time

status stringrequired

The query status.

success booleanrequired

If the query results were run successfully.

warehouse string

Name of the warehouse.

]

renderQueryResult

object

endTime date-time

error

object

errorString stringrequired

The error message.

errorDetail string

Additional detail about the error.

isRunning booleanrequired

If the queried run is still running.

name stringrequired

The name of the Stage the query ran on.

queryID string

rowsDeleted integer

rowsInserted integer

rowsUpdated integer

sql stringrequired

The SQL query run during the stage.

startTime date-time

status stringrequired

The query status.

success booleanrequired

If the query results were run successfully.

warehouse string

Name of the warehouse.

]

Run Results Response

{
  "data": [
    {
      "isRunning": true,
      "name": "string",
      "nodeID": "string",
      "runState": "string",
      "origin": "API",
      "queryResults": [
        {
          "endTime": "2019-08-24T14:15:22Z",
          "error": {
            "errorString": "string",
            "errorDetail": "string"
          },
          "isRunning": true,
          "name": "string",
          "queryID": "string",
          "rowsDeleted": 0,
          "rowsInserted": 0,
          "rowsUpdated": 0,
          "sql": "string",
          "startTime": "2019-08-24T14:15:22Z",
          "status": "string",
          "success": true,
          "warehouse": "string"
        }
      ],
      "renderQueryResult": {
        "endTime": "2019-08-24T14:15:22Z",
        "error": {
          "errorString": "string",
          "errorDetail": "string"
        },
        "isRunning": true,
        "name": "string",
        "queryID": "string",
        "rowsDeleted": 0,
        "rowsInserted": 0,
        "rowsUpdated": 0,
        "sql": "string",
        "startTime": "2019-08-24T14:15:22Z",
        "status": "string",
        "success": true,
        "warehouse": "string"
      }
    }
  ]
}

400

The request was invalid.

application/json

Schema

Schema

error

object

required

errorString stringrequired

The error message.

errorDetail string

Additional detail about the error.

Invalid Request Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

401

User lacks authorization to perform this action.

application/json

Schema

Schema

error

object

required

errorString stringrequired

The error message.

errorDetail string

Additional detail about the error.

Unauthorized

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

403

The client is not permitted to perform the requested operation.

application/json

Schema

Schema

error

object

required

errorString stringrequired

The error message.

errorDetail string

Additional detail about the error.

Forbidden Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

404

The requested resource could not be found.

application/json

Schema

Schema

error

object

required

errorString stringrequired

The error message.

errorDetail string

Additional detail about the error.

Not Found Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

500

The server encountered an unexpected condition that prevented it from fulfilling the request.

application/json

Schema

Schema

error

object

required

errorString stringrequired

The error message.

errorDetail string

Additional detail about the error.

Internal Server Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

502

The server received an error from an upstream system.

application/json

Schema

Schema

error

object

required

errorString stringrequired

The error message.

errorDetail string

Additional detail about the error.

Bad Gateway Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

503

The service is currently unavailable.

application/json

Schema

Schema

error

object

required

errorString stringrequired

The error message.

errorDetail string

Additional detail about the error.

Service Unavailable Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

504

The server did not receive a response in time from an upstream system.

application/json

Schema

Schema

error

object

required

errorString stringrequired

The error message.

errorDetail string

Additional detail about the error.

Gateway Timeout Error

{
  "error": {
    "errorString": "string",
    "errorDetail": "string"
  }
}

Loading...