Branch Landing

Branch Landing

Information about the branch and its connections
Information about the branch and its connections by unique id
GET /api/v1/landing/branch/{id} HTTP/1.1
Host: tapki.com
X-Api-Key: TPK-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
ArgumentTypeRequiredDescription
idstringtrueA unique page number

BranchLanding

The name of the fieldTypeDescription
branchContactsBranchContactsBranch contacts
phoneNumbersstring[]List of phone numbers
socialLinksstring[]Links to social networks
updateDateDateUpdate date
updateDateStringstringUpdate date in string format
websitesstring[]Websites
branchGeoBranchGeoGeographic information about the branch
citystringCity
coordinatesBranchCoordinatesCoordinates
latitudestringLatitude
longitudestringLongitude
countrystringCountry
geoIdstringGeo-identifier
housestringHouse number
postalCodestringPostal code
streetstringStreet
updateDateDateUpdate date
updateDateStringstringUpdate date in string format
branchInfoBranchInfoBasic information about the branch
categoriesstring[]List of categories
fullAddressstringFull address
statusstringStatus
titlestringBranch name
updateDateDateUpdate date
updateDateStringstringUpdate date in string format
workingTimestringOpening hours
branchProductsBranchProductsBranch products and services
productCategoriesProductCategory[]Product categories
categoryNamestringCategory name
productsProduct[]Products in category
currencystringCurrency
descriptionstringProduct Description
pricestringPrice
titlestringProduct name
updateDateDateUpdate date
updateDateStringstringUpdate date in string format
branchReviewsBranchReviewsAnalytics based on branch reviews
aspectsAspect[]Aspects mentioned in reviews
countnumberNumber of mentions
negativenumberNumber of negative mentions
positivenumberNumber of positive mentions
textstringAspect text
reviewsCountnumberTotal number of reviews
updateDateDateUpdate date
updateDateStringstringUpdate date in string format
yearlyAnalyticsRecord<string, YearlyReviewAnalytics>Key - year (in the form of a string), Value - all analytics for this year.
individualRatingsIndividualRatingsAnalyticsAnalytics for the graph 'Individual assessments over time'
dataTimeSeriesDataPoint<number>[]DATA: An array of all individual assessments with their dates.
dateDateDate
valuenumberMeaning
longestNegativeStreaknumberMETRIC: Longest continuous series of negative reviews (1-2*).
longestPositiveStreaknumberMETRICS: Longest continuous streak of positive reviews (4-5*).
ratingVolatilitynumberMETRIC: Estimate volatility (standard deviation).
monthlyAverageRatingsAverageRatingAnalyticsAnalytics for the chart 'Average rating over time' (by month)
dataTimeSeriesDataPoint<number>[]DATA: Array of average monthly estimates.
dateDateDate
valuenumberMeaning
largestMonthlyImprovementnumberMETRICS: Largest improvement in average rating in one month.
monthsAboveAveragenumberMETRIC: Number of months when the average rating was higher than the annual average.
trendSlopenumberMETRIC: Slope of trend line. A positive number means the rating goes up, a negative number means it goes down.
monthlyReviewCountsReviewCountAnalyticsAnalytics for the chart 'Number of reviews over time' (by month)
dataTimeSeriesDataPoint<number>[]DATA: An array with the number of reviews for each month.
dateDateDate
valuenumberMeaning
engagementTrendSlopenumberMETRIC: Engagement trend (slope of trend line by number of reviews).
volumeVolatilitynumberMETRIC: Volatility of reviews received.
yearlyGrowthPercentagenumberMETRIC: Annual increase in the number of reviews as a percentage.
ratingDistributionRatingDistributionAnalyticsAnalytics for the 'Score Distribution' graph
customerSatisfactionScorenumberMETRIC: Customer Satisfaction Index (from -100 to 100).
dataRecord<string, number>DATA: Key - rating ('1' to '5'), Value - number of reviews.
overallAverageRatingnumberMETRIC: Overall average rating for the year.
polarizationFactornumberMETRIC: Opinion polarization coefficient (from 0 to 1).
yearnumberThe year to which the analytics relates
ratingnumberOverall rating
competitorBranchesBranchLanding[]Branches of competitors
relatedBranchesBranchLanding[]Related branches
relatedCompaniesCompanyLanding[]Associated organizations
relatedDomainsDomainLanding[]Related Websites
relatedEmailsEmailLanding[]Related emails
relatedPhonesPhoneLanding[]Associated phone numbers
similarBranchesBranchLanding[]Similar branches
descriptionstringFull branch address
hrefstringLink to page on the site
idnumberUnique page number
providerstringData Provider
searchTagsSearchTag[]Search tags
titlestringBranch name

Related articles

Branch Landing