Data Points with the API

Retrieve Data Points with the API and associate them with locations

Last updated on November 1st, 2023

Data Points play an important role in understanding client feedback for specific locations, services and products. Data Points can be Photos, Reviews, Replies to Reviews and Check-ins. This information can be retrieved with the /api/data-points API endpoint and then associated or filtered down to specific locations. The full API documentation on Data Points can be found here under the Data Points section.

Associating Data Points to locations is a two-steps process. 

Retrieve a List of Locations

Retrieving a list of locations before the Data Points allows to fetch those Data Points specifically for the desired locations instead of having to retrieve all Data Points and then having to sort and filter them by location. For the association between Data Point and location, the location id needs to be retrieved from the API.

The below example, in accordance to this, returns a full list of locations for the current account. Those locations will be returned with the following data as defined with the fieldMask parameters: id, identifier, name, street and number, zip code, city.

GET https://uberall.com/api/locations?fieldMask=identifier&fieldMask&name&fieldMask=streetAndNumber&fieldMask=zip&fieldMask=city

headers = {
"privateKey": "YOUR_PRIVATE_KEY_HERE"
}

Retrieve a List of Data Points

Data Points can be retrieved all at once, or per location. Parameters and filter can be found here.

Retrieving Data Points for all locations

GET https://uberall.com/api/data-points

headers = {
"privateKey": "YOUR_PRIVATE_KEY_HERE"
}

Retrieving Data Points for a specified location

GET https://uberall.com/api/data-points/LOCATION_ID_HERE

headers = {
"privateKey": "YOUR_PRIVATE_KEY_HERE"
}

Data Points API responses will contain a locationId attribute that can be directly associated to the id of a location object.

To associate locations and Data Points together, the use of a loop will be required. Depending on how the Data Points are retrieved, a different approach to the loop is taken.

Locations retrieved first and Data Points gathered by location

After the full list of locations is retrieved, a loop goes through the list and make an API call to get all the Data Points for a specific location. Repeat this process until Data Points have been retrieved for all locations.

Data Points retrieved all at once

With both the full list of locations and Data Points retrieved, loop through the locations and find the Data Points associated to the location's id. Repeat this process until all the locations have their Data Points.

Info

Timestamps can be used for certain parameters. These timestamps must be in the UNIX millisecond format for it to be recognized. Example: 

1514764800000


Was this article helpful?

Save as PDF