Re-rank a tracked keyword now instead of waiting for the next scheduled run (paid plans).

POSThttps://api.appgoat.ai/v1/tracked-keywords/{id}/run

1+ credits1 when queued, 0 when the last hour's ranking is returnedoperationId runTrackedKeyword

If it was ranked within the last hour you get that ranking back (200, queued:false, free) instead.

Request

curl -X POST "https://api.appgoat.ai/v1/tracked-keywords/123/run" \
  -H "x-api-key: $APPGOAT_API_KEY"

const res = await fetch("https://api.appgoat.ai/v1/tracked-keywords/123/run", {
  method: 'POST',
  headers: {
    "x-api-key": process.env.APPGOAT_API_KEY,
  },
});
const { data, meta } = await res.json();

import os, requests

res = requests.post(
    "https://api.appgoat.ai/v1/tracked-keywords/123/run",
    headers={"x-api-key": os.environ["APPGOAT_API_KEY"]}
)
body = res.json()

Path parameters

idintegerrequired

Response

200 with a JSON body. See the envelope for meta.

Example

{
  "data": null,
  "meta": {
    "credits_used": 1,
    "credits_remaining": 9981,
    "request_id": "req_123"
  }
}

Status codes

200

Ranked recently; the latest ranking.

202

Queued.

401invalid_api_key

Missing or invalid API key.

402insufficient_creditsplan_limit

insufficient_credits (the call costs more than you have left; nothing was done) or plan_limit (a feature of a higher plan).

404not_found

Not found.

429rate_limited

Too many requests per second for your plan.