Sign in

v1

latestOpenAPI 3.0.12026-07-2433136135.1 KB
Manage POIs

Get Custom POI Info

The Get Custom POI Info service can be used to retrieve information regarding any of your <<glossary:Custom POI>>s, by providing its id.</br> If the requested Custom POI is newly created, this endpoint will respond with the following statuses:</br>

  • HTTP code = 200: The full response for the Get Custom POI is provided.</br> - HTTP code = 202: The creation process is still in progress.</br> - HTTP code = 404: The POI does not exist, indicating a failure in the creation process. Please retry creating the custom POI.</br> - HTTP code = 500: Server error.
get/v1/poi/custom-poi/{id}

Path parameters

idstring required

Placer API ID

Response

200 response

apiIdstring

Placer API Entity Id

namestring

Entity Name

entityIdstring

Entity ID

entityType'venue' | 'complex' | 'chain'

Entity Type (i.e. venue, complex etc.)

isFlaggedboolean

The Entity Data Is Incomplete

placerUrlstring
parentChainsobject
parentTagsobject
isPermittedboolean

This flag indicates whether the account is permitted to generate/request reports on this entity or not.

regionTypestring

The regions which the entity is associated with. Supported regions are: 'nationwide', 'state', 'dma' & 'cbsa'. Relevant only for chain.

regionCodestring

The code defining the region (e.g. The state of Arizona -> 'AZ', nationwide -> 'US'). Relevant only for chain.

storeIdstring

The identification of a venue. Relevant only for chain's venues.

Example response

{
  "apiId": "venue:7d55054520e387813d764b03",
  "name": "Walmart",
  "entityId": "7d55054520e387813d764b03",
  "entityType": "venue",
  "categoryInfo": {
    "category": "Fast Food & QSR",
    "group": "Dining",
    "subCategory": "Pizze Place"
  },
  "address": {
    "city": "Milpitas",
    "state": "California",
    "countryCode": "US",
    "streetName": "Ranch Dr",
    "formattedAddress": "301 Ranch Dr, Milpitas, CA, United States",
    "shortFormattedAddress": "Ranch Dr, Milpitas, CA",
    "zipCode": "95035"
  },
  "regions": {
    "dma": {
      "name": "San Francisco-Oakland-San Jose, CA"
    },
    "state": {
      "code": "CA",
      "name": "California"
    },
    "cbsa": {
      "code": "41940",
      "name": "San Jose-Sunnyvale-Santa Clara, CA Metro Area"
    }
  },
  "placerUrl": "https://staging-analytics.placer.team/#!/admin/insights/venues/7d55054520e387813d764b03/overview",
  "parentChains": {
    "apiId": "chain:58ef64a9173f5601f92d8f0e",
    "name": "Target"
  },
  "parentTags": {
    "apiId": "tag:614c118e500adeae9e9e70a6",
    "name": "Test Group Tag"
  },
  "isPermitted": true,
  "regionType": "dma",
  "regionCode": "11010"
}