> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Monitor Contract Reference

> Generated factual monitor reference derived from executable provider monitor capability contracts.

# Monitor Contract Reference

This factual reference is generated from the same monitor capability contracts used by validation and the live `tools get` / `monitors available` surfaces. Keep rationale and workflows in hand-written guides.

## Shared lifecycle

* monitors check validates a definition locally and does not deploy, spend credits, or prove a future event will arrive.
* monitors deploy is a full desired definition. Use deploy --dry-run to inspect provider and Deepline-credit effects; use monitors update for a patch.
* monitors get returns the stored deployed definition plus monitor\_spec, whose fields list the deployable payload paths, descriptions, constraints, and provider-specific semantics for that monitor type.

## Shared errors

* Validation errors name the payload path and expected contract value; correct the definition and rerun monitors check.
* A paused monitor needs a balance or entitlement correction before reactivation. Deepline exposes Deepline pricing only.

## `rb2b.visitor_events`

Ingest RB2B identified-visitor webhook events after you add the Deepline endpoint in RB2B.

### Executable examples

#### Website visitors

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "key": "rb2b-website-visitors",
  "tool": "rb2b.visitor_events",
  "payload": {}
}
```

### Outputs

| Stream | Database table | Meaning |
| - | - | - |
| `events` | `rb2b.visitor_events` | RB2B identified visitor webhook events delivered to Deepline. |

#### Pricing, identity, and updates

* Pricing: Use the Deepline pricing returned by describe, monitors available, check, or deploy --dry-run. Provider spend is not exposed.
* Identity: This monitor uses the provider capability identity declared by Deepline.
* Update: Use monitors update for a patch or deploy for a complete desired definition.
* Backfill: Existing Database rows are retained; this capability does not promise provider backfill unless its provider documentation says otherwise.

#### Troubleshooting

* **Validation failed:** Correct the reported payload path, then run monitors check again.

## `deepline.analytics`

Capture signed, session-based Radar website activity from the Deepline Analytics tracker.

### Executable examples

#### Website sessions

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "key": "deepline-analytics-sessions",
  "tool": "deepline.analytics",
  "payload": {
    "domains": ["example.com"]
  }
}
```

### Outputs

| Stream | Database table | Meaning |
| - | - | - |
| `sessions` | `deepline_analytics.sessions` | Signed, session-based Deepline Analytics events. |

#### Fields

| Field | Semantics |
| - | - |
| `domains` | Provider-specific domains monitor filter. |
| `formTracking` | Provider-specific formTracking monitor filter. |
| `clickTracking` | Provider-specific clickTracking monitor filter. |
| `customEvents` | Provider-specific customEvents monitor filter. |
| `waitForConsent` | Provider-specific waitForConsent monitor filter. |

#### Pricing, identity, and updates

* Pricing: Use the Deepline pricing returned by describe, monitors available, check, or deploy --dry-run. Provider spend is not exposed.
* Identity: This monitor uses the provider capability identity declared by Deepline.
* Update: Use monitors update for a patch or deploy for a complete desired definition.
* Backfill: Existing Database rows are retained; this capability does not promise provider backfill unless its provider documentation says otherwise.

#### Troubleshooting

* **Validation failed:** Correct the reported payload path, then run monitors check again.

## `deepline_native.company_radar`

Creates a Deepline Native company radar data pipe and writes Deepline Native company event rows into Database output tables.

### Executable examples

#### Track company job openings

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "key": "job-openings",
  "tool": "deepline_native.company_radar",
  "payload": {
    "domain": "stripe.com",
    "radar_type": "company_job_openings"
  }
}
```

#### Filter new-hire tracking by title and department

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "key": "exec-hires",
  "tool": "deepline_native.company_radar",
  "payload": {
    "domain": "stripe.com",
    "radar_type": "company_new_hires",
    "departments": ["Engineering"],
    "seniorities": ["Director", "Vice President"],
    "job_titles": "\"VP Engineering\" OR \"Head of Product\""
  }
}
```

### Outputs

