Lighthouse
POST Parameters
Name | Type | Description |
---|---|---|
name Required | String | The name of the action. |
type Required | String | The type of the action. Should be set to LIGHTHOUSE . |
website Required | String | The address of the site on which the audit should run. |
device Required | String | The device on which the audit will be run. Can be one of mobile , desktop and mobileDesktop . |
performance Required | Integer | Values from 0 to 100 are accepted. The action returns an error if the score is below the values that are set. |
accessibility Required | Integer | Values from 0 to 100 are accepted. The action returns an error if the score is below the values that are set. |
best_practices Required | Integer | Values from 0 to 100 are accepted. The action returns an error if the score is below the values that are set. |
seo Required | Integer | Values from 0 to 100 are accepted. The action returns an error if the score is below the values that are set. |
Example
Request
POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions
JSON
{"name":"Lighthouse","type":"LIGHTHOUSE","device":"mobile","website":"https://buddy.works","performance":50,"accessibility":50,"best_practices":50,"seo":50}
Sample Response
HTTP
Status: 201 CreatedX-Rate-Limit-Limit: 1X-Rate-Limit-Remaining: 999
JSON
{"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"}}