---
title: "共起語取得"
method: POST
path: "/v1/co-occurrence"
tags: ["共起語取得"]
---

# 共起語取得

`POST /v1/co-occurrence`

共起語取得。
指定キーワードのGoogle検索上位ページから共起語（一緒に使われることが多い語）を抽出する。

SEO記事を上位表示させるために記事に含めるべき単語を把握できる。
SEO記事タイトル/見出し/記事本文を作成する前に使う。

検索上位表示できているページを対象に、本文・タイトル・見出しでの出現回数やサイト数などの指標付きで返す。

Googleは、そのキーワードで検索するユーザーの悩みを解決できる可能性の高い記事を上位表示する。
このため検索上位ページ中で共通して出現する単語は、上位表示のために記事に盛り込むべき単語である可能性が高い。

上位ページの見出し情報も欲しい場合はPOST /v1/headlineを併用する。

1リクエストあたり3クレジットを消費。

## Request body

- CoOccurrenceDto
  - `keyword` string, required — 共起語取得の元となる検索キーワード。1文字以上の文字列を指定する。
  - `getDetails` boolean — URLごとの詳細情報を取得するかどうか。true にすると各共起語について検索上位ページごとの出現情報を返す。省略時は true。
  - `sortBy` 'word' | 'occurrencePageCount' | 'occurrenceTitleCount' | 'occurrenceHeadingCount' | 'siteCountTotal' | 'siteCountHeading' — ソート項目。word / occurrencePageCount / occurrenceTitleCount / occurrenceHeadingCount / siteCountTotal / siteCountHeading。省略時は siteCountTotal。
  - `orderBy` 'asc' | 'desc' — ソート順。asc: 昇順 / desc: 降順。省略時は desc。
  - `limit` integer — 取得件数の上限。正の整数を指定。省略時はすべての結果を返す。

## Response `200`

検索成功

- CoOccurrenceResponseDto
  - `result` boolean, required — API 呼び出しの成否。正常時は true、エラー時は false。
  - `meta` object, required — リクエストに関するメタ情報（課金・消費リソースなど）
    - `consumedCredit` number, required — このリクエストで消費されたクレジット数。
  - `data` object, required — 共起語検索結果データ
    - `query` object, required — リクエストで指定された検索クエリ情報
      - `keyword` string, required — 共起語取得の元になった検索キーワード
    - `summary` object, required — 件数サマリー（全体件数とレスポンスに含まれる件数）
      - `totalCount` number, required — 取得対象全体の件数
      - `returnedCount` number, required — このレスポンスに含まれている件数
    - `items` object[], required — 共起語アイテムのリスト。各アイテムに共起語・指標・詳細情報を含む。
      - `word` string, required — 検索上位ページから抽出した共起語
      - `metrics` object, required — 共起語の各種指標（本文・タイトル・見出しの出現回数、出現サイト数）
        - `occurrencePageCount` number, required — 検索上位ページ内でこの共起語が出現した回数
        - `occurrenceTitleCount` number, required — 検索上位ページのタイトル内でこの共起語が出現した回数
        - `occurrenceHeadingCount` number, required — 検索上位ページの見出し内でこの共起語が出現した回数
        - `siteCountTotal` number, required — 検索上位サイトのうち、この共起語が本文内で出現したサイト数
        - `siteCountHeading` number, required — 検索上位サイトのうち、この共起語が見出し内に出現したサイト数
      - `pageDetails` object[] — URLごとの詳細情報（getDetails=true の場合のみ）
        - `rank` number, required — 検索結果における順位
        - `title` string, required — ページタイトル
        - `url` string, required — ページURL
        - `count` number, required — 共起語の本文内出現回数
        - `countInHeadline` number, required — 共起語の見出し内出現回数
        - `countInTitle` number, required — 共起語のタイトル内出現回数
        - `pageCount` number, required — 共起語が出現したページ数
        - `pageCountInHeadline` number, required — 見出しに共起語が出現したページ数
  - `errors` string[], required — エラーメッセージの配列。正常時は空配列。

## Other responses

- `400` — バリデーションエラー
- `402` — クレジット不足
- `403` — 認証エラー
- `429` — レート制限超過
- `500` — Internal Server Error
- `503` — Service Unavailable - データベース接続エラーなど

---

[API](https://skmtc.dev/rakkokeyword/apis/api.md) · [All operations](https://skmtc.dev/rakkokeyword/apis/api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rakkokeyword/api/revisions/23e921f5f25c/schema)