POST /ranks/keywords

Add keyword

Track a new keyword. Requires `content:write`.

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.

Request body

Send as JSON in the request body.

Field	Type	Required
`keyword`	string	required
`country`	string	optional
`device_type`	`desktop` \| `mobile`	optional
`language`	string	optional
`target_url`	string	optional

Responses

200 Created

Field	Type	Description
`keyword`	Keyword

422 Invalid request parameters

Example request

curl --request POST \
  --url https://app.orchly.ai/api/v1/ranks/keywords \
  --header 'Authorization: Bearer obk_live_xxx' \
  --header 'X-Workspace-Id: ws_xxx' \
  --header 'Content-Type: application/json' \
  --data '{ "keyword": "..." }'

const res = await fetch(`https://app.orchly.ai/api/v1/ranks/keywords`, {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer obk_live_xxx',
    'X-Workspace-Id': 'ws_xxx',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"keyword":"..."}),
});
const data = await res.json();

import requests

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

Example response

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

{
  "keyword": {
    "id": "string",
    "keyword": "string",
    "country": "string",
    "device_type": "string",
    "language": "string",
    "target_url": "string",
    "is_active": true,
    "last_checked_at": "string"
  }
}