| Stream | Database table | Meaning |
| - | - | - |
| `company_job_openings` | `deepline_native.deepline_native_company_job_openings` | Streams new job postings at a company into your warehouse and triggers plays. |
| `company_promotions` | `deepline_native.deepline_native_company_promotions` | Streams internal promotions at a company into your warehouse and triggers plays. |
| `company_mentions` | `deepline_native.deepline_native_company_mentions` | Streams news and web mentions of a company into your warehouse and triggers plays. |
| `company_new_hires` | `deepline_native.deepline_native_company_new_hires` | Streams new hires at a company into your warehouse and triggers plays. |
| `company_reviews` | `deepline_native.deepline_native_company_reviews` | Streams new employer and product reviews of a company into your warehouse and triggers plays. |
| `company_social_posts` | `deepline_native.deepline_native_company_social_posts` | Streams new social posts from a company into your warehouse and triggers plays. |
| `company_social_engagements` | `deepline_native.deepline_native_company_social_engagements` | Streams social engagements on a company into your warehouse and triggers plays. |

#### Fields

| Field | Semantics |
| - | - |
| `job_titles` | Provider-facing title expression. Deepline validates its grammar and forwards it unchanged; it overrides departments and seniorities when present. Stored readback does not prove upstream matching or billing semantics. |
| ↳ applies | Only company\_new\_hires, company\_job\_openings, company\_promotions, and company\_social\_posts\_cxo. |
| ↳ precedence | job\_titles overrides departments and seniorities. |
| ↳ grammar | Double-quoted title terms joined with uppercase AND, OR, and NOT. Parentheses are not part of the documented grammar. |
| ↳ grammar example | `"VP" OR "Head of Sales"` |
| `departments` | Persona department filter. |
| ↳ applies | Only company\_new\_hires, company\_job\_openings, company\_promotions, and company\_social\_posts\_cxo; ignored when job\_titles is present. |
| `seniorities` | Persona seniority filter. |
| ↳ applies | Only company\_new\_hires, company\_job\_openings, company\_promotions, and company\_social\_posts\_cxo; ignored when job\_titles is present. |
| `updates_since` | Use this only to request historical findings; it is not a query-time date filter. Omit it for a future-only start at provider creation. For new-hire and promotion radars, source dates are evaluated at calendar-month precision even though the exact submitted timestamp is preserved in the radar response, so Deepline rejects current-month values for those radar types. During initial engagement history, the parent post’s publication time sets eligibility; recurring engagement delivery uses when Deepline Native first discovers the engagement. |
| ↳ applies | Calendar-month source-date precision applies to company\_new\_hires and company\_promotions. The engagement timing rule applies to initial and recurring social-engagement delivery. |
| ↳ grammar | RFC3339 timestamp with Z or a numeric UTC offset; now or earlier and within five calendar years. |

#### Pricing, identity, and updates

* Pricing: Deepline pricing is selected by radar\_type and returned by the live monitor contract. Provider spend is not exposed.
* Identity: The provider identity scope is radar\_type plus domain. Separate Deepline monitor keys may use different effective payload configurations in that scope; an upstream 409 remains authoritative if the provider rejects a second resource.
* Update: A filter change replaces the upstream radar under the same Deepline monitor key and retains Database rows.
* Backfill: Historical matching can arrive during the first 24 hours. A filter update does not request historical findings that would newly match.

#### Troubleshooting

* **job\_titles is rejected:** Use "VP" OR "Head of Sales"; operators must be uppercase.

## `deepline_native.contact_radar`

Creates a Deepline-managed contact radar data pipe and writes provider-native contact event rows into Database output tables.

### Executable examples

