Postman Collection

The VisibilityIQ Postman collection covers all public API endpoints with pre-configured requests, example responses, and environment variables for your API key and project ID.

Importing the collection

1. Open Postman and click Import in the top navigation
2. Select Link and paste the collection URL:

   https://visibilityiq365.com/api/postman/collection.json

3. Import the VisibilityIQ environment alongside it (the environment file defines {{base_url}}, {{api_key}}, and {{project_id}} variables)

Or download both files from Developer settings → API Keys → Download Postman Collection in the dashboard.

Setting up your environment

After importing, configure the VisibilityIQ environment:

Variable	Value
base_url	https://visibilityiq365.com
api_key	Your vis_live_* API key
project_id	Your project ID from Project → Settings

Select the VisibilityIQ environment from the environment dropdown before making requests.

Included request groups

The collection is organized to match the documentation sections:

Projects

• List all projects
• Get project details

Audits

• Trigger new audit
• Get audit status
• List audit history

Issues / Findings

• List findings (with filters for severity, checkId, scope, status)
• Get finding detail with guidance payload
• Get findings by URL

Organic / Rank Tracking

• Get current keyword rankings
• Get position history
• Trigger manual sync

AI Visibility

• Get AI readiness summary
• List AI access findings

Connectors

• List connected connectors
• Get connector status and last sync time

Authentication

All requests in the collection use the {{api_key}} variable in an Authorization: Bearer {{api_key}} header, configured at the collection level. You don’t need to set this per-request.

Running a full audit cycle in Postman

The collection includes a saved request flow that demonstrates a complete audit cycle:

1. Trigger Audit — POST to start a crawl
2. Poll Audit Status — GET until status is completed (use Postman Monitors or manual polling)
3. Fetch Critical Findings — GET with severity=critical&status=new
4. Get Guidance for a Finding — GET a specific finding to see its full guidance payload

Each request in this flow has the previous response’s ID variables saved in test scripts so they chain automatically.

Generating code snippets

For any request in the collection, click Code in the sidebar to generate equivalent snippets in curl, Python requests, Node.js fetch, and other languages. This is the fastest way to get production-ready code for a specific endpoint.