Address and format
Base address: https://dashboard.perfbee.com/api/v1. The file itself, always the current one: https://dashboard.perfbee.com/api/v1/openapi.json. Version 1.0.0.
There is no console on these pages: a key never belongs in a browser page. Use the examples in a terminal or in your own code. Paths are relative to the base address. Placeholders in braces, such as {crawl_id}, are values from earlier answers.
Every call needs a key (authentication). Lists use cursors (pagination). Problems share one shape (errors).
Account
Who a key acts as, its plan and credits.
| Endpoint | Scope | Rate class | What it does |
|---|---|---|---|
| GET/me | read | light | Show the key, its workspace, plan and credits |
Crawls
Sites and crawls: read them, their links, AI readiness and exports.
| Endpoint | Scope | Rate class | What it does |
|---|---|---|---|
| GET/crawls | read | light | List crawls |
| GET/crawls/{crawl_id} | read | light | Get one crawl |
| GET/crawls/{crawl_id}/ai-readiness | read | heavy | Get a crawl's AI readiness report |
| GET/crawls/{crawl_id}/exports/{slug}.{file_format} | read | heavy | Download a crawl's report as CSV or Excel |
| GET/crawls/{crawl_id}/links | read | heavy | List the URLs a crawl checked |
| GET/sites | read | light | List your sites |
| GET/sites/{site_id} | read | light | Get one site |
Issues
A crawl's issues, the diff against the previous crawl and issue totals.
| Endpoint | Scope | Rate class | What it does |
|---|---|---|---|
| GET/crawls/{crawl_id}/diff | read | heavy | Compare a crawl with the previous one |
| GET/crawls/{crawl_id}/issues | read | heavy | List a crawl's issues |
Pages
Site Pages, fixes, the issue catalog and live feeds.
| Endpoint | Scope | Rate class | What it does |
|---|---|---|---|
| GET/feeds | read | light | List the live links |
| POST/feeds | read | light | Make a live link |
| DELETE/feeds/{feed_id} | read | light | Revoke a live link |
| GET/issue-types | read | light | List the issue catalog |
| GET/sites/{site_id}/fixes | read | light | List a site's fixes |
| GET/sites/{site_id}/fixes/{fix_id} | read | light | Get one fix |
| GET/sites/{site_id}/fixes/{fix_id}/pages | read | heavy | List the pages of a fix |
| GET/sites/{site_id}/pages | read | heavy | List a site's pages |
| GET/sites/{site_id}/pages/{page_id} | read | light | Get one page of a site |
| GET/webhook-events | read | light | List the webhook events |
Crawl control
Start and cancel a crawl.
| Endpoint | Scope | Rate class | What it does |
|---|---|---|---|
| POST/crawls | crawl | start | Start a crawl |
| POST/crawls/{crawl_id}/cancel | crawl | light | Cancel a crawl |
Webhooks
Signed webhook endpoints and their deliveries.
| Endpoint | Scope | Rate class | What it does |
|---|---|---|---|
| GET/webhook-endpoints | webhooks | light | List webhook endpoints |
| POST/webhook-endpoints | webhooks | light | Create a webhook endpoint |
| GET/webhook-endpoints/{endpoint_id} | webhooks | light | Get a webhook endpoint |
| PATCH/webhook-endpoints/{endpoint_id} | webhooks | light | Change or pause a webhook endpoint |
| DELETE/webhook-endpoints/{endpoint_id} | webhooks | light | Delete a webhook endpoint |
| GET/webhook-endpoints/{endpoint_id}/deliveries | webhooks | light | List an endpoint's deliveries |
| POST/webhook-endpoints/{endpoint_id}/deliveries/{delivery_id}/redeliver | webhooks | heavy | Send a failed delivery again |
| POST/webhook-endpoints/{endpoint_id}/rotate-secret | webhooks | light | Rotate the signing secret |
| POST/webhook-endpoints/{endpoint_id}/test | webhooks | heavy | Send a test event |