GET /ranks/keywords

List tracked keywords

The keywords tracked in the rank tracker.

Authenticate with Authorization: Bearer obk_live_xxx. See authentication.

Parameters

Name	In	Type	Required	Description
`X-Workspace-Id`	header	string	required	The workspace to scope the request to. Can also be passed as a `workspace_id` query parameter.
`limit`	query	integer	optional	Maximum number of items to return.

Responses

200 OK

Field	Type	Description
`workspace_id`	string
`keywords`	Keyword[]

Example request

curl --request GET \
  --url https://app.orchly.ai/api/v1/ranks/keywords \
  --header 'Authorization: Bearer obk_live_xxx' \
  --header 'X-Workspace-Id: ws_xxx'

const res = await fetch(`https://app.orchly.ai/api/v1/ranks/keywords`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer obk_live_xxx',
    'X-Workspace-Id': 'ws_xxx',
  },
});
const data = await res.json();

import requests

resp = requests.get(
    "https://app.orchly.ai/api/v1/ranks/keywords",
    headers={
        "Authorization": "Bearer obk_live_xxx",
        "X-Workspace-Id": "ws_xxx",
    },
)
data = resp.json()

Example response

A 200 response. Dynamic fields are shown as their type.

{
  "workspace_id": "string",
  "keywords": [
    {
      "id": "string",
      "keyword": "string",
      "country": "string",
      "device_type": "string",
      "language": "string",
      "target_url": "string",
      "is_active": true,
      "last_checked_at": "string"
    }
  ]
}