Lighthouse

POST
/workspaces
/:domain
/projects
/:project_name
/pipelines
/:pipeline_id
/actions

Hint

List with common parameters for all Buddy actions

Request

URL PARAMETERS

domainrequired string

The workspace domain.

pipeline_idrequired integer

The numerical ID of the desired pipeline.

project_namerequired string

The name ID of the project.

POST PARAMETERS

namerequired string

The name of the action.

typerequired string

The type of the action. Should be set to LIGHTHOUSE.

websiterequired string

The address of the site on which the audit should run.

devicerequired string

The device on which the audit will be run. Can be one of mobile, desktop, and mobileDesktop.

performancerequired integer

Values from 0 to 100 are accepted. The action returns an error if the score is below the values that are set.

accessibilityrequired integer

Values from 0 to 100 are accepted. The action returns an error if the score is below the values that are set.

best_practicesrequired integer

Values from 0 to 100 are accepted. The action returns an error if the score is below the values that are set.

seorequired integer

Values from 0 to 100 are accepted. The action returns an error if the score is below the values that are set.

Last modified on Sep 27, 2024

Kubernetes Set Image Link Checker

Example:

curl -X POST "https://api.buddy.works/workspaces/:domain/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Lighthouse",
  "type": "LIGHTHOUSE",
  "device": "mobile",
  "website": "https://buddy.works",
  "performance": 50,
  "accessibility": 50,
  "best_practices": 50,
  "seo": 50
}'

EXAMPLE RESPONSE
{
  "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2",
  "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2/action/2/edit",
  "id": 2,
  "name": "Lighthouse",
  "type": "LIGHTHOUSE",
  "trigger_time": "ON_EVERY_EXECUTION",
  "last_execution_status": "INITIAL",
  "device": "mobile",
  "website": "https://buddy.works",
  "performance": 50,
  "accessibility": 50,
  "best_practices": 50,
  "seo": 50,
  "pipeline": {
    "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2",
    "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
    "id": 2,
    "name": "test server",
    "on": "CLICK",
    "refs": [
      "refs/heads/master"
    ],
    "last_execution_status": "SUCCESSFUL",
    "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
  }
}

STATUS
201 Created

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999