RankPilot API

Send an API key as a Bearer token. Every response carries data_through, coverage and rate-limit headers; limits are shared by every key of a workspace.

Properties

GET`/properties`

Properties this credential can read

Parameters of GET /properties
Name	In	Type	Required
limit	query	integer 1-1000	no
cursor	query	string	no

curl

curl -H "Authorization: Bearer $RANKPILOT_API_KEY" \
  "https://rank.hanzla.com/api/v1/properties"

Node

const res = await fetch("https://rank.hanzla.com/api/v1/properties", {
  headers: {
    Authorization: `Bearer ${process.env.RANKPILOT_API_KEY}`,
  },
});
console.log(await res.json());

POST`/properties`Write key, Pro

Put a discovered Search Console property on the dashboard

Parameters of POST /properties
Name	In	Type	Required
Idempotency-Key	header	string	no

curl

curl -X POST -H "Authorization: Bearer $RANKPILOT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"site_url":"<site_url>"}' \
  "https://rank.hanzla.com/api/v1/properties"

Node

const res = await fetch("https://rank.hanzla.com/api/v1/properties", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RANKPILOT_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"site_url":"<site_url>"}),
});
console.log(await res.json());

GET`/properties/{id}`

One property

Parameters of GET /properties/{id}
Name	In	Type	Required
id	path	string	yes

curl

curl -H "Authorization: Bearer $RANKPILOT_API_KEY" \
  "https://rank.hanzla.com/api/v1/properties/<property-id>"

Node

const res = await fetch("https://rank.hanzla.com/api/v1/properties/<property-id>", {
  headers: {
    Authorization: `Bearer ${process.env.RANKPILOT_API_KEY}`,
  },
});
console.log(await res.json());

PATCH`/properties/{id}`Write key, Pro

Rename a property

Parameters of PATCH /properties/{id}
Name	In	Type	Required
id	path	string	yes

curl

curl -X PATCH -H "Authorization: Bearer $RANKPILOT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"display_name":"<display_name>"}' \
  "https://rank.hanzla.com/api/v1/properties/<property-id>"

Node

const res = await fetch("https://rank.hanzla.com/api/v1/properties/<property-id>", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.RANKPILOT_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"display_name":"<display_name>"}),
});
console.log(await res.json());

GET`/properties/{id}/annotations`

Annotations of a property

Parameters of GET /properties/{id}/annotations
Name	In	Type	Required
id	path	string	yes
limit	query	integer 1-1000	no
cursor	query	string	no
from	query	string (date)	no
to	query	string (date)	no

curl

curl -H "Authorization: Bearer $RANKPILOT_API_KEY" \
  "https://rank.hanzla.com/api/v1/properties/<property-id>/annotations"

Node

const res = await fetch("https://rank.hanzla.com/api/v1/properties/<property-id>/annotations", {
  headers: {
    Authorization: `Bearer ${process.env.RANKPILOT_API_KEY}`,
  },
});
console.log(await res.json());

POST`/properties/{id}/annotations`Write key, Pro

Add an annotation

Parameters of POST /properties/{id}/annotations
Name	In	Type	Required
id	path	string	yes
Idempotency-Key	header	string	no

curl

curl -X POST -H "Authorization: Bearer $RANKPILOT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"date":"<date>","end_date":"<end_date>","title":"<title>","body":"<body>","category":"<category>"}' \
  "https://rank.hanzla.com/api/v1/properties/<property-id>/annotations"

Node

const res = await fetch("https://rank.hanzla.com/api/v1/properties/<property-id>/annotations", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RANKPILOT_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({"date":"<date>","end_date":"<end_date>","title":"<title>","body":"<body>","category":"<category>"}),
});
console.log(await res.json());

DELETE`/properties/{id}/annotations/{annotationId}`Write key, Pro

Delete an annotation

Parameters of DELETE /properties/{id}/annotations/{annotationId}
Name	In	Type	Required
id	path	string	yes
annotationId	path	string	yes

curl

curl -X DELETE -H "Authorization: Bearer $RANKPILOT_API_KEY" \
  "https://rank.hanzla.com/api/v1/properties/<property-id>/annotations/<annotationId>"

Node

const res = await fetch("https://rank.hanzla.com/api/v1/properties/<property-id>/annotations/<annotationId>", {
  method: "DELETE",
  headers: {
    Authorization: `Bearer ${process.env.RANKPILOT_API_KEY}`,
  },
});
console.log(await res.json());

POST`/properties/{id}/sync`Write key, Pro

Ask for a fresh Search Console pull (once per 15 minutes per property)

Parameters of POST /properties/{id}/sync
Name	In	Type	Required
id	path	string	yes

curl

curl -X POST -H "Authorization: Bearer $RANKPILOT_API_KEY" \
  "https://rank.hanzla.com/api/v1/properties/<property-id>/sync"

Node

const res = await fetch("https://rank.hanzla.com/api/v1/properties/<property-id>/sync", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.RANKPILOT_API_KEY}`,
  },
});
console.log(await res.json());