Keyword tracking setup of a shop

GET /keyword-tracking

Returns the Google Maps keyword tracking setup of a shop: whether the subscription is enabled, the tracked keywords, and the scanned geo points (center and extra points). Call this first to know which keywords can be queried on /keyword-rankings/summary and /keyword-rankings/trend.

Requires the keyword_tracking:read scope.

Returns a single configuration object. keywords and points are empty when tracking has never been configured for the shop, and enabled is false when the subscription is off; in both cases the ranking endpoints answer a 404 problem.

Example request

curl "https://api.dokaa.app/v1/keyword-tracking?shop_id=SHOP_ID" \
  -H "Authorization: Bearer dk_live_..."

Query parameters

• shop_id (string, required) – The shop to inspect

Responses

200 – Keyword tracking setup

{
  "enabled": true,
  "keywords": [
    "pizza lille",
    "restaurant italien lille"
  ],
  "center": {
    "lat": 50.6365,
    "lng": 3.0635,
    "radius": 1000
  },
  "points": [
    {
      "lat": 50.641,
      "lng": 3.058,
      "radius": null
    }
  ]
}

401 – Missing, invalid, or revoked API key

403 – The API key does not grant access to this resource

422 – Invalid request parameters

Errors are application/problem+json (RFC 9457) with type, title, status and detail fields.