REST · JSON · OpenAPI 3.1v1

Searviaのデータでアプリを構築

順位、AI可視性、サイトの健全性、レビュー、ストア掲載情報、市場推定を、自作のスクリプト、ダッシュボード、アプリから取得できます。APIはSearvia MCPサーバーと同じツールを実行するため、プランの上限、クレジット、アカウントの範囲も同じです。

あなたのプロジェクト

curl https://searvia.com/api/v1/projects \
  -H "Authorization: Bearer $SEARVIA_API_KEY"

OpenAPIファイル APIキーを作成

認証

設定 › API と MCP でキーを作成し、Bearerトークンとして送信します。キーは1つのアカウントに紐づき、そのアカウントのデータのみ参照できます。同じキーはMCPサーバーでも使えます。OAuthで接続したアプリもAPIを利用でき、読み取り専用の接続では何も変更できません。

上限とクレジット

キーごと、1分あたり
読み取り60回、変更30回、クレジット消費または削除を伴う呼び出し10回。
月額
APIとMCPの呼び出しは月間の上限を共有します。Freeは100回、Indieは1,000回、Starter以上は無制限です。
クレジット
「クレジットを消費」と記載された呼び出しは、プレビューなしでアカウント残高からすぐに差し引かれます。クレジットが足りない場合は402を返し、何も実行されません。

すべてのレスポンスにX-RateLimit-Limit、X-RateLimit-Remaining、X-RateLimit-Resetが含まれます。上限に達するとRetry-After付きの429が返されます。

レスポンス、エラー、ページ

結果

{
  "data": [ ... ],
  "meta": { "page": 1, "per_page": 50, "total": 120, "last_page": 3 }
}

エラー

{
  "error": {
    "status": 422,
    "code": "validation_failed",
    "message": "Missing required field: keywords.",
    "errors": { "keywords": ["The keywords field is required."] }
  }
}

一覧系のエンドポイントは page と per_page(最大200)を受け取り、次ページと前ページを示す Link ヘッダーを返します。エラーコード: unauthenticated、payment_required、forbidden、not_found、validation_failed、rate_limited、unavailable、server_error。

エンドポイント

Account

GET	/account/usage	Plan, credits, quotas and this month's API and MCP calls.	読み取り
GET	/audit-logs	Audit log of the account (owners and admins).	読み取り

Projects

GET	/projects	Projects (websites and apps) of the account.	読み取り
GET	/projects/{project_id}	Overview of one project: rankings, visibility, reviews and open growth actions.	読み取り
GET	/projects/{project_id}/competitors	Tracked competitors of a project.	読み取り

Rankings

GET	/projects/{project_id}/keywords	Tracked keywords with current rank, 1 and 7 day change, popularity, difficulty and daily history.	読み取り
POST	/projects/{project_id}/keywords	Track keywords (within the plan quota; the first check runs right away).	変更
DELETE	/projects/{project_id}/keywords	Stop tracking keywords (by text or id).	削除
POST	/projects/{project_id}/rankings/refresh	Check rankings now.	変更
GET	/keywords/{keyword_id}/history	Daily rank history of one keyword with competitor ranks.	読み取り

Domains

GET	/domain-analyses	Domain analyses of the account.	読み取り
POST	/domain-analyses	Analyze a domain (uses credits): traffic, keywords, top pages, page types, competitors and backlinks.	クレジットを消費
GET	/domain-analyses/{analysis_id}	One domain analysis.	読み取り

Site health

GET	/projects/{project_id}/site-health	Latest site audit, AI discoverability, security scan and page speed of a website project.	読み取り
POST	/projects/{project_id}/site-audits	Start a site audit (at most once an hour).	変更
GET	/site-audits/{audit_id}	Issues and pages of one site audit.	読み取り
GET	/projects/{project_id}/backlinks	Backlink summary with new and lost links.	読み取り

AI visibility

GET	/projects/{project_id}/ai-visibility	AI visibility summary, questions and latest answers of a project.	読み取り
POST	/projects/{project_id}/ai-visibility/questions	Track AI questions (one per line in `prompts`).	変更
GET	/ai-visibility/questions/{prompt_id}	Timeline and answers of one AI question.	読み取り

Apps

GET	/projects/{project_id}/reviews	Store reviews of an app project.	読み取り
GET	/projects/{project_id}/metadata	Store listing of an app project per language (including the App Store keyword field when connected).	読み取り

Market

GET	/market/apps/{app_id}	Estimated revenue, downloads and chart history of any App Store app.	読み取り
GET	/market/top-earning	Top earning or fastest growing apps by country and category.	読み取り
GET	/market/new-winners	Recently released apps that already earn.	読み取り

Reports

GET	/projects/{project_id}/reports/rankings	One row per keyword and day: rank, checked depth and competitor ranks.	読み取り
GET	/projects/{project_id}/reports/ai-visibility	One row per AI answer: question, platform, mentioned, cited, source position and sentiment.	読み取り
GET	/projects/{project_id}/reports/site-health	One row per site audit: health score, AI discoverability score, errors, warnings and pages.	読み取り

各エンドポイントのパス、クエリ、ボディのフィールドはOpenAPIファイルに記載されています。Postman、Insomnia、コードジェネレーターにインポートできます。

ダッシュボードとレコード

Looker Studioコネクタ
日次の順位、AI可視性の回答、サイトの健全性スコアを、レポートエンドポイントをもとにLooker Studioのデータソースとして利用できます。各行は、1つのキーワードと日、1件のAI回答、または1回の監査を表します。
コネクタを設定
監査ログ
キーで行ったすべての変更とクレジット消費は、キー名、対象、IP、結果とともに記録され、パネルやMCPからの変更と並んで表示されます。オーナーと管理者は、設定 › セキュリティまたは /audit-logs で確認できます。
監査ログについて