GET v1/site/map/{id}

This endpoint retrieves information about a site mapping request.

Get a sitemap request by ID

get

This endpoint retrieves a sitemap request by its ID.

Authorizations

API Key

X-API-KeystringRequired

Path parameters

idstringRequired

The unique identifier of the sitemap request to retrieve.

Responses

200

The sitemap request

application/json

idstring · nullableOptional

ID of the sitemap request

urlstring · nullableOptional

URL of the request

statestring · nullableOptional

The status of the request

credit_usageinteger · int32 · nullableOptional

The number of credits used by the request

errorstring · nullableOptional

The name of the error type

error_reasonstring · nullableOptional

More detail about the error

from_cacheboolean · nullableOptional

If this request was served from the cache

started_atstring · date-timeOptional

The time in UTC when the request started.

completed_atstring · date-timeOptional

The time in UTC when the request finished.

running_timestring · timespanOptional

The running time of the request

linksstring[] · nullableOptional

List of URLs found in the sitemap

link_countinteger · int32 · nullableOptional

Number of links found

404

Sitemap request not found

application/json

get

/v1/site/map/{id}

HTTPcURLJavaScriptPython

GET /v1/site/map/{id} HTTP/1.1
Host: api.gaffa.dev
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "url": "text",
  "state": "text",
  "credit_usage": 1,
  "error": "text",
  "error_reason": "text",
  "from_cache": true,
  "started_at": "2026-02-23T19:28:24.613Z",
  "completed_at": "2026-02-23T19:28:24.613Z",
  "running_time": "text",
  "links": [
    "text"
  ],
  "link_count": 1
}