POST v1/site/map

This endpoint creates a new site mapping request and returns the result.

Create a new sitemap request

post

This endpoint processes a website's sitemap and returns all URLs found within it.

Authorizations

API Key

X-API-KeystringRequired

Body

application/json

urlstringOptional

The url you want our sitemap reader to process on your behalf

max_cache_ageinteger · int32 · nullableOptional

Maximum cache age in seconds for this request. If a cached result exists within this timeframe, it will be returned. Default is 0 (no cache).

Responses

200

The sitemap request response detailing the URLs found

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

408

The sitemap request timed out after 60 seconds

application/json

503

The requested site is unavailable

application/json

post

/v1/site/map

HTTPcURLJavaScriptPython

POST /v1/site/map HTTP/1.1
Host: api.gaffa.dev
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 55

"{\"url\":\"https://example.com\",\"max_cache_age\":0}"

Basic Sitemap RequestSitemap Request with Cache

{"id":"smr_1234567890abcdef","url":"https://example.com","state":"completed","credit_usage":1,"error":null,"error_reason":null,"from_cache":false,"started_at":"2024-01-01T12:00:00+00:00","completed_at":"2024-01-01T12:00:30+00:00","running_time":"00:00:30","links":["https://example.com/","https://example.com/about","https://example.com/products","https://example.com/contact"],"link_count":4}