Duplicate Suppression | Hitchhikers Platform
Overview
Publishers in the Publisher Network only want a single listing for each entity, but sometimes duplicates of the same listing appear. While duplicates may appear for a variety of reasons, Yext can help you manage and suppress those unwanted listings.
Use the Duplicate Suppression APIs to take action on duplicates of your listings across the Publisher Network. The Duplicate Suppression tool allows you to tell publishers which listings should be hidden or deleted from their site because they are duplicates of your actively managed Yext listing. You can use the Duplicate Suppression endpoints to retrieve the list of potential duplicates, suppress duplicates, add new potential duplicates, or remove duplicates.
Yext is constantly looking for potential duplicates of your listings on your behalf. These are the results that appear when you call Duplicates: List. It is up to you to manage that list of duplicates by taking one of a few actions:
Create
: If we missed a potential duplicate listing, you can create a new potential duplicate in our system.Delete
: If a potential duplicate listing we found is not actually a duplicate, you can delete itSuppress
: If a potential duplicate listing is a true duplicate, you can tell us to suppress it. We will then tell the publisher they are safe to remove that listing.
- Check the status of pending duplicates
- Submit a duplicate to be suppressed
- Revert a suppressed duplicate
Duplicates: List
Retrieve Duplicates for an account
If the v
parameter is 20180802
or later: only duplicates of live listings (status
: LIVE
) will be included
path Parameters
accountId required | string |
query Parameters
v required | string A date in |
limit | integer <= 50 Default: 10 Number of results to return |
offset | integer Default: 0 Number of results to skip. Used to page through results.
Cannot be used together with |
locationIds | Array of strings Defaults to all account locations with a Listings subscription. Example: loc123,loc456,loc789 |
publisherIds | Array of strings List of publisher IDs. If no IDs are specified, defaults to all publishers subscribed by the account. Example: MAPQUEST,FACEBOOK |
statuses | Array of strings Items Enum: "POSSIBLE_DUPLICATE" "SUPPRESSION_REQUESTED" "SUPPRESSED" "UNAVAILABLE" When specified, only Duplicates with the provided statuses will be returned Example: POSSIBLE_DUPLICATE,SUPPRESSION_REQUESTED |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "count": 0,
- "duplicates": [
- {
- "id": "string",
- "publisherId": "string",
- "locationId": "string",
- "url": "string",
- "name": "string",
- "address": "string",
- "phone": "string",
- "latitude": "string",
- "longitude": "string",
- "status": "POSSIBLE_DUPLICATE",
- "suppressionType": "REDIRECT",
- "unavailableReasons": [
- {
- "code": "string",
- "reason": "string"
}
]
}
]
}
}
Duplicates: Create
Creates a new Duplicate with status
SUPPRESSION_REQUESTED
.
NOTE: When sending requests to this endpoint, you must provide your Yext user ID in the Yext-User-Id
header.
path Parameters
accountId required | string |
query Parameters
v required | string A date in |
locationId | string An account location ID with a Listings subscription. |
publisherId required | string |
url required | string URL of the Duplicate listing |
Responses
Response samples
- 201
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "id": "string"
}
}
Duplicates: Delete
Indicates that a Duplicate should be ignored.
NOTE: When sending requests to this endpoint, you must provide your Yext user ID in the Yext-User-Id
header.
path Parameters
accountId required | string |
duplicateId required | string |
query Parameters
v required | string A date in |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": { }
}
Duplicates: Suppress
Request suppression of a Duplicate.
NOTE: When sending requests to this endpoint, you must provide your Yext user ID in the Yext-User-Id
header.
path Parameters
accountId required | string |
duplicateId required | string |
query Parameters
v required | string A date in |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": { }
}