GET/api/v4/locations/{locationId}/listings/premium

Dapatkan profil bisnis premium untuk suatu lokasi

Mengembalikan status sinkronisasi setiap direktori platform publikasi dalam paket suatu lokasi.

Memerlukan kunci API. Lihat Autentikasi untuk format header dan rotasi kunci.

Parameter

Path

NamaTipeWajibDeskripsi
locationIdstringwajibLocation to read. Accepts a base64-encoded Relay ID (e.g. `TG9jYXRpb246MTgwMDI4OQ==`) or a raw numeric location ID.

Respons

200Array of listings with per-directory sync status.
Response
{  "data": {    "listingsForLocation": [      {        "id": "TGlzdGluZzoxMDQ0Njg3MjM=",        "databaseId": "104468723",        "site": { "id": "U2l0ZTox", "databaseId": "1", "name": "Google Maps", "url": "maps.google.com", "syScore": "100" },        "syncStatus": "REQUIRING_ACTION",        "displayStatus": "Connect your account to sync the listing",        "actionRequired": true,        "listingUrl": null,        "connectedAccountId": null,        "lastUpdate": "2026-07-06T18:33:28Z",        "indexStatus": false,        "syncIssue": null,        "verified": false      },      {        "id": "TGlzdGluZzoxMDQ0Njg3MTQ=",        "databaseId": "104468714",        "site": { "id": "U2l0ZToxODA=", "databaseId": "180", "name": "Bing", "url": "www.bing.com", "syScore": "97" },        "syncStatus": "IN_PROGRESS",        "displayStatus": "Information submitted to partner; awaiting response",        "actionRequired": false,        "listingUrl": null,        "connectedAccountId": null,        "lastUpdate": "2026-07-06T18:33:35Z",        "indexStatus": false,        "syncIssue": null,        "verified": false      },      {        "id": "TGlzdGluZzoxMDQ0Njg3Mjc=",        "databaseId": "104468727",        "site": { "id": "U2l0ZTozODc=", "databaseId": "387", "name": "BeLocalFocussed", "url": "belocalfocussed.com", "syScore": "80" },        "syncStatus": "SYNCED",        "displayStatus": "Synced",        "actionRequired": false,        "listingUrl": "https://belocalfocussed.com/jenny-home-26x0ffkd0e",        "connectedAccountId": null,        "lastUpdate": "2026-07-06T18:33:30Z",        "indexStatus": false,        "syncIssue": null,        "verified": false      },      {        "id": "TGlzdGluZzoxMDQ0Njg3MDk=",        "databaseId": "104468709",        "site": { "id": "U2l0ZTozMDE=", "databaseId": "301", "name": "Local Mint", "url": "localmint.com", "syScore": "69" },        "syncStatus": "FAILED",        "displayStatus": "Partner experiencing issues; awaiting response",        "actionRequired": false,        "listingUrl": null,        "connectedAccountId": null,        "lastUpdate": "2026-07-06T18:34:03Z",        "indexStatus": false,        "syncIssue": "Publisher requires website URL",        "verified": false      }    ]  }}
401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.

Mengembalikan status sinkronisasi setiap direktori platform publikasi yang termasuk dalam paket suatu lokasi. Setiap rekaman memasangkan site (metadata direktori) dengan syncStatus dan displayStatus yang dapat dibaca manusia. Contoh di atas diringkas dari respons aktual untuk Jenny Home (yang mengembalikan lebih dari 30 direktori) untuk menampilkan satu rekaman bagi setiap status yang umum.

Tingkat profil bisnis merupakan bagian dari path: /listings/premium mengembalikan direktori premium dalam paket tersebut (ditampilkan di sini) dan /listings/additional mengembalikan profil bisnis tambahan/gratis. Tidak ada parameter kueri listingType; nilai yang dikirim melalui parameter tersebut diabaikan.

Kasus penggunaan: dasbor kondisi profil bisnis

Ambil profil bisnis premium untuk suatu lokasi dan kelompokkan berdasarkan syncStatus untuk menampilkan cakupan secara sekilas, yaitu jumlah direktori yang sudah aktif, sedang diproses, atau terhambat. Tampilkan listingUrl untuk baris berstatus SYNCED agar pengguna dapat mengekliknya untuk membuka profil bisnis yang aktif, dan baca displayStatus/syncIssue untuk setiap profil bisnis yang belum tersinkronisasi (e.g. Publisher requires website URL).

Kasus penggunaan: tampilkan hambatan "hubungkan akun Anda"

Filter berdasarkan actionRequired: true untuk menyusun daftar tugas pemilik. Dalam data aktual, Google Maps, Facebook, dan Waze dikembalikan dengan status REQUIRING_ACTION disertai displayStatus: "Connect your account to sync the listing"; semuanya memerlukan koneksi OAuth sebelum dapat disinkronkan. Arahkan pemilik ke alur koneksi yang sesuai, lalu lakukan polling ulang pada endpoint ini untuk memantau perkembangan status.

Nilai syncStatus: AVAILABLE (siap disinkronkan, belum dimulai), IN_PROGRESS (telah diajukan ke mitra, menunggu respons), PENDING_APPROVAL (menunggu persetujuan mitra), SYNCED / COMPLETED (aktif; listingUrl terisi), REQUIRING_ACTION (memerlukan tindakan pemilik, lihat displayStatus), FAILED (sinkronisasi gagal; lihat syncIssue), CANNOT_SUBMIT (pengajuan tidak dapat dilakukan).

Daftar ini berlaku per lokasi dan tunduk pada batas laju permintaan akun; saat menerima 429, coba lagi setelah waktu tunggu yang ditentukan dalam header Retry-After berlalu, alih-alih langsung melakukan polling ulang.

Request
curl -X GET 'https://listingsapi.com/api/v4/locations/<locationId>/listings/premium' \  -H "Authorization: API $LISTINGSAPI_KEY"