Skip to main content

Overview

This page documents the complete response structure for all BounceWatch API endpoints. Use this as a reference to understand exactly what data you’ll receive.
All responses include a success boolean and follow a consistent structure. The API uses a unified smart enrichment model — there is no separate cached vs realtime mode.

API Flow

1

Request a domain

Include your API key via X-API-Key header and a webhook URL via X-Webhook-URL header (or configure one in your API panel).
2

First request → 202 Accepted

New domain or data older than 24 hours: enrichment is queued. You receive a batch_id and tracking endpoints immediately.
3

Webhook delivers results

When enrichment completes (typically 2–10 min), we POST the results to your webhook URL with a data_url to fetch the full data.
4

Same domain within 24h → 200 OK

If you request the same domain again within 24 hours, cached data is returned instantly at no additional cost (0 credits).

Response Structures

The API returns two different response structures depending on whether the domain needs fresh enrichment or has recent data available.
Returned when a new enrichment is triggered. Results will be delivered via webhook.
A domain new to our index returns a slightly different 202: the module list is named requested_modules (not modules_requested), there is no current_data, and credits_remaining is included. success, batch_id, credits_reserved, status_endpoint and results_endpoint are present on both — key on those. See Company API.
Deprecation notice: If you pass mode=realtime, the request will still work but the response will include a deprecation_notice field. The mode=cached parameter returns 410 Gone. Remove the mode parameter entirely — it is no longer needed.

Webhook Payload

When enrichment completes, this payload is POSTed to your webhook URL:
Use data_url to fetch the full enrichment results with your API key. The webhook payload itself does not contain the enrichment data — only metadata and the URL to retrieve it.

Base Company Data (Always Included)

object
Base company information, always included with every request (10 credits).

Base Company Fields


Business Enrichment (+6 credits)

string
Add business to the enrich parameter: ?enrich=business

Business Fields


Technology Enrichment (+4 credits)

string
Add technology to the enrich parameter: ?enrich=technology

Technology Fields


Funding Enrichment (+10 credits)

string
Add funding to the enrich parameter: ?enrich=funding

Funding Fields


Team Enrichment (+6 credits)

string
Add team to the enrich parameter: ?enrich=team

Team Fields


Signals Enrichment (+16 credits)

string
Add signals to the enrich parameter: ?enrich=signals
Highlights are AI-detected signals from LinkedIn posts and news articles. Each highlight includes structured entities (partner names, product names, cities, etc.) extracted from the content.

Signals Fields

Signal Types

BounceWatch tracks various signal types across multiple categories. The type field in highlights indicates the signal category:
  • funding - New Funding Received, Grant Received, IPO Announced
  • business - Partnership Announced, Major Customer Win
  • recognition - Accepted to Program, Award Received, Certification Achieved
  • product - New Product Launched, New Feature Launched, Mobile App Launched
  • traction - Growth Metrics Shared, Revenue Metrics Shared, Website/LinkedIn Traffic Changes
  • expansion - Expansion Announced, New Office Opened
  • hiring - Key Hire Announced, Team Size Increased, Open Positions
  • team_change - Key Exit Announced
  • negative - Layoffs Announced, Shutdown Announced
  • milestone - Regulatory Approval
  • strategy - Pivot Announced
  • acquisition - Acquisition Announced, Acquisition Made
  • media - Featured on News
  • rumor - Acquisition Rumor, IPO Rumor, Partnership Talks, Expansion Plan, Layoff Rumor, Leadership Change Rumor
  • risk - Shutdown Risk
  • event - Event Participation

Competitors Enrichment (+8 credits)

string
Add competitors to the enrich parameter: ?enrich=competitors

Competitors Fields


Full Response Example

Here’s a complete example with all modules enabled:
The example above shows a first-time enrichment result fetched from the results_endpoint after webhook delivery. For deduplicated responses (same domain within 24h), credits_used will be 0 and the credits_breakdown will show all zeros with a note field.

Error Responses

All error responses include "success": false and a human-readable message. Most also include hint or suggestions to help you resolve the issue.

Error Code Reference

API Overview

Learn about authentication, rate limits, and API key management →