Market Intelligence API
Generated from
products/market-intelligence/services/api/docs/openapi.yaml. Runnpm run docs:generateto refresh.
|
| Field | Value |
|---|---|
| Version | 0.1.0 |
Servers
http://localhost:3100— Local developmenthttp://market-intelligence-api:4003— Docker Compose network
Endpoints (46)
| Method | Path | Summary |
|---|---|---|
GET | / | Service info |
GET | /health | Root health check |
GET | /api/v1/health | API health check |
GET | /api/v1/queues/stats | All queue statistics |
POST | /api/v1/market-intelligence/scan | Start geographic scan |
GET | /api/v1/market-intelligence/scan/stats | Discovery queue statistics |
GET | /api/v1/market-intelligence/scan/{jobId} | Get scan job status |
GET | /api/v1/market-intelligence/areas | List geographic areas |
GET | /api/v1/market-intelligence/areas/{areaId} | Get geographic area |
GET | /api/v1/market-intelligence/areas/{areaId}/businesses | List businesses in area |
GET | /api/v1/market-intelligence/businesses | List businesses |
GET | /api/v1/market-intelligence/businesses/{id} | Get business |
POST | /api/v1/market-intelligence/businesses/{id}/enrich | Enrich business |
POST | /api/v1/market-intelligence/businesses/bulk-enrich | Bulk enrich businesses |
PATCH | /api/v1/market-intelligence/businesses/{id}/status | Update business status |
GET | /api/v1/market-intelligence/opportunities | List opportunities |
GET | /api/v1/market-intelligence/opportunities/pipeline | Pipeline statistics |
GET | /api/v1/market-intelligence/opportunities/queue/stats | Analysis & pitch queue statistics |
GET | /api/v1/market-intelligence/opportunities/{id} | Get opportunity |
PATCH | /api/v1/market-intelligence/opportunities/{id}/status | Update opportunity status |
POST | /api/v1/market-intelligence/opportunities/businesses/{id}/analyze | Analyze business |
POST | /api/v1/market-intelligence/opportunities/businesses/bulk-analyze | Bulk analyze businesses |
GET | /api/v1/market-intelligence/opportunities/{id}/pitches | List pitches |
POST | /api/v1/market-intelligence/opportunities/{id}/pitches | Generate pitches |
GET | /api/v1/market-intelligence/opportunities/{id}/roi | Get ROI estimate |
GET | /api/v1/market-intelligence/opportunities/{id}/roi/history | ROI estimate history |
POST | /api/v1/market-intelligence/opportunities/{id}/sync-to-crm | Sync to CRM |
POST | /api/v1/customers | Create customer |
GET | /api/v1/customers | List customers |
GET | /api/v1/customers/at-risk | At-risk customers |
GET | /api/v1/customers/expansion-opportunities | Expansion opportunities |
GET | /api/v1/customers/queue/stats | Customer queue statistics |
GET | /api/v1/customers/{id} | Get customer |
PATCH | /api/v1/customers/{id} | Update customer |
GET | /api/v1/customers/{id}/health | Get health score |
POST | /api/v1/customers/{id}/health-check | Queue health check |
GET | /api/v1/customers/{id}/onboarding | Get onboarding status |
POST | /api/v1/customers/{id}/onboarding | Create onboarding checklist |
PATCH | /api/v1/customers/{id}/onboarding/steps/{stepId} | Update onboarding step |
POST | /api/v1/customers/{id}/migrations | Create migration |
GET | /api/v1/customers/{id}/migrations/{migrationId} | Get migration status |
POST | /api/v1/customers/{id}/migrations/{migrationId}/execute | Execute migration |
POST | /api/v1/customers/{id}/activities | Log activity |
GET | /api/v1/customers/{id}/activities | List activities |
GET | /api/v1/customers/{id}/sla | Get SLA report |
POST | /api/v1/customers/{id}/sla | Record SLA metrics |
GET /
Service info
Returns service name, version, and available endpoint groups.
Operation ID: getServiceInfo
GET /health
Root health check
Docker HEALTHCHECK / load balancer endpoint. Returns database connectivity status.
Operation ID: rootHealthCheck
GET /api/v1/health
API health check
Returns service health status with version info.
Operation ID: apiHealthCheck
GET /api/v1/queues/stats
All queue statistics
Returns BullMQ queue statistics for all worker queues.
Operation ID: getAllQueueStats
POST /api/v1/market-intelligence/scan
Start geographic scan
|
Operation ID: startScan
GET /api/v1/market-intelligence/scan/stats
Discovery queue statistics
Returns BullMQ queue stats for the discovery worker.
Operation ID: getScanStats
GET /api/v1/market-intelligence/scan/{jobId}
Get scan job status
Poll for the status of a previously queued scan job.
Operation ID: getScanJobStatus
GET /api/v1/market-intelligence/areas
List geographic areas
List scanned geographic areas for an organization with optional filters.
Operation ID: listAreas
GET /api/v1/market-intelligence/areas/{areaId}
Get geographic area
Retrieve a specific geographic area by ID.
Operation ID: getArea
GET /api/v1/market-intelligence/areas/{areaId}/businesses
List businesses in area
List all discovered businesses within a specific geographic area.
Operation ID: listBusinessesInArea
GET /api/v1/market-intelligence/businesses
List businesses
List discovered businesses for an organization with optional filters.
Operation ID: listBusinesses
GET /api/v1/market-intelligence/businesses/{id}
Get business
Retrieve a specific discovered business by ID.
Operation ID: getBusiness
POST /api/v1/market-intelligence/businesses/{id}/enrich
Enrich business
|
Operation ID: enrichBusiness
POST /api/v1/market-intelligence/businesses/bulk-enrich
Bulk enrich businesses
Queue enrichment jobs for up to 1000 businesses at once.
Operation ID: bulkEnrichBusinesses
PATCH /api/v1/market-intelligence/businesses/{id}/status
Update business status
Transition a business through the sales pipeline status.
Operation ID: updateBusinessStatus
GET /api/v1/market-intelligence/opportunities
List opportunities
List AI-identified opportunities with optional filters.
Operation ID: listOpportunities
GET /api/v1/market-intelligence/opportunities/pipeline
Pipeline statistics
Get aggregated opportunity pipeline value and counts grouped by status.
Operation ID: getOpportunityPipeline
GET /api/v1/market-intelligence/opportunities/queue/stats
Analysis & pitch queue statistics
Returns BullMQ queue stats for the analysis and pitch generation workers.
Operation ID: getOpportunityQueueStats
GET /api/v1/market-intelligence/opportunities/{id}
Get opportunity
Retrieve a specific AI opportunity by ID.
Operation ID: getOpportunity
PATCH /api/v1/market-intelligence/opportunities/{id}/status
Update opportunity status
Transition an opportunity through the sales pipeline.
Operation ID: updateOpportunityStatus
POST /api/v1/market-intelligence/opportunities/businesses/{id}/analyze
Analyze business
|
Operation ID: analyzeBusiness
POST /api/v1/market-intelligence/opportunities/businesses/bulk-analyze
Bulk analyze businesses
Queue AI analysis jobs for up to 500 businesses at once.
Operation ID: bulkAnalyzeBusinesses
GET /api/v1/market-intelligence/opportunities/{id}/pitches
List pitches
Get generated pitches for an opportunity, with optional filters.
Operation ID: listPitches
POST /api/v1/market-intelligence/opportunities/{id}/pitches
Generate pitches
|
Operation ID: generatePitches
GET /api/v1/market-intelligence/opportunities/{id}/roi
Get ROI estimate
|
Operation ID: getROIEstimate
GET /api/v1/market-intelligence/opportunities/{id}/roi/history
ROI estimate history
Get all versioned ROI estimates for an opportunity.
Operation ID: getROIHistory
POST /api/v1/market-intelligence/opportunities/{id}/sync-to-crm
Sync to CRM
|
Operation ID: syncOpportunityToCRM
POST /api/v1/customers
Create customer
Create a new customer account, optionally linked to an opportunity and business.
Operation ID: createCustomer
GET /api/v1/customers
List customers
List customer accounts for an organization with optional filters.
Operation ID: listCustomers
GET /api/v1/customers/at-risk
At-risk customers
Identify customers at risk of churn based on health score, engagement, and support patterns.
Operation ID: getAtRiskCustomers
GET /api/v1/customers/expansion-opportunities
Expansion opportunities
Identify customers with high expansion potential based on usage and health.
Operation ID: getExpansionOpportunities
GET /api/v1/customers/queue/stats
Customer queue statistics
Returns BullMQ queue stats for migration and health check workers.
Operation ID: getCustomerQueueStats
GET /api/v1/customers/{id}
Get customer
Retrieve a specific customer account by ID.
Operation ID: getCustomer
PATCH /api/v1/customers/{id}
Update customer
Update customer lifecycle stage.
Operation ID: updateCustomer
GET /api/v1/customers/{id}/health
Get health score
Calculate and return the current health score for a customer.
Operation ID: getCustomerHealth
POST /api/v1/customers/{id}/health-check
Queue health check
Queue a background health check job for a customer.
Operation ID: queueHealthCheck
GET /api/v1/customers/{id}/onboarding
Get onboarding status
Get the current onboarding checklist and progress for a customer.
Operation ID: getOnboardingStatus
POST /api/v1/customers/{id}/onboarding
Create onboarding checklist
|
Operation ID: createOnboardingChecklist
PATCH /api/v1/customers/{id}/onboarding/steps/{stepId}
Update onboarding step
Update the status or notes on a specific onboarding step.
Operation ID: updateOnboardingStep
POST /api/v1/customers/{id}/migrations
Create migration
Create a data migration plan for a customer.
Operation ID: createMigration
GET /api/v1/customers/{id}/migrations/{migrationId}
Get migration status
Get the current status and progress of a data migration.
Operation ID: getMigrationStatus
POST /api/v1/customers/{id}/migrations/{migrationId}/execute
Execute migration
Queue the execution of a planned data migration.
Operation ID: executeMigration
POST /api/v1/customers/{id}/activities
Log activity
Record a customer success activity (health check, QBR, training, etc.).
Operation ID: logCustomerActivity
GET /api/v1/customers/{id}/activities
List activities
Get activity history for a customer.
Operation ID: listCustomerActivities
GET /api/v1/customers/{id}/sla
Get SLA report
|
Operation ID: getSLAReport
POST /api/v1/customers/{id}/sla
Record SLA metrics
Record SLA metrics for a specific monthly period.
Operation ID: recordSLAMetrics