Store Audit
Tools for the Store Audit module: audit runs, findings reports and run progress.list_store_audit_runs
Lists recent Store Audit runs with id, guid, integration, health score and completion time. Takes no parameters. Usually the first call — its ids and guids feed the two tools below.“List my store audit runs.”
get_store_audit_report
Gets the latest Store Audit findings report for one integration, including the health score and detailed findings.| Parameter | Type | Required | Description |
|---|---|---|---|
integrationId | integer | Yes | The integration to fetch the audit report for — find it via list_store_audit_runs |
“Show the audit findings report for integration 42.”
get_store_audit_status
Gets the status and progress of one Store Audit run — useful while an audit is still running.| Parameter | Type | Required | Description |
|---|---|---|---|
guid | string | Yes | The audit run guid from list_store_audit_runs |
“What’s the status of my latest store audit?”
Nerve Centre and KPIs
Tools for Nerve Centre: KPI cards and trends, alerts, monitors, dashboard activity and the connector graph.list_nerve_centre_alerts
Lists active Nerve Centre KPI alerts, optionally filtered by severity or status.| Parameter | Type | Required | Description |
|---|---|---|---|
severity | critical | high | medium | No | Filter by alert severity |
status | active | investigating | dismissed | No | Filter by alert status |
“List my critical Nerve Centre alerts.”
get_alert_summary
Gets a 24-hour alert and incident summary count for the organisation. Takes no parameters.“Give me the 24h incident summary.”
list_alert_activity
Lists paginated alert activity across the organisation, including agency partner organisations. Takes no parameters.“Show my recent alert activity.”
get_integration_kpis
Gets KPI cards plus trend data (today / 7 days / 30 days / 90 days) for one specific integration.| Parameter | Type | Required | Description |
|---|---|---|---|
integrationId | integer | Yes | The integration to fetch KPIs for — find it via list_dashboard_stores or list_store_audit_runs |
“Show the 30-day KPIs for my Shopify integration.”
list_kpi_library
Lists the full catalogue of KPI definitions Vortex IQ tracks across all platforms. Takes no parameters.“What KPIs does Vortex IQ track?“
get_nerve_integration_counts
Gets connected-integration counts for the organisation. Takes no parameters.“How many integrations do I have connected?“
list_nerve_centre_profiles
Lists saved Nerve Centre dashboard KPI profiles — both templates and the organisation’s custom profiles. Takes no parameters.“List my Nerve Centre dashboard profiles.”
list_nerve_configurations
Lists the metric and KPI definitions Vortex IQ can track per platform. Takes no parameters.“What metrics can Vortex IQ track for Stripe?“
list_connector_catalog
Lists the full catalogue of connector types Vortex IQ supports — the same catalogue as the connector catalogue page. Takes no parameters.“What connectors does Vortex IQ support?“
list_monitors_by_type
Lists the organisation’s monitors of a given platform type, with alert-configuration counts.| Parameter | Type | Required | Description |
|---|---|---|---|
type | string | Yes | Platform type, e.g. shopify, website, stripe |
“List my website monitors.”
get_dashboard_activity_feed
Gets a recent cross-source activity feed — audit findings, Kanban activity and other workspace events. Takes no parameters.“What’s happened in my workspace recently?“
list_dashboard_stores
Lists the stores available on the organisation’s dashboard. Takes no parameters.“List my connected stores.”
Brand DNA
Tools for Brand DNA: voice and tone profiles and the stores they link to.list_brand_profiles
Lists the organisation’s Brand DNA profiles. Takes no parameters. Its ids feedget_brand_profile.
“List my brand profiles.”
get_brand_profile
Gets one Brand DNA profile by id — voice, tone and brand guidelines, handy while drafting content elsewhere.| Parameter | Type | Required | Description |
|---|---|---|---|
profileId | integer | Yes | Brand profile id from list_brand_profiles |
“Show my Brand DNA voice and tone guidelines.”
list_brand_ecommerce_stores
Lists connected ecommerce stores eligible for Brand DNA profile linking. Takes no parameters.“Which stores can I link a brand profile to?”
Ask Viq
Tools for Ask Viq chat history.list_ask_viq_conversations
Lists your recent Ask Viq chat conversations, most recent first.| Parameter | Type | Required | Description |
|---|---|---|---|
limit | integer | No | Maximum conversations to return |
“List my recent Ask Viq conversations.”
get_ask_viq_conversation
Gets the full message thread for one Ask Viq conversation.| Parameter | Type | Required | Description |
|---|---|---|---|
conversationId | string | Yes | Conversation ID from list_ask_viq_conversations |
“Show me my last Ask Viq conversation about revenue.”
Kanban health-fix
Tools for the health-fix Kanban board and its automated fix runs.get_kanban_board
Gets the organisation’s Kanban board state — health-fix backlog cards per column. Takes no parameters.“Show my Kanban health-fix backlog.”
get_kanban_fix_status
Gets the plan, rollback and approval status of one automated fix run.| Parameter | Type | Required | Description |
|---|---|---|---|
fixId | integer | Yes | Fix run id from the Kanban board |
“What’s the status of fix run 17?“
get_kanban_fix_items
Gets the paginated before/after change records for one automated fix run.| Parameter | Type | Required | Description |
|---|---|---|---|
fixId | integer | Yes | Fix run id from the Kanban board |
“Show the before/after changes for fix run 17.”
Reports and Insights
Tools for generated insight reports, report configuration and schedules.list_insights_reports
Lists generated insight reports (status, platform, title) for a given user. The API requires an explicit user id — if Claude doesn’t know it, it reads theuser_id field from list_ask_viq_conversations first.
| Parameter | Type | Required | Description |
|---|---|---|---|
userId | integer | Yes | Vortex IQ user id to list reports for |
“List my insights reports.”
list_report_profiles
Lists saved report configuration profiles. Takes no parameters.“List my report profiles.”
list_report_schedules
Lists recurring report schedules with their status. Takes no parameters.“Which reports are scheduled to run?”
Inventory and Memory
Tools for CloudHub multichannel inventory and the Vortex Memory archive.list_cloudhub_inventory_tabs
Lists CloudHub multichannel inventory tabs — marketplace channels like FBA, inventory images and so on. Takes no parameters.“List my CloudHub inventory tabs.”
list_vortex_memory_files
Lists files in Vortex Memory’s Knowledge Base — uploaded documents plus auto-saved reports. Takes no parameters.“What’s in my Vortex Memory knowledge base?“
list_vortex_memory_reports
Lists archived Vortex Mind reports — daily briefings, audits and revenue intelligence reports. Takes no parameters.“List my archived Vortex Mind reports.”
Deployments
get_deployment_history
Gets a deployment’s revision and rollback history.| Parameter | Type | Required | Description |
|---|---|---|---|
deploymentId | integer | Yes | Deployment id |
“Show the rollback history for deployment 8.”