Indexing

Indexing

curl --request POST \
  --url https://api.example.com/indexing/jobs

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/indexing/jobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/indexing/jobs"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/indexing/jobs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

POST

indexing

jobs

Indexing

curl --request POST \
  --url https://api.example.com/indexing/jobs

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/indexing/jobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/indexing/jobs"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/indexing/jobs")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

Overview

The Indexing APIs let you:

Index Check: Check whether URLs are currently indexed in Google Search (via a dedicated Apify actor).
Index Submit: Notify Bing, Yandex, Seznam and Naver about new or updated URLs using the IndexNow protocol.

Each URL consumes 1 credit whether you are checking or submitting.

Index Submit does not notify Google. Google has never participated in IndexNow, and its own Indexing API officially covers only JobPosting and BroadcastEvent structured data — not general web pages. Use Index Check to monitor Google coverage, and Index Submit for the four IndexNow engines.

Setting up Index Submit

IndexNow has no accounts or OAuth. You prove you own a domain by hosting a key file at its root, and each submission quotes that key. This is a one-time setup per domain.

POST /indexing/indexnow/keys

{ "api_key": "gm_your_api_key_here", "domain": "example.com" }

The response contains a generated key and the exact key_location to upload it to.

Upload the key file

Create a file named <key>.txt containing exactly <key> and upload it to your site root, so it is reachable at https://example.com/<key>.txt.

Verify

POST /indexing/indexnow/keys/verify

{ "api_key": "gm_your_api_key_here", "domain": "example.com" }

We fetch the file and confirm it matches. Only verified domains can be submitted.

Re-registering a domain rotates its key and clears verification, so upload the new file before submitting again. GET /indexing/indexnow/keys lists your domains and their verification state; DELETE /indexing/indexnow/keys/{id} removes one.

The key file must be hosted on the domain it authorizes. A key_location pointing at a different host is rejected.

All endpoints live under the main API base URL:

https://api.gistmag.co.uk

You will need your GistMag API key from the Dashboard.

Create an indexing job

Use POST /indexing/jobs to create a new job with up to 10,000 URLs per request.

Request

POST /indexing/jobs HTTP/1.1
Host: api.gistmag.co.uk
Content-Type: application/json

{
  "api_key": "gm_your_api_key_here",
  "type": "check",
  "urls": [
    "https://www.example.co.uk/",
    "https://www.example.co.uk/about"
  ],
  "source": "web"
}

api_key (string, required): Your GistMag API key.
type (string, required): "check" or "submit".
- "check" – checks whether each URL appears in Google Search results.
- "submit" – notifies Bing, Yandex, Seznam and Naver via IndexNow.
urls (string[], required): List of full URLs. 1–10,000 items per job. For "submit", the 10,000 limit applies per domain, and every domain must be verified first.
source (string, optional): Source identifier ("web", "api", "extension", "wordpress", "shopify", "batch", "tts"). Defaults to "web" when omitted.

Response — `check`

Index Check runs in the background. Use the job_id to poll for results.

{
  "job_id": "7d3e4b40-3c8c-4c96-8e4d-abc123ef4567",
  "type": "check",
  "total_urls": 2,
  "status": "running"
}

Response — `submit`

IndexNow is fast and synchronous, so a submit job finishes inside the request and returns its results immediately:

{
  "job_id": "9c1f2a80-11bd-4f0e-9a7c-def456ab7890",
  "type": "submit",
  "total_urls": 2,
  "status": "complete",
  "submitted_count": 2,
  "failed_count": 0,
  "engines": ["Bing", "Yandex", "Seznam", "Naver"],
  "results": [
    {
      "host": "example.com",
      "urls": 2,
      "ok": true,
      "status_code": 200,
      "message": "URLs submitted successfully"
    }
  ]
}

A job spanning several domains is split into one IndexNow request per domain, each listed separately in results. If some domains succeed and others fail the job is still complete — check failed_count and the per-host message. Submitting a URL on an unverified domain returns 400 with the offending hosts, before any credits are charged:

{
  "error": "These domains are not verified for Index Submit",
  "unverified_hosts": ["example.com"],
  "details": "Register each domain via POST /indexing/indexnow/keys, upload the key file to its site root, then verify it."
}

List your indexing jobs

GET /indexing/jobs?api_key=gm_your_api_key_here&type=check&limit=20&offset=0

Response

[
  {
    "id": "7d3e4b40-3c8c-4c96-8e4d-abc123ef4567",
    "type": "check",
    "total_urls": 2,
    "processed_urls": 2,
    "indexed_count": 1,
    "submitted_count": null,
    "status": "complete",
    "error_message": null,
    "created_at": "2026-02-11T18:30:12.123Z"
  }
]

Get a single job

GET /indexing/jobs/{job_id}?api_key=gm_your_api_key_here

Returns the same IndexJob shape as in the list endpoint.

List URLs and results in a job

GET /indexing/jobs/{job_id}/urls?api_key=gm_your_api_key_here&limit=100&offset=0

Response (Index Check jobs)

[
  {
    "id": "c1f3c4b5-1234-4b4a-9ac0-bb27f2955d23",
    "url": "https://www.example.co.uk/",
    "status": "done",
    "is_indexed": true,
    "google_status": null,
    "raw_result": {
      "reason": "indexed",
      "proofUrl": "https://www.example.co.uk/"
    },
    "created_at": "2026-02-11T18:30:13.000Z",
    "updated_at": "2026-02-11T18:30:20.000Z"
  },
  {
    "id": "b2d3ff89-5678-4f7c-8080-cc09c67a11aa",
    "url": "https://www.example.co.uk/about",
    "status": "failed",
    "is_indexed": null,
    "google_status": null,
    "raw_result": {
      "reason": "rate_limited"
    },
    "created_at": "2026-02-11T18:30:13.000Z",
    "updated_at": "2026-02-11T18:30:25.000Z"
  }
]

status:
- "pending" / "processing" – not finished yet.
- "done" – we have a definitive answer.
- "failed" – something went wrong (for checks this is often rate limiting).
is_indexed:
- true – Google SERP contained a clear match for the URL.
- false – SERP loaded but no match found.
- null – unknown (e.g. rate-limited).
raw_result.reason:
- "indexed" – clear match found.
- "not_indexed" – no match found on SERP.
- "rate_limited" – Google blocked the check (429 / CAPTCHA / “unusual traffic”).
- "error" – other error.

In the GistMag dashboard, URLs with reason = “rate_limited” are shown as Rate limited so you can distinguish them from true “not indexed” results. You can re-run those URLs in a smaller batch later.

Export job as CSV

GET /indexing/jobs/{job_id}/export?api_key=gm_your_api_key_here

Returns a text/csv file with columns:

url
status
is_indexed
reason
google_status
created_at
updated_at

You can trigger this from the Dashboard or call the endpoint directly to download the CSV into your own tooling.

Overview

Alt Text Generation

Text-to-Speech

Blog Meta Generator

Site Audit

Management

Indexing

Overview

Setting up Index Submit

Create an indexing job

Request

Response — `check`

Response — `submit`

List your indexing jobs

Response

Get a single job

List URLs and results in a job

Response (Index Check jobs)

Export job as CSV

​Overview

​Setting up Index Submit

​Create an indexing job

​Request

​Response — check

​Response — submit

​List your indexing jobs

​Response

​Get a single job

​List URLs and results in a job

​Response (Index Check jobs)

​Export job as CSV

Overview

Setting up Index Submit

Create an indexing job

Request

Response — `check`

Response — `submit`

List your indexing jobs

Response

Get a single job

List URLs and results in a job

Response (Index Check jobs)

Export job as CSV