List suggestions

GET

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

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

Lists every optimization_suggestions row for this workflow, of every status (pending / applied / dismissed), newest first. The dashboard shows pending ones as actionable cards and the rest as audit log. Org-scoped — empty array (not 404) for workflows with zero suggestions ever written.

Authorizations

bearerAuth

Parameters

Path Parameters

workflowId

required

string

Responses

200

All suggestions for this workflow (newest first).

application/json

Array<object>

object

string format: uuid

status

string

Allowed values: pending applied dismissed

currentProviderOrder

Array<string>

suggestedProviderOrder

Array<string>

reason

string

improvementPct

number

nullable

improvementMetric

string

estimatedCostBefore

number

nullable

estimatedCostAfter

number

nullable

createdAt

string format: date-time

resolvedAt

string format: date-time

nullable

expiresAt

string format: date-time

Example

[
  {
    "status": "pending"
  }
]

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."
}

500

Unexpected server error. Logs and PostHog $exception capture

application/json

object

error

string

Example

{
  "error": "Something went wrong"
}