---
title: "Get keywords performance"
method: GET
path: "/locations/{locationId}/keywords-performance"
tags: ["Rankings"]
---

# Get keywords performance

`GET /locations/{locationId}/keywords-performance`

## Request

- Base URL: `https://api.synup.com/api/v4`
- URL: `https://api.synup.com/api/v4/locations/{locationId}/keywords-performance`
- Auth: none required
- TypeScript: <https://skmtc.dev/synup/apis/synup-api/docs/locations/:locationId/keywords-performance/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `locationId` string, required

## Query parameters

- `fromDate` string, date
- `toDate` string, date

## Headers

- `Authorization` string, required

## Response `200`

Successful response

- object
  - `data` object
    - `keywordsByLocationId` object[]
      - `id` string
      - `databaseId` string
      - `name` string
      - `sites` object[]
        - `name` 'Google' | 'Yahoo' | 'Google Maps' | 'Bing'
        - `rankings` object[]
          - `rank` integer
          - `rankedAt` string, date-time
          - `matchType` string, nullable
          - `matchUrl` string, nullable

## Other responses

- `401`: Unauthorized

---

[API](https://skmtc.dev/synup/apis/synup-api.md) - [All operations](https://skmtc.dev/synup/apis/synup-api/llms.txt) - [OpenAPI document](https://skmtc.dev/synup/apis/synup-api/revisions/67de2d51c22e?raw)