/api/v4/listings/scanslistings scans listesi
Hesabın listings scans listesini, en yeniler başta olacak şekilde, dizin bazında sonuçlar olmadan, sayfalama bilgileri ve aylık kotayla döndürür.
Parametreler
Sorgu
| Ad | Tür | Zorunlu | Açıklama | Varsayılan |
|---|---|---|---|---|
| page | integer | isteğe bağlı | Page number, starting at 1. | 1 |
| perPage | integer | isteğe bağlı | Scans per page, from 1 to 50. Values outside that range are brought back to it. | 20 |
Yanıtlar
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.
{ "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.
Hesabınızın oluşturduğu taramaları en yenisi ilk sırada olacak şekilde listeler. Her öğe, GET /listings/scans/{scanId} ile aynı alanlara sahiptir; ancak results dahil edilmez. Her öğedeki summary sayıları içerir; sonuçların tamamını okumak için öğenin id değerini GET /listings/scans/{scanId} aracılığıyla iletin.
Kullanım örneği: denetim geçmişi. Ekibinizin çalıştırdığı taramaları, her birinin işletmesi, durumu ve summary değeriyle birlikte gösterin. Her satırı, GET /listings/scans/{scanId} temelinde oluşturduğunuz tarama sayfasına bağlayın.
Kullanım örneği: oluşturmadan önce kotayı kontrol etme. quota, planınızın aylık kotasını bildirir: limit, used, remaining ve kotanın bir sonraki sıfırlanma zamanı olan resetsAt. Kaç yeni tarama hakkınız kaldığını görmek için bir dizi oluşturma işleminden önce bu bilgiyi okuyun. Hesabın kotası yoksa, örneğin listings scans içermeyen bir plandaysa, bu değer null olur.
Sayfalama
page 1'den başlar ve perPage varsayılan olarak 20'dir. pageInfo, hangi noktada olduğunuzu bildirir: totalRecords, totalPages, hasNextPage ve hasPreviousPage. Sayfaları sırayla isteyin ve hasNextPage değeri false olduğunda durun.
Notlar.
- Taramalar 90 gün boyunca saklanır. Daha eski taramalar döndürülmez.
- Hesapta henüz tarama yoksa
scansdizisi boştur. - Listeyi okumak, istek hızı sınırınızdan bir istek kullanır. Bir taramanın tamamlanmasını beklemek için listeyi kullanmayın: ilgili taramayı doğrudan okuyun veya
listing_scan.completedwebhook'unu kullanın.
curl -X GET 'https://listingsapi.com/api/v4/listings/scans' \ -H "Authorization: API $LISTINGSAPI_KEY"