1. Rankings
  • Getting Started
  • Locations
    • Location Attributes
      MARKDOWN
    • Photo specifications for your business location
      MARKDOWN
    • Star and Unstar Photos
      MARKDOWN
    • Create a new business location
      POST
    • Update business location
      POST
    • List all locations
      GET
    • List particular locations
      GET
    • Search locations
      GET
    • Get locations by store codes
      GET
    • Get Photos by Location IDs
      GET
    • Upload Photos to a Location
      POST
    • Check Bulk Photo Upload Status
      GET
    • Star/Unstar Location Photos
      POST
    • Delete Location Photos
      POST
    • Archive multiple locations
      POST
    • Cancel scheduled location archival
      POST
    • Activate archived locations
      POST
    • List Active Subscriptions
      GET
    • Get a list of supported countries and their states
      GET
    • Get SubCategories and AdditionalCategories
      GET
    • Get Site Details for Your Plan
      GET
    • Location Indexing Rate
      GET
  • Organizing locations
    • Organizing locations
    • Create a new folder
    • List all folders
    • List all folders under an account in hierarchical structure
    • Get details of a folder
    • Rename a folder
    • Add locations to a folder
    • Remove locations from a folder
    • Delete a folder
    • List locations under a folder
    • List all tags
    • List locations by tags
    • Add location to a tag
    • Remove location from a tag
  • User Management
    • User Attributes
    • Create User with Role
    • List Users
    • List Users by ID
    • Add Locations to User
    • Add User and folder
    • List User Roles
    • Add folders to user
    • List User Resources
    • Update a User
    • Remove Folders for User
    • Remove Locations for User
  • Grid Rank
    • Local Rank Grid
    • Create Rank Grid Report
    • Fetch All Grid Reports for Location
    • Fetch Rank Grid Report By ID
  • Review Campaigns
    • Review Campaign Info Attributes
    • Create a review campaign
    • Add customers to a review campaign
    • List review campaigns
    • List review campaign customers
  • Listings
    • Listings
    • Listing Status Webhooks
    • Get premium listings
    • Get voice listings for a location
    • Get duplicate listings for a location
    • Get all duplicate listings for an account
    • Mark listings as duplicates
    • Mark listings as not duplicates
    • Get AI listings
  • Connected Accounts
    • Connected Accounts
    • Connect Google Profile to Account
    • Connect Facebook Page to Account
    • List all connected accounts
    • List folders under a Google account
    • Create GMB Listing
    • Disconnect GMB Profile
    • Disconnect Facebook Account
    • Fetch Connected Account Details
    • Trigger New Matches
    • List Connection Suggestions
    • Fetch Connected Account Listings
    • Confirm Connected Account Matches
    • Connect a location with a listing of a connected account
    • Disconnect Location from Listing
  • Rankings
    • Rankings Analytics Attributes
      MARKDOWN
    • Add keywords
      POST
    • List Keywords
      GET
    • Get keywords performance
      GET
    • Archive a keyword
      POST
    • Get Rollup Keyword Performance
      POST
    • Get Rankings Distribution By Time
      POST
  • Profile Analytics
    • Profile Analytics
    • Get Bing Analytics
    • Get Facebook Page Analytics
    • Get Google My Business Analytics
  • Reviews
    • Reviews
    • Review Sources
      • Get a list of interaction sources for location
      • Get a list of interaction sources for account
      • Add / Edit interaction source
    • Fetch all interactions
    • List Interactions by IDs
    • Respond to an Interaction
    • Edit Response for Interaction
    • Archive Response for Interaction
    • Get Interaction Analytics
    • Add Review Widget
    • Edit Review Widget
    • Rollup Review API
  • Automations
    • Temporary Close Location with a reopening date
  • Error Codes
    • ERROR CODES
  1. Rankings

Rankings Analytics Attributes

MARKDOWN
https://api.synup.com/api/v4

Overview#

This API provides search engine ranking analytics for a specific location based on the keywords assigned to it.
Rankings help businesses understand the position of their business in a search result for the keywords added for the location. If you are a business like 'Pizza Hut' and you want to track a keyword 'pizza restaurant near me', the Rankings feature will let you know that your business appears in 10th position on the search results. The search is emulated from the coordinates of the business's physical location, to If your business name appears on the 10th position on the first page, your rank will be 10. If it appears on the 5th position on the second page, your rank will be 15.
Ranks are calculated weekly once and they are fetched for Google Maps and Google. Rank will be 0 if the business was not found in the SERP result at all.
Ranks will always be calculated from the time the keyword was added in to the system. It is not possible to fetch ranks for a past period.

Rank Analytics Attributes#

Given below are the response fields that returned for the API endpoints in Rankings

Fetching keywords added for a location#

Name Field TypeDescription
idStringThe unique ID attached to the keyword
name StringThe text value of the keyword eg: pizza near me

Get performance of all keywords for location#

NameField Type Description
idString The unique ID attached to the keyword
nameStringThe text value of the keyword
sites ObjectAn object containing the name of the site and the rankings object for it

sites object fields#

Name Field Type Description
nameStringThe name of the site for which rankings are present
rankings Object An object containing ranking information for the particular matched site

rankings object fields#

Name Field Type Description
rank Integer The rank for the particular keyword in the search results
rankedAtDatetime The date and time at which the keyword was ranked
matchUrl String The matchUrl field returns the URL for the webpage that has been ranked for the particular keyword.

Add keywords for a location#

Name Field Type Description
id String The unique ID attached to the keyword
nameStringThe text value of the keyword

Archiving a keyword#

Name Field TypeDescription
id String The unique ID attached to the keyword
archivedBooleantrue if the keyword has been archived or false if it isn't.
nameString The text value of the keyword
Modified at 2025-03-27 06:02:01
Previous
Disconnect Location from Listing
Next
Add keywords
Built with