canonical: https://jentic.com/apis/metricspot.com/metricspot # MetricSpot REST API The MetricSpot REST API runs on-demand SEO audits for URLs you own and turns them into white-label PDF reports and HTML previews. An authenticated audit is queued and runs asynchronously, so you poll the audit detail until it completes, then queue a PDF in a chosen language with an optional brand_id for your own styling. You can also list your audits, read the audit history for a URL, check usage against your plan, and run a lightweight anonymous audit that returns its result immediately without Core Web Vitals. ## For AI agents Run SEO audits on a URL, poll for the result, and produce a white-label PDF or HTML report with MetricSpot. ## Scope Does not provide keyword rankings, backlink data, or paid search campaign management. Use for SEO audits of URLs you own and their PDF or HTML reports only. ## Capabilities - Queue a full SEO audit for a URL and poll the audit detail until the asynchronous job finishes - Run a lightweight anonymous audit that returns its result synchronously, without Core Web Vitals - Generate a white-label PDF report for a completed audit with a language and brand_id - Render a browser-friendly HTML preview of an audit report with lang and brand_id - Read the audit history for a single URL to compare results over time - Check current audit usage and plan before queuing more audits ## Use cases ### Agent-run SEO audits through Jentic An agent asked to check a site's SEO starts an audit through Jentic, polls the audit detail until the asynchronous job completes, and summarises the findings. Your MetricSpot token stays on your own Jentic One instance, and your rules decide whether the agent may also delete audits or only start and read them. Example prompt: POST `/api/audits` with url 'https://example.com', then poll GET `/api/audits/{id}` with the returned id until the audit is complete and summarise the top issues ### White-label PDF reports for agency clients Agencies can deliver branded SEO reports without building a PDF pipeline. For a completed audit, queue a PDF with a language such as es and the brand_id of a brand kit, poll the PDF status, and download it when ready. If the account has a single brand kit and brand_id is omitted, that kit is used automatically. Example prompt: POST `/api/audits/{id}/pdf` with language 'es' and brand_id 17, poll GET `/api/pdfs/{id}` until ready, then GET `/api/pdfs/{id}/download` ### Tracking a page's SEO over time Teams fixing SEO issues can compare audits of the same page. The history operation takes a url query parameter and returns the audits recorded for it, so a report can show whether a release improved the score. Example prompt: GET `/api/audits/history` with url 'https://example.com/pricing' and compare the most recent two audits ### Free quick checks for lead generation The anonymous audit operation needs no token and returns a lightweight result in the response body, which suits a public quick-check form. It does not persist a normal audit record, skips PageSpeed Insights, and is limited per IP. Example prompt: POST `/api/public/audit` with url 'https://example.com' and show the returned summary to the visitor ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/api/audits` | Start an authenticated audit | | GET | `/api/audits/{id}` | Get audit detail | | POST | `/api/audits/{id}/pdf` | Queue a PDF report | | GET | `/api/pdfs/{id}/download` | Download a ready PDF | | GET | `/api/audits/history` | Audit history for a URL | | GET | `/api/audits/usage` | Get audit usage and plan | | POST | `/api/public/audit` | Run an anonymous audit | ## Key resources - **Audits** — Start, list, read, reorder, and delete SEO audits and read history per URL - **Reports** — HTML previews of audit reports with language and branding - **PDFs** — Queue, poll, and download white-label PDF reports - **Usage** — Current audit usage and plan ## AI readiness This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use. - **Score:** 65 / 100 - **Maturity:** AI-Aware - **Dimensions:** - Foundational Compliance: 93 / 100 - Developer Experience & Jentic Compatibility: 67 / 100 - AI-Readiness & Agent Experience: 44 / 100 - Agent Usability: 94 / 100 - Security: 60 / 100 - AI Discoverability: 75 / 100 - **View full report:** https://jentic.com/apis/metricspot.com/metricspot/scorecard - **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/ - **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview ### Score it yourself Every API in the directory is allowlisted, so you can re-score it with no key required. - **Score your own API:** https://jentic.com/scorecard.md - **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md ```sh npx @jentic/api-scorecard-cli score ``` ## Why Jentic - **Setup:** Wiring MetricSpot by hand means attaching its ms_live_ bearer token, polling asynchronous audit and PDF jobs, and watching the monthly API quota. Through Jentic you install once, import MetricSpot from the API Directory, store the token once, and your agent calls it. - **Permission scoping:** MetricSpot puts the audit id in the URL path (`/api/audits/{id}/...`), so a rule can limit your agent to one audit and the operations you pick. You choose the operations it may call, so destructive ones like audit deletion, which also wipes history for that URL, are not included unless you add them. - **Credential handling:** Your MetricSpot token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent such as 'run an SEO audit on a URL' or 'download the audit PDF', and Jentic returns the matching MetricSpot operation with its input schema so the agent calls the right endpoint without browsing the reference docs. ## Related APIs - **Semrush API** — Keyword, backlink, and site audit data at scale - **Moz API** — Domain authority, links, and keyword metrics - **Ahrefs API** — Backlink and organic search data ## FAQ ### What authentication does the MetricSpot REST API use? Per its OpenAPI spec, the MetricSpot REST API uses a bearer token (BearerAuth) prefixed with ms_live_, issued from the dashboard under Account, API tokens. One endpoint, POST `/api/public/audit`, is anonymous and needs no auth. Through Jentic the token is stored encrypted by your own Jentic One instance and injected when the agent calls. ### What are the rate limits for the MetricSpot REST API? Per the spec, API access is capped at 5,000 API calls per calendar month across all of your tokens, resetting on the 1st of each month, and audits are also subject to per-plan monthly caps and per-URL cooldowns. The anonymous audit is limited to 1 request per IP per 24 hours. ### Is the MetricSpot REST API free? No. The spec states that API access requires the Pro plan at $49/month. The anonymous audit endpoint is open without a token, but returns a lighter result that skips Core Web Vitals. ### How do I get a PDF report for an audit through Jentic? Install Jentic One with `curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh`, import MetricSpot from the directory, and store your ms_live_ token. Your agent searches 'generate an SEO audit PDF report', calls POST `/api/audits/{id}/pdf`, polls GET `/api/pdfs/{id}`, and downloads from GET `/api/pdfs/{id}/download.` To run it on your own infrastructure, install Jentic One from its GitHub repo. ### Can I limit what my agent is allowed to do with the MetricSpot REST API? Yes. For example, allow POST `/api/audits`, GET `/api/audits/{id}`, and GET `/api/audits/usage`, so the agent can start audits, read their results, and check quota, but cannot delete audits or reorder your dashboard. Every call it makes is logged. ### Is there a MetricSpot MCP server? You don't need an MCP server to give your agent MetricSpot. Jentic connects it directly from the API Directory: import it, store your credential once, and your agent calls it. ### What happens when I delete a MetricSpot audit? Per the spec, DELETE `/api/audits/{id}` deletes the audit and all history for its URL, not just the single audit record. Keep this operation out of an agent's allowed set unless you want it to clear a page's audit history.