Get Rankings Distribution By Time

This API provides the weekly distribution of keyword rankings across four predefined rank buckets (1-3, 3-10, 10-20, 20-50) for each site. It returns the number of keywords falling within each rank range on specific dates for these sites. This helps track keyword performance trends over a time period.

post/locations/ranking-sitewise-histogram

Request

Base URL
https://api.synup.com/api/v4
Auth
none required
TypeScript
https://skmtc.dev/synup/apis/synup-api/docs/locations/ranking-sitewise-histogram/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

Authorizationstring required

API key for authentication

Request body

fromDatestring date required

Date from where data has to be fetched

toDatestring date required

Date till where data has to be fetched

locationIdsstring[] required

IDs to fetch data

sourcestring[] required

List of sources

Example request

{
  "fromDate": "2023-03-11",
  "toDate": "2023-03-15",
  "locationIds": [
    "TG9jYXRpb246NzkwODQ="
  ],
  "source": [
    "Google"
  ]
}

Response

Successful response

Example response

{
  "data": {
    "rankingsRollupByKeywordCount": [
      {
        "site": "Google",
        "keywordCountByBucket": [
          {
            "rankRange": "rank_from_1_to_3",
            "dailyKeywordCount": [
              {
                "rankDate": "2023-03-06"
              }
            ]
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.