listings scansの一覧

名前	型	必須	説明	デフォルト
page	integer	任意	Page number, starting at 1.	1
perPage	integer	任意	Scans per page, from 1 to 50. Values outside that range are brought back to it.	20

名前

型

必須

説明

デフォルト

page

integer

任意

Page number, starting at 1.

perPage

integer

任意

Scans per page, from 1 to 50. Values outside that range are brought back to it.

レスポンス

200A page of scans, newest first. List items carry no `results`; read a scan with GET /listings/scans/{scanId} for those. `quota` is the monthly allowance.

Response

{  "data": {    "listingScans": {      "scans": [        {          "id": "TGlzdGluZ1NjYW46Mzk0YTRhNWMtZjcwMy00NjZiLTg2NjAtMDU4MTlmNDhkZjMz",          "status": "COMPLETED",          "source": "DIRECTORY_SEARCH",          "locationId": null,          "resultsAsOf": "2026-11-05T07:01:51Z",          "createdAt": "2026-11-05T07:01:08Z",          "startedAt": "2026-11-05T07:01:11Z",          "completedAt": "2026-11-05T07:01:51Z",          "business": {            "name": "Joe's Pizza",            "street": "7 Carmine Street",            "city": "New York",            "stateIso": "NY",            "postalCode": "10014",            "countryIso": "US",            "phone": "+12123661182"          },          "summary": {            "total": 62,            "found": 21,            "accurate": 18,            "inaccurate": 2,            "notFound": 41,            "pending": 0,            "unavailable": 0          },          "failure": null        },        {          "id": "TGlzdGluZ1NjYW46YWVhNjljOWQtMWJkMC00ODcxLWI1MjctOGMyOWYxNWM2ZDU4",          "status": "COMPLETED",          "source": "DIRECTORY_SEARCH",          "locationId": null,          "resultsAsOf": "2026-11-05T07:01:51Z",          "createdAt": "2026-11-05T07:01:02Z",          "startedAt": "2026-11-05T07:01:11Z",          "completedAt": "2026-11-05T07:01:51Z",          "business": {            "name": "Hattie B's Hot Chicken",            "street": "112 19th Ave S",            "city": "Nashville",            "stateIso": "TN",            "postalCode": "37203",            "countryIso": "US",            "phone": "+16158025700"          },          "summary": {            "total": 62,            "found": 34,            "accurate": 31,            "inaccurate": 2,            "notFound": 28,            "pending": 0,            "unavailable": 0          },          "failure": null        }      ],      "pageInfo": {        "totalPages": 3,        "totalRecords": 6,        "hasNextPage": true,        "hasPreviousPage": false      },      "quota": {        "limit": 50,        "used": 5,        "remaining": 45,        "resetsAt": "2026-11-23T12:38:03Z"      }    }  }}

401Unauthenticated, missing or invalid API key.

429Rate limit exceeded. Retry after the `Retry-After` header value.

アカウントで作成したスキャンを新しい順に一覧表示します。各項目にはGET /listings/scans/{scanId}と同じフィールドがありますが、resultsは含まれません。各項目のsummaryには件数が含まれます。結果全体を取得するには、その項目のidをGET /listings/scans/{scanId}に渡します。

ユースケース: 監査履歴。 チームが実行したスキャンを、それぞれのビジネス、ステータス、summaryとともに表示します。各行に、GET /listings/scans/{scanId}を使って作成したスキャンページへのリンクを設定します。

ユースケース: 作成前の利用枠の確認。 quotaは、プランの月間利用枠に関する情報として、limit、used、remaining、および次回の利用枠のリセット日時であるresetsAtを返します。作成を一括で実行する前にこの情報を取得し、新規スキャンをあと何件作成できるか確認します。listings scansが含まれないプランなど、アカウントに利用枠がない場合はnullになります。

ページネーション

pageは1から始まり、perPageのデフォルト値は20です。pageInfoには、現在の位置を示すtotalRecords、totalPages、hasNextPage、hasPreviousPageが含まれます。ページを順番にリクエストし、hasNextPageがfalseになったら終了します。

注記。

スキャンは90日間保存されます。それより古いスキャンは返されません。
アカウントにまだスキャンがない場合、scans配列は空です。
一覧の取得は、レート制限のリクエスト数を1回分消費します。スキャンの完了を待つために一覧を取得しないでください。対象のスキャンを直接取得するか、listing_scan.completed Webhookを使用してください。

listings scansの一覧

パラメーター

クエリ

レスポンス

ページネーション