POSTapi.synup.com/api/v4/locations/ranking-analytics-timeline

Get Rollup Keyword Performance

This API allows you to fetch ranking analytics data for multiple locations in your account within a single API call for a specific period. You can also specify the sources you want to filter the results for. The sources include Google maps and Google search.

Requires an API key. Send it as Authorization: API <your-key> — see Getting started.

Parameters

Body

Name	Type	Required	Description
`fromDate`	string	required	Date from where data has to be fetched
`toDate`	string	required	Date till where data has to be fetched
`locationIds`	array of string	required	IDs to fetch data
`source`	array of string	required	List of sources

Request

curl -X POST 'https://api.synup.com/api/v4/locations/ranking-analytics-timeline' \
  -H 'Authorization: API YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '""'

const res = await fetch('https://api.synup.com/api/v4/locations/ranking-analytics-timeline', {
  method: 'POST',
  headers: {
    Authorization: 'API YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(""),
});
const data = await res.json();

import requests
res = requests.post(
    "https://api.synup.com/api/v4/locations/ranking-analytics-timeline",
    headers={
        "Authorization": "API YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json="",
)
data = res.json()

req, _ := http.NewRequest("POST", "https://api.synup.com/api/v4/locations/ranking-analytics-timeline", bytes.NewBufferString(payload))
req.Header.Set("Authorization", "API YOUR_API_KEY")
req.Header.Set("Content-Type", "application/json")

res, err := http.DefaultClient.Do(req)

Responses

Status	Description
`200`	Successful response
`400`	Bad Request
`401`	Unauthorized

Example response (generated from the schema)

{
  "data": {
    "rankingsRollupByDate": [
      {
        "siteAverageRanking": [
          {
            "site": "Google",
            "averageRankings": [
              null
            ]
          }
        ]
      }
    ]
  }
}

Response body

Name	Type	Required	Description
`data`	object	optional
`data.rankingsRollupByDate`	array of object	optional
`data.rankingsRollupByDate[].siteAverageRanking`	array of object	optional
`data.rankingsRollupByDate[].siteAverageRanking[].site`	string	optional	Source of rankings `GoogleBingYahooGoogle Maps`
`data.rankingsRollupByDate[].siteAverageRanking[].averageRankings`	array of object	optional
`data.rankingsRollupByDate[].siteAverageRanking[].averageRankings[].date`	string	optional	Specific date
`data.rankingsRollupByDate[].siteAverageRanking[].averageRankings[].averageRank`	integer	optional	The value for the date