Skip to main content
POST
類似企業の検索

承認

pubrio-api-key
string
header
必須

API で実行する操作内容と、その操作に付与された権限を識別するための一意の API トークンです。このトークンはダッシュボードの 設定 画面から発行できます。

ボディ

application/json
domain_search_id
string<uuid>
必須

企業検索系の処理を紐づけるための一意の識別子です。

locations
string[]

ISO 3166-1 alpha-2(CCA2)コードで地域を指定するフィルターです。詳細はフィルタータブの location エンドポイントを参照します。

:
exclude_locations
string[]

ISO 3166-1 alpha-2 コードで、検索結果から除外する地域を指定します。

:
technologies
integer[]

特定のテクノロジーを利用している企業を検索するための tag_id 一覧です。ID はフィルタータブの technology エンドポイントから取得します。is_enable_similarity_search を有効化すると、["Shopify"] のような自由テキスト入力も可能になります。

categories
integer[]

特定のテクノロジーカテゴリを利用している企業を検索するための category_id 一覧です。is_enable_similarity_search を有効化すると、["CDN"] のような自由テキスト入力も可能になります。

verticals
integer[]

特定の業界・業種セグメントに属する企業を検索するための vertical_id 一覧です。is_enable_similarity_search を有効化すると、["AI"] などの自由テキスト入力が可能です。

vertical_categories
integer[]

特定の業界カテゴリに属する企業を検索するための vertical_category_id の一覧です。フィルターは is_enable_similarity_search に対応しており、有効化すると ["Information Technology"] のような自由テキストから候補 ID を解決できます。

vertical_sub_categories
integer[]

特定の業界サブカテゴリに属する企業を検索するための vertical_sub_category_id の一覧です。is_enable_similarity_search を有効化すると、["Software"] のような自由テキスト入力に基づいて関連 ID を検索できます。

domain
string

企業ルックアップに使用する会社ドメインです。www.pubrio.comhttps://docs.pubrio.com/ のような値が指定された場合、自動的に pubrio.com に正規化されます。

:

"pubrio.com"

linkedin_url
string

企業の LinkedIn 公式ページを指す完全な URL です。値は http で始まり、linkedin.com/company/ を含んでいる必要があります。

:

"https://www.linkedin.com/company/pubrio"

employees
string[][]

企業の従業員数レンジを表します。複数レンジを指定することで、対象となる会社規模の幅を広げられます。詳細は company size エンドポイントを参照します。

:
founded_dates
integer[]

企業の設立年レンジです。最大値には当年が指定可能です。

:
revenues
integer[]

企業収益の最小値と最大値を表すレンジです。

:
job_locations
string[]

ISO 3166-1 alpha-2(CCA2)コードで地域を指定するフィルターです。詳細はフィルタータブの location エンドポイントを参照します。

:
job_posted_dates
string[]

求人の掲載日レンジです。最大値には当日が指定可能です。

:
job_titles
string[]

対象人物に関連する役職名です。完全一致でなくても、類似する役職を含む結果が返されます(例:software engineersenior software engineer もヒット)。

:
news_categories
string[]

特定のニュースカテゴリを検索するためのカテゴリスラッグ一覧です。スラッグは news categories エンドポイントから取得します。

:
news_published_dates
string[]

ニュースの公開日レンジです。最大値には当日が指定可能です。

:

対応するフィルターで類似度検索を有効にするフラグです。有効化すると、ID ではなく自由テキストを渡しても、内部で類似スコアに基づいて候補を解決できます。

similarity_score
number<float>

is_enable_similarity_search と併用するスコアしきい値で、業種や技術などのスラッグとユーザー入力の近さを数値で指定します。値が高いほどマッチング条件が厳しくなり、より精度の高い結果に絞り込まれます。

:

0.7

per_page
integer
デフォルト:25

1 ページあたりの件数。既定は 25 で、多くのプランではこれが上限でもあります。制限値はサブスクリプションの max_search_per_page で、Profile から取得できます。超過すると結果が丸められるのではなく、HTTP 416 とコード 41676(企業・人物検索では 41613)が返ります。

必須範囲: x <= 25
:

25

page
integer
デフォルト:1

ページ番号(1 から開始)。上限はサブスクリプションの max_search_page(企業検索では max_company_search_page)で、Profile から取得できます。超過すると HTTP 416 が返ります。

:

1

レスポンス

関連する詳細情報を含む成功レスポンスです。

metadata
object

リクエストのコンテキスト。エコーされた filtersparameters、および credittopup_credittotal_credit_cost を含む profile ブロックを保持します。これは API が返す唯一の呼び出し単位のクレジット計上情報です。

data
object | null

エンドポイント固有のレスポンスをオブジェクト形式で格納する汎用コンテナです。