CampaignUrlMetric Model

DB Table Name	{wp_db_prefix}_fc_campaign_url_metrics
Schema	Check Schema
Source File	fluent-crm/app/Models/CampaignUrlMetric.php
Name Space	FluentCrm\App\Models
Class	FluentCrm\App\Models\CampaignUrlMetric

Attributes

Attribute	Data Type	Comment
id	Integer
url_id	Integer
campaign_id	Integer
subscriber_id	Integer
type	String
ip_address	String
country	String
city	String
counter	Integer
created_at	Date Time
updated_at	Date Time

Usage

Please check Model Basic for Common methods.

Accessing Attributes

$campaignUrlMatric = FluentCrm\App\Models\CampaignUrlMetric::find(1);

$subsctiber->id; // returns id
$campaignUrlMatric->type; // returns type
.......

Fillable Attributes

'url_id',
'campaign_id',
'subscriber_id',
'type', unsubscribe / click
'ip_address',
'country',
'city'

Relations

This model has the following relationships that you can use

campaign

Access the associated campaign of a model

• return FluentCrm\App\Models\Campaign Model

Example:

// Accessing Campaign
$campaign = $metric->campaign;

// Get CampaignUrlMetrics which has type: funnel_email_campaign
$metrics = FluentCrm\App\Models\CampaignUrlMetric::whereHas('campaign', function($query) {
    $query->where('type', 'funnel_email_campaign');
})->get();

subscriber

Access the associated subscriber of a model

• return FluentCrm\App\Models\Subscriber Model

Example:

// Accessing Subscriber
$subscriber = $metric->subscriber;

// Get CampaignUrlMetrics for a specific subscriber
$metrics = FluentCrm\App\Models\CampaignUrlMetric::whereHas('subscriber', function($query) {
    $query->where('first_name', 'Demo');
})->get();

url_stores

Access the associated URL store record

• return FluentCrm\App\Models\UrlStores Model

Example:

// Accessing the original URL
$urlStore = $metric->url_stores;
$originalUrl = $urlStore->url;

Methods

Along with Global Model methods, this model has few helper methods.

maybeInsert($data)

Store or update campaign url matrix data

• Parameters
  • $data array campaign url matrix data
• Returns \FluentCrm\App\Models\CampaignUrlMetric

Usage

$campaignUrlMatric = CampaignUrlMatric::maybeInsert($data);

getLinksReport($campaign)

Get click-count-per-URL report for a campaign. Handles both standard and anonymous tracking modes.

• Parameters
  • $campaign FluentCrm\App\Models\Campaign
• Returns array

Usage

$linksReport = $metric->getLinksReport($campaign);

getCampaignAnalytics($campaign)

Get formatted campaign stats: opens, clicks, CTOR, unsubscribes, revenue

• Parameters
  • $campaign FluentCrm\App\Models\Campaign
• Returns array

Usage

$analytics = $metric->getCampaignAnalytics($campaign);

getSubjectStats($campaign)

Get per-subject A/B test analytics

• Parameters
  • $campaign FluentCrm\App\Models\Campaign
• Returns array

Usage

$stats = $metric->getSubjectStats($campaign);