Skip to main content

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.

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

Filter new-hire tracking by title and department

Outputs

Fields

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

Outputs

Fields

Pricing, identity, and updates

  • Pricing: Use the Deepline pricing returned by tools get, 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

Outputs

Fields

Pricing, identity, and updates

  • Pricing: Use the Deepline pricing returned by tools get, 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.