Run progress and per-file problems

GET

/v1/workspaces/{workspaceId}/file-imports/runs/{runId}

const url = 'https://shareout.site/v1/workspaces/example/file-imports/runs/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://shareout.site/v1/workspaces/example/file-imports/runs/example \
  --header 'Authorization: Bearer <token>'

Authorizations

bearerAuth

Parameters

Path Parameters

workspaceId

required

string

Workspace ID or slug.

runId

required

string

Responses

200

Run

application/json

object

run

object

string

sourceId

string

status

string

Allowed values: queued walking importing done stopped failed

trigger

string

Allowed values: manual resync schedule

counts

object

found

integer

imported

integer

converted

integer

skipped

integer

unchanged

integer

failed

integer

stopCode

STORAGE_QUOTA_EXCEEDED, CONNECTION_REVOKED, RATE_LIMITED, WALK_LIMIT (warning on a done run), NOT_ALLOWED, SOURCE_DELETED, STALLED, FAILED.

string

nullable

stopMessage

string

nullable

createdAt

string format: date-time

finishedAt

string format: date-time

nullable

errors

Files that failed, were skipped, or imported with a warning (up to 200).

Array<object>

object

path

string

status

string

code

string

message

string

Example

{
  "run": {
    "status": "queued",
    "trigger": "manual"
  }
}

404

Resource not found

application/json

object

success

required

boolean

error

required

Human-readable message.

string

code

required

Machine-readable error code.

string

request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string

reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string

hint

What to do next, in plain words.

string

suggestion

string

param

The request field at fault.

string

docs

Doc page for this error.

string

redirect_url

string

support

Present on 5xx — how to reach a human.

object

how

string

include

Array<string>

Example

{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}