Summary
This API request returns a list of all the Active tours on a specific URL when you provide that URL as input.
Resource Information
Request Type: GET
Response Format: JSON
Headers
- useriq-api-key (required): Your valid API key generated from the Site settings page
Parameters
- url – The encoded URL of the page you want to check for Active tours existing on that page.
Example cURL Request:
HTTP
curl \
-H "Content-type: application/json" \
-H "useriq-api-key: 572d7372829a3211a73d9c2cb790ffe3" \
https://api.useriq.com/api/1.0/campaign/retrieve_tours_from_url?url=https%3A%2F%2Fapp.useriq.com%2F%23!%2Fhome
Example Result
{
"results":[{ ... }, ...]
}
Response Codes
200: OK. Request processed successfully
400: Bad Request. API request could not be understood by the server.
401: Unauthorized. Invalid API access token.
Comments
0 comments
Please sign in to leave a comment.