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

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-01-09T09:48:53.468Z",
  "completed_at": "2026-01-09T09:48:53.468Z",
  "running_time": "text",
  "links": [
    "text"
  ],
  "link_count": 1
}