SYsynup
Rankings

Get keywords performance

This API retrieves the ranking performance of all keywords associated with a specific location.

get/locations/{locationId}/keywords-performance

Request

Path parameters

locationIdstring required
Example:TG9jYXRpb246OTUzMTUw

Location ID

Query parameters

fromDatestring date
Example:2025-02-01

Start date to fetch rankings from (YYYY-MM-DD)

toDatestring date
Example:2025-02-07

End date to fetch rankings until (YYYY-MM-DD)

Headers

Authorizationstring required

API key for authentication

Response

Successful response

Example response

{
  "data": {
    "keywordsByLocationId": [
      {
        "id": "S2V5d29yZDoxODQ1OTY4",
        "databaseId": "1845968",
        "name": "local business",
        "sites": [
          {
            "name": "Google",
            "rankings": [
              {
                "rank": 5,
                "rankedAt": "2025-02-04T03:28:57.931518",
                "matchType": "location_url",
                "matchUrl": "https://example.com/location"
              }
            ]
          }
        ]
      }
    ]
  }
}

Changes

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