Signal Foundry
ドキュメント
サポート 戻る
ドキュメントユースケースAPI リファレンスリリースノート

API リファレンス

認証、利用上限、主要 endpoint を実行単位で確認します。

API 概要
OpenAPI Inventory会社検索会社プロフィール会社の観測データ開示一覧開示詳細開示比較観測データ検索ソースAPIリストAPIリスト見積もりリスト候補確認リスト保存リストEnrichmentリストExport調査アイテムクレジット残高クレジット利用サマリーフィードバックAPI外部調査API
API リファレンス

GET /lists/{listId}/export

saved List を CSV などの形式で書き出す endpoint です。preview ではなく saved List が必要です。

このページの内容8項目
契約サマリーリクエストパスパラメータクエリパラメータ例レスポンスエラー次に進む

GET /api/signal-foundry/lists/{listId}/export は、saved List を CSV として書き出します。candidates preview は export できません。

契約サマリー

FieldValue
MethodGET
Path/api/signal-foundry/lists/{listId}/export
Authproduction は API key 必須
Usagerequest usage に count
Credit消費しない
CLIsf list export <listId> --format csv --output ./exports/list.csv --json

リクエスト

パスパラメータ

ParamTypeNotes
listIdstringsaved List の id

クエリパラメータ

ParamTypeNotes
formatstringdefault csv

例

curl -s "$SIGNAL_FOUNDRY_BASE_URL/api/signal-foundry/lists/00000000-0000-4000-8000-000000000000/export?format=csv" \
  -H "Authorization: Bearer <SIGNAL_FOUNDRY_API_KEY>" \
  -o ./exports/list.csv

CLI equivalent:

sf list export 00000000-0000-4000-8000-000000000000 --format csv --output ./exports/list.csv --json

レスポンス

HTTP response body は CSV です。CLI では file metadata を JSON で返します。

中心フィールド:

  • path
  • row_count
  • sha256
  • expires_at

CLI response example:

{
  "path": "./exports/list.csv",
  "row_count": 42,
  "sha256": "4c2d0f...",
  "expires_at": null
}

HTTP header:

  • x-signal-foundry-row-count
  • x-signal-foundry-credits-used

CSV に入るもの:

  • canonical company fields
  • saved List rows
  • website enrichment columns
  • Parallel enrichment columns:
    • parallel_enrichment_status
    • parallel_enrichment_charged
    • parallel_enrichment_enriched_at
    • parallel_enrichment_summary
    • parallel_enrichment_reason
    • parallel_enrichment_query
    • parallel_enrichment_urls
    • parallel_enrichment_signals
  • source import 由来の source:<original_header> columns

Parallel enrichment を実行していない List では、これらの列は空になります。export は無料ですが、Parallel enrichment run は estimate 後に --execute --max-credits で実行します。

エラー

CodeHTTP復旧方法
list_not_found404saved List の listId を確認
preview_export_not_allowed400POST /lists/materialize の後に export
invalid_query400supported format を指定

次に進む

export 前に追加情報が必要なら Lists Enrichments に戻ります。

このページの内容

契約サマリーリクエストパスパラメータクエリパラメータ例レスポンスエラー次に進む