getLinkPreview
Preview how a URL will appear when shared on social media platforms. Get platform-specific title, description, and image for Facebook, Twitter, LinkedIn, and Google, plus a quality score and issues to fix.
Instructions
Check how a URL will appear when shared on Facebook, Twitter/X, LinkedIn, and Google. Returns platform-specific preview cards showing the title, description, and image each platform will render, plus a quality score (0–100) and a list of issues to fix.
Use this tool when the user asks:
'check the link preview for example.com'
'how does this page look when shared on social media?'
'check my og tags'
'what will this look like on Twitter / Facebook / LinkedIn?'
This is synchronous — results are returned immediately. Does not count against your monthly audit quota. Requires OAuth authentication.
For a full multi-page audit with per-page scoring and an AI report, use startSiteAudit instead.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | The full URL to preview (e.g. https://example.com/pricing). |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | ||
| score | Yes | Quality score 0–100 | |
| issues | No | Issues found — fix these to improve scores and previews | |
| platforms | Yes | What each platform will display when this URL is shared | |
| scoreLabel | Yes | Score tier: Well Optimized / Good / Room for Improvement / Needs Attention / Poor |