Skip to Content
APIEndpointsList website hosts

List website hosts

Every host we have indexed pages for, with a page count each. Use the host values as the hosts filter on List website pages.

Useful on its own too: an unexpected subdomain in this list is usually either a staging site that should not be indexed, or a content property nobody remembered was in scope.

GET /v1/brands/{brand_id}/website/hosts

Authorization

HeaderTypeRequired
AuthorizationBearer asky_sk_…required

Path parameters

ParameterTypeRequiredDescription
brand_iduuidrequiredFrom List brands

Query parameters

ParameterTypeRequiredDescription
limitintegeroptionalRows per page, 1 to 100. Defaults to 20.
cursorstringoptionalOpaque cursor from the previous response. Treat it as a token, never construct one.

Request

curl --request GET \ --url 'https://api.askylabs.com/v1/brands/242546de-4cee-4a7d-952e-f6aa60c63ef8/website/hosts' \ --header 'Authorization: Bearer <api-key>'

Response

{ "data": [ { "host": "getasky.com", "page_count": 264 }, { "host": "docs.getasky.com", "page_count": 54 } ], "pagination": { "limit": 20, "has_more": true, "next_cursor": "eyJ2IjoxLCJvIjoyMCwibCI6MjB9" }, "request_id": "req_6ee0a3c81f7b4d29a5c0" }

Response fields

FieldTypeDescription
data.hostsobject[]required
data.hosts[].hoststringrequired. For example blog.getasky.com
data.hosts[].page_countintegerrequired
request_idstringrequired. Also returned as the x-request-id header. Quote it when contacting support

Errors

StatusCodeWhen
400invalid_requestA parameter is unknown or malformed. The message names it
401invalid_tokenThe key is missing, malformed, or does not exist
401token_expiredThe key passed its expiry date
401token_revokedThe key was revoked
404not_foundThe brand does not exist, or this key is not allowed to reach it. The two are deliberately indistinguishable
429rate_limitedOver 300 requests per minute. See the Retry-After header

Notes

Not paginated, and no count field — the array is the whole answer.

Last updated on