Route Endpoint
This endpoint is responsible for anything related to Routes.
Endpoint /v1/route
- [ GET ] – Retrieve specific routes by route id(s)
- [ POST ] – Create a route (single URL) or batch of routes (multiple URLs)
- [ PATCH ] – Modify an existing route
Endpoint /v1/route/batch
- [ GET ] – Retrieve a batch of routes
- [ PATCH ] – Modify an existing batch
Request Headers
| Field | Value Type | Description |
|---|---|---|
| Content-Type | string | (required) application/json |
| Accept | string | (required) application/json |
| X-WhereGoes-Access-Token | string | (required) An active API access token. |
Follow A Single URL
POST
/v1/route
Example with a curl request:
curl --location 'https://api.wheregoes.com/v1/route' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'X-WhereGoes-Access-Token: {API-Access-Token}' \
--data '{
"optional_fields_route":[],
"follow": [
{
"url":"https://wheregoes.com/tests/js-redirect-1.php",
"bot_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36"
}
]
}'Body Format
The body (data) is in a JSON format.
| Field | Value Type | Description |
|---|---|---|
| optional_fields_batch | array | (optional) – If no fields are defined, then all top-level fields of a batch will be returned. If any fields are defined, then those fields and the minimum required fields will appear in the response. Set value to ‘none’ to remove all optional fields from the batch. |
| optional_fields_route | array | (optional) – If no fields are defined, then all top-level fields of a route will be returned. If any fields are defined, then those fields and the minimum required fields will appear in the route. Set value to ‘none’ to remove all optional fields from the route. |
| optional_fields_response | array | (optional) – If no fields are defined, then all top-level fields of a response will be returned. If any fields are defined, then those fields and the minimum required fields will appear in the response. Set value to ‘none’ to remove all optional fields from the response. |
| follow | array | (optional) Status that controls the viewing of the results URL: NULL (private), public, password |
| visibility | null | string | (optional) Status that controls the viewing of the results url: NULL (private), public, password |
| visibility_password | null | string | (optional) Sets the temporary password used to protect from viewing on the web (not via API). Visibility must be set to password. |
| visibility_date_expires | null | string | (optional) The date (UTC) at which the password or public access gets changed back to private. If set to NULL, then no expiration. NULL or YYYY-MM-DD 00:00:00 |
| webhook_url | string | (optional) The webhook will receive the response if provided. Only available for creating batch route requests. |
POST
/v1/follow
Example body format:
{
"optional_fields_route":['none'],
"follow": [
{
"url":"https://wheregoes.com/tests/js-redirect-1.php",
"bot_agent":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/116.0.0.0 Safari/537.36"
}
],
"visibility": "password",
"visibility_password": "testPassword",
"visibility_date_expires": "2020-10-01 12:00:00"
}Follow Multiple URLs (Batch Requests)
Please note that the batch endpoint accepts up to 100 URLs per API call and up to 10 MB payload size.
curl --location 'https://api.wheregoes.com/v1/route' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'X-WhereGoes-Access-Token: {API-Access-Token}' \
--data '{
"optional_fields_route":[],
"follow": [
{
"url":"https://wheregoes.com/tests/js-redirect-1.php",
"bot_agent":"Test USer Agent 1"
},
{
"url":"https://wheregoes.com/tests/js-redirect-2.php",
"bot_agent":"Test User Agent 2"
}
]
}'