Read keywords

GET /keywords/. Required scopes: keywords:read.

GET /api/public/v1/keywords/{resource_id}

Read keywords

cURL

curl --request GET \
  --url https://wisepim.com/api/public/v1/keywords/{resource_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "term": "<string>",
  "intent": "<string>",
  "kw_type": "<string>",
  "locale": "<string>",
  "target_fields": "<unknown>",
  "priority": 123,
  "notes": "<string>",
  "categories": [
    123
  ],
  "id": 123
}

Authorizations

Authorization · string · header · required

Use a project API key from Settings > API Access. Send it as Authorization: Bearer wpk_.... See authentication and scopes for setup and permissions.

Path Parameters

resource_id · integer · required

Response

200

application/json

OK

term · string · required

Maximum string length: 255

intent · string · required

Classified search intent (from GSC query analysis).

Maximum string length: 16

kw_type · string · required

Positive = a term to target/include. Negative = a term to AVOID in generated content.

Maximum string length: 16

locale · string · required

Locale code this keyword applies to (e.g. 'nl', 'en-US'). Empty = applies to all locales.

Maximum string length: 16

target_fields · any · required

Subset of content fields this keyword applies to (title/description/short_description/seo_meta/attributes). Empty list = applies to all fields.

priority · integer · required

Relative importance; higher sorts first and weighs more.

notes · string · required

categories · integer[] · required

If set, the keyword only applies to products in any of these categories. Empty = applies to every product.

id · integer · required