GET/api/v4/locations/listings/duplicates

获取账户的所有重复商家信息

返回分页汇总结果,涵盖账户内所有地点的潜在重复商家信息。

需要 API 密钥。请求头格式和密钥轮换请参阅身份验证。

参数

查询

名称类型必填描述默认值
statusstring可选Duplicate status to return: `POTENTIAL`, `PROCESSING`, `FIXED`, or `FAILED`. Case-insensitive.POTENTIAL
siteIdinteger可选Narrow to a single publisher by site ID. See the plan-sites endpoint for valid IDs.—
tagstring可选Tag to scope the rollup to. Defaults to every location the key can see.all
pageinteger可选1-based page number.1
perPageinteger可选Records per page.—

响应

200Paginated rollup of duplicate listing records across the account.
Response
{  "data": {    "duplicateListingsRollup": {      "pageInfo": {        "hasNextPage": true,        "hasPreviousPage": false,        "totalPages": 34,        "totalRecords": 1673      },      "records": [        {          "id": "3329229",          "name": "Woodbury Train Station",          "nameValid": false,          "duplicateProcessingState": "POTENTIAL",          "liveLink": "http://citysquares.com/b/woodbury-train-station-23598450",          "locationId": "73451",          "siteName": "City Squares",          "siteUrl": "citysquares.com"        }      ]    }  }}
400An invalid `status` value, e.g. one outside `POTENTIAL` / `PROCESSING` / `FIXED` / `FAILED`.
401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.

返回账户范围内所有发布平台目录中的潜在重复商家信息汇总视图,方便您批量排查重复商家信息,而无需逐一查询各个地点。上方展示的 pageInfo/records 结构已通过对账户 12345 的实际查询验证;该账户目前没有未处理的重复商家信息,因此,这条记录用于展示存在重复商家信息的地点所返回的数据结构。

使用场景:每晚清查并屏蔽重复商家信息

分页遍历整个账户中处于 POTENTIAL 状态的重复商家信息,并将每个 id 交给审核人员:

Code
GET /api/v4/locations/listings/duplicates?status=POTENTIAL&page=1

筛选条件是扁平的查询参数,而不是 JSON。status 和 siteId 均为可选参数。如果两者均未提供,status 默认为 POTENTIAL,tag 默认为 all,因此,不带参数的 GET /api/v4/locations/listings/duplicates 会返回账户中未处理的重复商家信息,而不是 400。使用 pageInfo.hasNextPage 并递增 page 来分页遍历,直到其值为 false;您可以使用 totalRecords 和 totalPages 显示进度。

使用场景:将范围限定为您的目录中的一部分

汇总结果始终涵盖该密钥可访问的所有地点。若要审核其中一部分,请分页遍历结果,并按每条记录中的 locationId 分组,或针对您关注的地点调用按地点查询的端点。

获得需要处理的 id 后,请使用 将商家信息标记为重复 处理这些记录,或使用 将商家信息标记为非重复 排除误报。若要获取按网站分组的单个地点的重复商家信息,请使用 获取地点的重复商家信息。这是一个受账户速率限制约束的分页列表端点;遇到 429 时,请根据 Retry-After 响应头执行退避。

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