Frase Competitive Analysis API
Competitive page analysis and gap identification
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/frase-io:frase-io-competitive-analysis-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Frase Competitive Analysis API
version: 1.0.0
description: 'The Frase API provides programmatic access to your SEO content platform. Use it to manage content, research, audits, AI visibility tracking, and more. ## Authentication
All API requests require authentication using an API key. Include your key in the `X-API-KEY` header:
```
X-API-KEY: sk_live_your_api_key_here
```
For legacy compatibility, the `token` header is also supported. ## Rate Limits
Three independent limits apply, each with its own headers and error code. Headers are returned on `429` responses, not on successful ones. **Per-minute burst** - 60/min on trial and Starter, 120 Professional, 300 Scale, 1,000 Enterprise. Error code `rate_limit_exceeded`. - `X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset` (epoch seconds)
**Sustained hourly ceiling** - 2,000/hour trial, 3,000 Starter, 5,000 Professional, 15,000 Scale, 50,000 Enterprise. Error code `hourly_limit_exceeded`. - `X-RateLimit-Hourly-Limit`, `X-RateLimit-Hourly-Remaining`, `X-RateLimit-Hourly-Reset` (epoch seconds)
**Monthly request budget** - error code `monthly_budget_exceeded`, headers `X-Monthly-Limit`, `X-Monthly-Used`, `X-Monthly-Remaining`. Every `429` carries `Retry-After` in seconds. On the hourly ceiling this can be up to 3,600, so clients should honour it rather than retrying on a short fixed backoff - a retry sooner than `Retry-After` cannot succeed. ## Errors
The API uses standard HTTP status codes and returns errors in a consistent format:
```json
{
"error": {
"type": "authentication_error",
"code": "invalid_api_key",
"message": "Invalid API key provided.",
"doc_url": "https://docs.frase.io/api/errors#invalid_api_key"
}
}
```
## Changelog
Breaking changes are listed here, newest first. "Breaking" means a field that was always present with a value can now be `null`, or an existing value now means something different — not that a field was removed or renamed. Additive fields are not listed. ### 2026-08-31 — Fact `sources[]` may omit `url`, and minted facts default to `approved`
- `GET /briefs/{id}/facts`, `PATCH /briefs/{id}/facts/{factId}` → a `sources[]` entry may now carry only `title`, with no `url` or `domain`. Research names a publisher far more often than it captures a link (793 of 801 plan-evidence items in production), and those names were previously discarded rather than returned. Read `url` defensively. - `GET /briefs/{id}/facts` → `approval` on a newly minted fact is now `approved` rather than `pending`. A client polling for `pending` facts to review will see far fewer; rejection is unchanged and remains permanent. Facts the writer asserted in its own output (`provenance: generated`) are still minted `pending`. ### 2026-08-24 — Content Guard''s hasPublishedUrl is now recoverability, not the stored URL
- `GET /content/{id}/monitoring` → `hasPublishedUrl`: was a judgment on the STORED URL (false for a relative path even when the page was live). It now answers "could Guard watch this article right now" — the stored URL when absolute, or an address the server recovers (CMS inventory; FraseCMS re-derivation from current settings when a live published post exists). `true` no longer implies the stored URL itself is absolute, and a FraseCMS article published before domain setup flips to `true` when setup finishes, with no re-publish. It remains exactly the condition enabling enforces. - `publishedUrlIssue` is now the RESIDUAL after recovery failed, not a raw-column classification — "not_absolute" can also mean the FraseCMS post is not live or FraseCMS is disabled for the site. - `POST /content/{id}/publish` → `url` (frase_cms): now derived from the site''s current CMS settings rather than the adapter''s host-of-the-moment value; the same URL is stored on the content row and sent in the content.published webhook.'
contact:
name: Frase Support
url: https://frase.io
email: support@frase.io
license:
name: Proprietary
url: https://www.frase.io/company/terms
servers:
- url: https://next.frase.io/api/v1
description: Production
- url: /api/v1
description: This host
security:
- ApiKeyAuth: []
- BearerAuth: []
tags:
- name: Competitive Analysis
description: Competitive page analysis and gap identification
paths:
/competitive-analysis:
get:
operationId: listCompetitiveAnalyses
summary: List competitive analyses
description: List all competitive page analyses for your organization.
tags:
- Competitive Analysis
parameters:
- name: page
in: query
schema:
type: integer
default: 1
- name: page_size
in: query
schema:
type: integer
default: 20
maximum: 100
- name: status
in: query
schema:
type: string
enum:
- pending
- crawling_page
- fetching_rankings
- analyzing_competitors
- generating_report
- ready
- failed
- name: site_id
in: query
schema:
type: string
format: uuid
description: Filter by site ID
responses:
'200':
description: List of competitive analyses
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
format: uuid
url:
type: string
status:
type: string
opportunity_score:
type: integer
nullable: true
error:
type: string
nullable: true
created_at:
type: string
format: date-time
completed_at:
type: string
format: date-time
nullable: true
pagination:
$ref: '#/components/schemas/Pagination'
request_id:
type: string
'401':
$ref: '#/components/responses/Unauthorized'
post:
operationId: startCompetitiveAnalysis
summary: Start competitive analysis
description: Start a new competitive page analysis. Crawls the target page, fetches ranking queries, discovers competitors, and generates a gap analysis.
tags:
- Competitive Analysis
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- url
properties:
url:
type: string
format: uri
description: Target page URL to analyze
competitor_urls:
type: array
items:
type: string
format: uri
description: Optional manual competitor URLs. If omitted, competitors are discovered via SERP analysis.
site_id:
type: string
format: uuid
description: Optional site ID to associate the analysis with
location_name:
type: string
description: Location for SERP queries (e.g., 'United States')
industry:
type: string
description: Industry context for the analysis
responses:
'201':
description: Competitive analysis started
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: string
format: uuid
url:
type: string
status:
type: string
enum:
- pending
message:
type: string
created_at:
type: string
format: date-time
request_id:
type: string
'422':
$ref: '#/components/responses/ValidationError'
'429':
description: Audit page limit exceeded
/competitive-analysis/{id}:
get:
operationId: getCompetitiveAnalysis
summary: Get competitive analysis
description: Get detailed results of a competitive analysis including page crawl data, ranking queries, competitor analysis, and gap analysis.
tags:
- Competitive Analysis
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Competitive analysis details
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: string
format: uuid
url:
type: string
status:
type: string
enum:
- pending
- crawling_page
- fetching_rankings
- analyzing_competitors
- generating_report
- ready
- failed
manual_competitor_urls:
type: array
items:
type: string
nullable: true
page_crawl:
type: object
nullable: true
ranking_queries:
type: object
nullable: true
serp_competitors:
type: object
nullable: true
competitor_analysis:
type: object
nullable: true
gap_analysis:
type: object
nullable: true
opportunity_score:
type: integer
minimum: 0
maximum: 100
nullable: true
generated_brief_id:
type: string
format: uuid
nullable: true
error:
type: string
nullable: true
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
completed_at:
type: string
format: date-time
nullable: true
request_id:
type: string
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/ValidationError'
delete:
operationId: deleteCompetitiveAnalysis
summary: Delete competitive analysis
description: Permanently delete a competitive analysis and its results.
tags:
- Competitive Analysis
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Analysis deleted
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: string
format: uuid
deleted:
type: boolean
request_id:
type: string
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/ValidationError'
/competitive-analysis/{id}/generate-brief:
post:
operationId: generateBriefFromCompetitiveAnalysis
summary: Generate brief from analysis
description: Generate an optimization brief from a completed competitive analysis. The analysis must have status 'ready'. This endpoint is idempotent — if a brief was already generated, it returns the existing brief ID.
tags:
- Competitive Analysis
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Brief already exists (idempotent)
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: string
format: uuid
message:
type: string
request_id:
type: string
'201':
description: Brief generated
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
brief_id:
type: string
format: uuid
analysis_id:
type: string
format: uuid
topic:
type: string
message:
type: string
request_id:
type: string
'400':
description: Analysis is not in 'ready' status
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/ValidationError'
/competitive-analysis/locations:
get:
operationId: searchLocations
summary: Search locations
description: Search for geographic locations to use when starting a competitive analysis. Returns location codes, names, and types.
tags:
- Competitive Analysis
parameters:
- name: q
in: query
required: true
schema:
type: string
minLength: 2
description: Search query (minimum 2 characters)
responses:
'200':
description: Location search results
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
locations:
type: array
items:
type: object
properties:
location_code:
type: integer
location_name:
type: string
location_type:
type: string
request_id:
type: string
'422':
$ref: '#/components/responses/ValidationError'
components:
responses:
NotFound:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
type: invalid_request_error
code: resource_not_found
message: The requested resource was not found.
doc_url: https://docs.frase.io/api/errors#resource_not_found
request_id: req_abc123
Unauthorized:
description: Authentication failed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
type: authentication_error
code: invalid_api_key
message: Invalid API key. Check that you are using the correct key.
doc_url: https://docs.frase.io/api/errors#invalid_api_key
request_id: req_abc123
ValidationError:
description: Validation failed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error:
type: invalid_request_error
code: validation_error
message: The request body is invalid.
param: prompt_text
doc_url: https://docs.frase.io/api/errors#validation_error
request_id: req_abc123
schemas:
Error:
type: object
properties:
error:
type: object
properties:
type:
type: string
code:
type: string
message:
type: string
param:
type: string
doc_url:
type: string
request_id:
type: string
Pagination:
type: object
properties:
page:
type: integer
page_size:
type: integer
total:
type: integer
has_more:
type: boolean
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-KEY
description: 'API key for authentication. Get your key from Settings > API Keys. You may also send the same key as `Authorization: Bearer <key>` — see BearerAuth.'
BearerAuth:
type: http
scheme: bearer
bearerFormat: Frase API key (sk_live_* / sk_test_*) or MCP access token (mcp_at_*)
description: 'Send either your API key or an MCP access token as `Authorization: Bearer <token>`. An API key sent this way is exactly equivalent to sending it in X-API-KEY — same identity, same scopes, same rate limits — so use whichever your HTTP client makes natural. X-API-KEY takes precedence if you somehow send both. Cookie/session auth is intentionally NOT supported on /api/v1/* endpoints.'