Get workflow

GET

/api/v1/workflows/{id}

const url = 'https://dashboard.justcrawl.io/api/v1/workflows/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://dashboard.justcrawl.io/api/v1/workflows/example \
  --header 'Authorization: Bearer <token>'

Get a workflow (latest version) with its DAG by ID.

Authorizations

bearerAuth

Parameters

Path Parameters

required

string

The workflow ID.

Responses

200

The requested workflow.

application/json

object

workflowId

string format: uuid

name

string

status

string

Allowed values: draft published

version

integer

route

string

nullable

dag

object

nodes

required

Array<object>

object

required

string

type

required

string

Allowed values: entry service split result failed

config

object

edges

required

Array<object>

object

required

string

from

required

string

required

string

type

required

string

Allowed values: default success fail split

costPerThousand

number

nullable

smart

object

strategy

string

Allowed values: success cost reliability

mode

string

Allowed values: auto suggest

domain

string

nullable

hasPendingSuggestion

boolean

createdAt

string format: date-time

Example

{
  "status": "draft",
  "dag": {
    "nodes": [
      {
        "type": "entry"
      }
    ],
    "edges": [
      {
        "type": "default"
      }
    ]
  },
  "smart": {
    "strategy": "success",
    "mode": "auto"
  }
}

404

Workflow not found.