Sanggunian ng API
visibility
35 mga endpoint sa lugar na ito. Ang bawat isa ay may sariling pahina kasama ang mga parameter nito, ang tugon nito, at isang kahilingan na maaari ninyong patakbuhin.
| Paraan | Path | Ang ginagawa nito | Pahintulot |
|---|---|---|---|
| GET | /v1/domain-vetting | Domain vetting — credits held, the packs, the markets and recent reports. | sites.view |
| GET | /v1/domain-vetting/reports | Your domain vetting reports, filtered and sorted. | sites.view |
| POST | /v1/domain-vetting/reports | Vet a domain — spends one report credit. | sites.create |
| POST | /v1/domain-vetting/reports/bulk | Vet up to 25 domains as one run — spends one credit per new report. | sites.create |
| GET | /v1/domain-vetting/reports/export | The filtered report list as a CSV file. | sites.view |
| DELETE | /v1/domain-vetting/reports/{report_id} | Remove a finished report from your list. | sites.create |
| GET | /v1/domain-vetting/reports/{report_id} | One domain vetting report — verdict, reasons and evidence. | sites.view |
| GET | /v1/domain-vetting/reports/{report_id}/pdf | The report as a PDF, in the reader's language. | sites.view |
| GET | /v1/visibility/audits/{auditId} | One audit, with every finding. | sites.view |
| GET | /v1/visibility/domain-options | The organisation's own domains, to pick one to watch. | sites.view |
| GET | /v1/visibility/local | Local rankings — the allowances and every business followed. | sites.view |
| POST | /v1/visibility/local/businesses | Follow a business on the map, by its website's domain. | sites.create |
| GET | /v1/visibility/local/places | Towns a local search can be made from. | sites.view |
| GET | /v1/visibility/plan | What visibility add-ons this organisation holds. | sites.view |
| GET | /v1/visibility/targets | List the domains this organisation is watching. | sites.view |
| POST | /v1/visibility/targets | Watch a new domain. | sites.create |
| DELETE | /v1/visibility/targets/{targetId} | Stop watching a domain. | sites.create |
| PATCH | /v1/visibility/targets/{targetId} | Change a watched domain's settings. | sites.create |
| GET | /v1/visibility/targets/{targetId}/audits | A watched domain's audit history. | sites.view |
| GET | /v1/visibility/targets/{targetId}/backlink-links | The individual inbound links for a watched domain. | sites.view |
| GET | /v1/visibility/targets/{targetId}/brand-serp | Brand page 1 — what Google's first page shows for this brand, with each result's tone. | sites.view |
| PUT | /v1/visibility/targets/{targetId}/brand-serp | Set the brand searches whose first Google page is watched (the brand and up to four variants). | sites.create |
| PUT | /v1/visibility/targets/{targetId}/keywords | Set the search phrases to track positions for. | sites.create |
| PUT | /v1/visibility/targets/{targetId}/links | Set the individual links to watch pointing at this domain. | sites.create |
| DELETE | /v1/visibility/targets/{targetId}/local | Stop following the business, and delete its history. | sites.create |
| GET | /v1/visibility/targets/{targetId}/local | One business's local set-up, every row's positions and their trend. | sites.view |
| PUT | /v1/visibility/targets/{targetId}/local | Save the business, the towns and the keywords. | sites.create |
| POST | /v1/visibility/targets/{targetId}/local/find | Search the map for the business, so the customer can pick theirs. | sites.create |
| PUT | /v1/visibility/targets/{targetId}/mention-phrases | Set the phrases to listen for across the web, and how often. | sites.create |
| GET | /v1/visibility/targets/{targetId}/mentions | The web pages that mention this domain's phrases, newest found first. | sites.view |
| PUT | /v1/visibility/targets/{targetId}/products | Set the products to price-track, and the seller names to look for. | sites.create |
| PUT | /v1/visibility/targets/{targetId}/prompts | Set the customer's own questions for the AI answer engines. | sites.create |
| POST | /v1/visibility/targets/{targetId}/review-profile-lookup | Search the review sites for this business. | sites.create |
| PUT | /v1/visibility/targets/{targetId}/review-profiles | Confirm which review profiles belong to this business. | sites.create |
| POST | /v1/visibility/targets/{targetId}/run | Run an audit now. | sites.create |