# CampaignUrlMetric Model

| DB Table Name | {wp_db_prefix}_fc_campaign_url_metrics                                   |
|---------------|--------------------------------------------------------------------------|
| Schema        | <a href="/database/#fc-subscribers-table">Check Schema</a> |
| Source File   | fluent-crm/app/Models/CampaignUrlMetric.php                                       |
| Name Space    | FluentCrm\App\Models                                                     |
| Class         | FluentCrm\App\Models\CampaignUrlMetric                                            |

## Attributes
<table class="nowrap">
   <thead>
      <tr>
         <th>Attribute</th>
         <td>Data Type</td>
         <td>Comment</td>
      </tr>
   </thead>
   <tbody>
      <tr>
         <th>id</th>
         <td>Integer</td>
         <td></td>
      </tr>
      <tr>
         <th>url_id</th>
         <td>Integer</td>
         <td></td>
      </tr>
      <tr>
         <th>campaign_id</th>
         <td>Integer</td>
         <td></td>
      </tr>
      <tr>
         <th>subscriber_id</th>
         <td>Integer</td>
         <td></td>
      </tr>
      <tr>
         <th>type</th>
         <td>String</td>
         <td></td>
      </tr>
      <tr>
         <th>ip_address</th>
         <td>String</td>
         <td></td>
      </tr>
      <tr>
         <th>country</th>
         <td>String</td>
         <td></td>
      </tr>
      <tr>
         <th>city</th>
         <td>String</td>
         <td></td>
      </tr>
      <tr>
         <th>counter</th>
         <td>Integer</td>
         <td></td>
      </tr>
      <tr>
         <th>created_at</th>
         <td>Date Time</td>
         <td></td>
      </tr>
      <tr>
         <th>updated_at</th>
         <td>Date Time</td>
         <td></td>
      </tr>
   </tbody>
</table>

## Usage

Please check <a href="/database/models/">Model Basic</a> for Common methods.

### Accessing Attributes

```php 

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

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

## Fillable Attributes

```php

'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:
```php
// 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:
```php
// 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:
```php
// 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
```php 
$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
```php
$linksReport = $metric->getLinksReport($campaign);
```

### getCampaignAnalytics($campaign)
Get formatted campaign stats: opens, clicks, CTOR, unsubscribes, revenue

- Parameters
  - $campaign `FluentCrm\App\Models\Campaign`
- Returns `array`

#### Usage
```php
$analytics = $metric->getCampaignAnalytics($campaign);
```

### getSubjectStats($campaign)
Get per-subject A/B test analytics

- Parameters
  - $campaign `FluentCrm\App\Models\Campaign`
- Returns `array`

#### Usage
```php
$stats = $metric->getSubjectStats($campaign);
```