The CityGrid Places Status API is part of the Advertising API suite and is intended to help a partner or their advertisers understand if a local business, or Place, has been successfully added to or updated within the CityGrid Places dataset. A new partner is only enabled to create listings after an internal review of their data quality. Partners who cannot create listings must provide data that matches to an existing listing, or that place will not go live and will not generate connections. There are multiple reasons a listing may not have matched and gone live; this is the information this API provides with the intent of providing transparency and a way for a partner and merchants to resolve these issues on their own. Report information is available in both JSON or XML.
The operation is invoked via HTTPS GET to:
Comma-separated list of place IDs. If specified, external_places_id must be left empty.
Comma-separated list of external IDs of the place. If specified, place_ids must be left empty.
Request Header Values
Requested format for the response
Authentication Token from the Places Status API
The token received during registration
Example 1: Get the status for place by place_ids that is owned by the authToken.
Example 2: Get the status of multiple places using external place IDs
Total number of places in the response.
The place ID.
External place ID of the campaign.
Status of the places in the system:
PENDING_BUSINESS_MATCH: Place is pending on matching process. If a place is in this state for more than a couple days then no match exists. Please verify accuracy of name, address and phone provided.
MATCHED: Place is matched and active.
ENTITY_NOT_FOUND: There are no places found given the id/external place id
When places is submitted. Returns empty if place not found
The following shows success responses in JSON and XML format.
The following shows error responses (in JSON and XML format) when campaignId are not comma separated numbers.