Skip to main content

What is a Database Source?

A Database Source is a centralized lead storage container within Pingtree. It acts as a structured repository that holds leads collected from various channels — whether submitted via API, uploaded via CSV, or captured through campaign forms. Each database source is independent, with its own API key, duplicate rules, required fields, and linked campaigns. You can think of it as a dedicated lead database scoped to a specific use case, product, or advertiser.
Database sources list with status indicators

Key Capabilities

CapabilityDescription
Lead StorageStore and organize leads in a structured, queryable format.
API IngestionEach source has a unique API key for programmatic lead submission.
Duplicate DetectionPrevent duplicate leads based on email, phone, or a custom field.
Required FieldsEnforce which fields must be present before a lead is accepted.
Campaign LinkingConnect a database source to an offer campaign for distribution.
Advanced SearchQuery leads using MongoDB filters or Elasticsearch full-text search.
Post-OutForward stored leads to external endpoints automatically.

Creating a Database Source

  1. Navigate to System Database in the left sidebar.
  2. Click Database Sources.
  3. Click the Create Database Source button.
  4. Fill in the source details:
FieldDescription
NameA descriptive label for this source (e.g., “Home Insurance Leads Q1”).
SlugAuto-generated URL-friendly identifier based on the name.
AdvertiserOptionally link this source to a specific advertiser account.
CampaignLink to an offer campaign to enable lead distribution from this source.
Is ActiveToggle the source on or off. Inactive sources do not accept new leads.
  1. Click Save to create the source.
Tip: Use descriptive names that include the vertical, date range, or advertiser — this makes it much easier to manage multiple sources across your organization.

Configuring Duplicate Checking

Duplicate checking prevents the same lead from being stored more than once in a source. Configure this under the source’s settings:
SettingDescription
Check DuplicateEnable or disable duplicate detection for this source.
Duplicate Field NameThe field used to identify duplicates (e.g., email, phone, or a custom field key).
When a lead is submitted and its duplicate field value already exists in the source, the incoming lead is rejected and flagged as a duplicate.
Tip: Using email as the duplicate field is the most common choice. If your leads may share emails (e.g., family plans), consider using phone or a composite custom field instead.

Setting Required Fields

Required fields define which data points must be present in a lead submission for it to be accepted. Any lead missing a required field is rejected at ingestion time. To configure required fields:
  1. Open the database source.
  2. Go to the Settings or Field Configuration section.
  3. Mark each field as Required or Optional.

Linking to a Campaign

A database source can be linked to an offer campaign. This allows leads stored in the source to be distributed through that campaign’s routing and buyer logic. To link a campaign:
  1. Open the database source settings.
  2. Select the target Offer Campaign from the dropdown.
  3. Save your changes.
Tip: Linking a campaign enables the full distribution pipeline — including ping/post, pingtree routing, and endpoint posting — directly from your stored leads.

Activating and Deactivating a Source

  • Active: The source accepts new leads via API and CSV import.
  • Inactive: The source is paused. Existing leads are retained but no new leads are accepted.
Toggle the Is Active switch on the source settings page to change the state.

Source Statistics

Each database source displays a summary of its lead data:
StatisticDescription
Total LeadsThe total number of leads stored in this source.
Active LeadsLeads currently in an active or available state.
Duplicate CountNumber of leads rejected due to duplicate detection.
Import CountLeads ingested via CSV file upload.
API CountLeads submitted programmatically via the source API.

Pingtree supports two search modes for querying leads within a database source: Use structured field filters to find leads by any stored field value, date range, or status. This is the default search interface and works well for most use cases. For large datasets or full-text search requirements, Elasticsearch-powered search provides faster queries and fuzzy matching across all lead fields.
Tip: Elasticsearch search is particularly useful when you need to find leads by partial values (e.g., partial email domains or approximate name matches) across millions of records.

API Key Management

Every database source is assigned a unique API key at creation. This key is used to authenticate lead submissions and fetch requests.
  • View the API key from the Source API Help tab within the source.
  • If a key is compromised, regenerate it from the API settings. All future requests must use the new key.
See Source API Reference for full API documentation.