#### Track contact job changes

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "key": "contact-job-changes",
  "tool": "deepline_native.contact_radar",
  "payload": {
    "profile_url": "https://www.linkedin.com/in/example",
    "domain": "stripe.com",
    "radar_type": "contact_job_changes"
  }
}
```

### Outputs

| Stream | Database table | Meaning |
| - | - | - |
| `contact_job_changes` | `deepline_native.deepline_native_contact_job_changes` | Streams job changes for a tracked contact into your warehouse and triggers plays. |
| `contact_social_posts` | `deepline_native.deepline_native_contact_social_posts` | Streams new social posts from a tracked contact into your warehouse and triggers plays. |
| `contact_social_engagements` | `deepline_native.deepline_native_contact_social_engagements` | Streams social engagements by a tracked contact into your warehouse and triggers plays. |

#### Fields

| Field | Semantics |
| - | - |
| `radar_type` | Deepline contact radar output family. The selected value determines the derived output table. |
| `profile_url` | Contact profile URL used to create or seed the upstream radar. |
| `domain` | Company domain where the contact works. Required for contact\_job\_changes (the company the contact is tracked at). |
| `email` | Contact email address, used alongside profile\_url/full\_name to seed contact\_job\_changes tracking. |
| `full_name` | Contact full name, used alongside profile\_url/email to seed contact\_job\_changes tracking. |
| `updates_since` | Optional permanent radar starting point. Use an RFC3339 timestamp with a time zone to receive qualifying historical findings from that instant. Omit to start at radar creation. The timestamp must be in the past and within five calendar years. Historical processing can continue for the first 24 hours. |

#### Pricing, identity, and updates

* Pricing: Use the Deepline pricing returned by describe, monitors available, check, or deploy --dry-run. Provider spend is not exposed.
* Identity: The provider resource scope uses radar\_type, profile\_url. Different effective payload configurations in that scope may be separate monitor resources; exact duplicates still conflict.
* Update: Use monitors update for a patch or deploy for a complete desired definition.
* Backfill: Existing Database rows are retained; this capability does not promise provider backfill unless its provider documentation says otherwise.

#### Troubleshooting

* **Validation failed:** Correct the reported payload path, then run monitors check again.

## `deepline_native.industry_radar`

Creates a Deepline-managed industry radar data pipe and writes provider-native industry event rows into Database output tables.

### Executable examples

#### Track industry mentions

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "key": "ai-industry-mentions",
  "tool": "deepline_native.industry_radar",
  "payload": {
    "industry": "artificial intelligence",
    "radar_type": "industry_mentions"
  }
}
```

### Outputs

| Stream | Database table | Meaning |
| - | - | - |
| `industry_mentions` | `deepline_native.deepline_native_industry_mentions` | Streams news and web mentions across an industry into your warehouse and triggers plays. |
| `industry_job_openings` | `deepline_native.deepline_native_industry_job_openings` | Streams new job postings across an industry into your warehouse and triggers plays. |
| `industry_funding_rounds` | `deepline_native.deepline_native_industry_funding_rounds` | DeeplineNativeIndustryFundingRoundsRow |
| `industry_funding_references` | `deepline_native.deepline_native_industry_funding_references` | DeeplineNativeIndustryFundingReferencesRow |

#### Fields

| Field | Semantics |
| - | - |
| `radar_type` | Deepline industry radar output family. The selected value determines the derived output tables. |
| `industry` | Industry or market segment used to create or seed the upstream radar. |
| `countries` | Optional for 'industry\_job\_openings' only. Array of country names to filter job postings by location. Maximum 5 countries allowed. Examples: 'United States', 'Canada', 'United Kingdom'. |
| `updates_since` | Optional permanent radar starting point. Use an RFC3339 timestamp with a time zone to receive qualifying historical findings from that instant. Omit to start at radar creation. The timestamp must be in the past and within five calendar years. Historical processing can continue for the first 24 hours. |

#### Pricing, identity, and updates

* Pricing: Use the Deepline pricing returned by describe, monitors available, check, or deploy --dry-run. Provider spend is not exposed.
* Identity: The provider resource scope uses radar\_type, industry. Different effective payload configurations in that scope may be separate monitor resources; exact duplicates still conflict.
* Update: Use monitors update for a patch or deploy for a complete desired definition.
* Backfill: Existing Database rows are retained; this capability does not promise provider backfill unless its provider documentation says otherwise.

#### Troubleshooting

* **Validation failed:** Correct the reported payload path, then run monitors check again.

## `vector.visitor_events`

Ingest Vector contact.visited events after you add the Deepline callback URL to a live Vector segment.

### Executable examples

#### High-intent website visitors

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "key": "vector-high-intent-visitors",
  "tool": "vector.visitor_events",
  "payload": {}
}
```

### Outputs

| Stream | Database table | Meaning |
| - | - | - |
| `events` | `vector.visitor_events` | Vector contact.visited events delivered to Deepline. |

#### Pricing, identity, and updates

* Pricing: Use the Deepline pricing returned by describe, monitors available, check, or deploy --dry-run. Provider spend is not exposed.
* Identity: This monitor uses the provider capability identity declared by Deepline.
* Update: Use monitors update for a patch or deploy for a complete desired definition.
* Backfill: Existing Database rows are retained; this capability does not promise provider backfill unless its provider documentation says otherwise.

#### Troubleshooting

* **Validation failed:** Correct the reported payload path, then run monitors check again.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.