Get smart workflow config

GET

/api/v1/workflows/{workflowId}/smart

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

Returns the smart-workflow configuration row for a workflow: ranking strategy (success / cost / reliability / quality), mode (auto re-ranks automatically vs suggest requires the user to apply each change), and the domain the rankings are scoped to. Org-scoped — calling on another tenant’s workflow returns 404 indistinguishably from “not a smart workflow.” A regular (non-smart) workflow also returns 404.

Authorizations

bearerAuth

Parameters

Path Parameters

workflowId

required

string

Responses

200

Smart workflow configuration.

application/json

object

strategy

string

Allowed values: success cost reliability

mode

string

Allowed values: auto suggest

domain

string

nullable

hasPendingSuggestion

boolean

Example

{
  "strategy": "success",
  "mode": "auto"
}

401

Missing or invalid authentication token

application/json

object

error

string

Example

{
  "error": "Missing or invalid authentication token"
}

403

Insufficient permissions for this operation

application/json

object

error

string

Example

{
  "error": "No organization. Complete onboarding first."
}

404

Resource not found

application/json

object

error

string

Example

{
  "error": "Workflow not found"
}

500

Unexpected server error. Logs and PostHog $exception capture

application/json

object

error

string

Example

{
  "error": "Something went wrong"
}