# Rankings Analytics Attributes

Source: https://developer.synup.com/rankings/attributes

## 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 Type** | **Description** |
|----------|----------------|-----------------|
| `id` | String | The unique ID attached to the keyword |
| `name` | String | The text value of the keyword eg: pizza near me |

###  Get performance of all keywords for location

| **Name** | **Field Type** | **Description** |
|----------|----------------|-----------------|
| `id` | String | The unique ID attached to the keyword |
| name | String | The text value of the keyword |
| [`sites`](#sites-object-fields) | Object | An object containing the `name` of the site and the [`rankings`](#rankings-object-fields) object for it |

#### `sites` object fields

| **Name** | **Field Type** | **Description** |
|----------|----------------|-----------------|
| name | String | The 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 |
| rankedAt | Datetime | 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 |
| name | String | The text value of the keyword |

### Archiving a keyword

| **Name** | **Field Type** | **Description** |
|----------|----------------|-----------------|
| id | String | The unique ID attached to the keyword |
| archived | Boolean | `true` if the keyword has been archived or `false` if it isn't.
| name | String | The text value of the keyword |