GET v1/site/map

This endpoint retrieves information about previous site mapping requests, filterable by id or status

Get Sitemap

get

This endpoint retrieves sitemap requests in bulk by id or status.

Authorizations

API Key

X-API-KeystringRequired

Query parameters

idsstringOptional

The unique identifiers of the sitemap requests to retrieve.

Example: {"value":"smr_1234567890abcdef,smr_0987654321fedcba"}

statusstringOptional

The statuses of the sitemap requests to filter by. Valid values: pending, completed, failed

Example: {"value":"completed,pending"}

pageSizeinteger · int32Optional

Items to return per page (default: 30).

Example: {"value":30}

pageinteger · int32Optional

Page number of the pagination (default: 1).

Example: {"value":1}

Responses

200

A collection of sitemap requests that match the criteria

application/json

total_pagesinteger · int32 · nullableOptional

The total number of pages available

total_recordsinteger · int32 · nullableOptional

The total number of records across all pages

pageinteger · int32 · nullableOptional

The page number to return (1-based)

Default: 1

page_sizeinteger · int32 · nullableOptional

The number of records to return per page

Default: 30

400

Invalid query parameters

application/json

get

/v1/site/map

HTTPcURLJavaScriptPython

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

{"total_pages":0,"total_records":1,"results":[{"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:01:00+00:00","running_time":"00:01:00","links":["https://example.com/","https://example.com/about","https://example.com/products"],"link_count":3}],"page":1,"page_size":30}