Overview
This document provides a comprehensive guide for integrating and managing Eskimi data imports, including connection setup, import scheduling, required user inputs, table structures, relationships, and available reporting dimensions and metrics. The configuration is designed to automate the retrieval and refresh of both delivery and metadata from the Eskimi platform, enabling robust analytics and reporting.
This connector ingests Eskimi creative and site platform performance data, along with associated metadata, via the Eskimi API.
Granularity: Campaign → Creative / Site Platform level
Purpose: Track delivery metrics (impressions, spend, clicks, conversions, etc.) and enrich with campaign, creative, and site metadata for performance analysis and reporting.
Refresh Cadence: Daily
Update Modes: Append (for data), Refresh (for metadata)
Connection Setup / Requirements
To connect to the Eskimi platform, the following credentials and parameters are required:
Key | Description | Required | Type | Size |
eskimi_username | Eskimi Username | Yes | Text | 50 |
eskimi_password | Eskimi Password | Yes | Password | 50 |
eskimi_client_id | Eskimi Client ID | Yes | Text | 50 |
eskimi_client_secret | Eskimi Client Secret | Yes | Password | 50 |
eskimi_user_ids | Eskimi User IDs | Yes | Text | 50 |
Note:
Ensure your username and password are active and have the necessary permissions for data access.
The Client ID and Client Secret must be generated in the Eskimi dashboard.
User IDs should be provided as a comma-delimited list to access data for specific users.
Import Configuration
Two primary jobs are defined for data ingestion:
1. Delivery Data Import
Feed: eskimi
Job Label: Eskimi - Data Import
Status: Enabled (1)
Target Tables:
eskimi_data_creatives
eskimi_data_siteplatforms
Target Type: Data
Update Mode: Append (new data is added)
Create Target: True (tables are created if not existing)
Date Column: date
Lookback: 5 days
First Run Hour: 06:00 UTC
Poll Frequency: Every 24 hours
2. Meta Data Refresh
Feed: eskimi
Job Label: Eskimi - Meta Refresh
Status: Enabled (1)
Target Tables:
eskimi_meta_campaign
eskimi_meta_creative
eskimi_meta_creativeset
eskimi_meta_siteplatform
Target Type: Lookup
Update Mode: Refresh (full table refresh)
Create Target: True
Lookback: 1 day
First Run Hour: 06:00 UTC
Poll Frequency: Every 24 hours
Import Schedule
Job Type | Frequency | Lookback Window | First Run (UTC) |
Delivery Import | 24 hours | 5 days | 06:00 |
Meta Refresh | 24 hours | 1 day | 06:00 |
Poll Frequency defines how often the import job runs.
Lookback specifies how many days of data are fetched on each run.
Required User Input
Before running the integration, users must provide:
Eskimi Username – for authentication.
Eskimi Password – for authentication.
Client ID – generated in the Eskimi dashboard.
Client Secret – generated in the Eskimi dashboard.
User IDs – comma-separated list to filter data.
These are mandatory and must be configured in the connection settings.
Tables Created
The integration creates and populates the following tables:
Table Name | Description | Type | Update Mode |
eskimi_data_creatives | Creative Performance Data | Data | Append |
eskimi_data_siteplatforms | Site Platform Performance Data | Data | Append |
eskimi_meta_campaign | Campaign Metadata | Lookup | Refresh |
eskimi_meta_creative | Creative Metadata | Lookup | Refresh |
eskimi_meta_creativeset | Creative Set Metadata | Lookup | Refresh |
eskimi_meta_siteplatform | Site Platform Metadata | Lookup | Refresh |
Table Relationships
The data tables are joined to metadata tables using the following keys:
Source Column | Target Table | Target Column |
campaign_id | eskimi_meta_campaign | eskimi_meta_campaign.id |
creative_id | eskimi_meta_creative | eskimi_meta_creative.id |
campaign_id | eskimi_meta_campaign | eskimi_meta_campaign.id |
site_platform_id | eskimi_meta_siteplatform | eskimi_meta_siteplatform.id |
These joins enable enriched reporting and analysis by linking delivery data to relevant metadata.
Available Dimensions
The following dimensions are available for reporting and analysis:
Dimension Name | Source Field(s) | Description |
Campaign [Eskimi] | eskimi_meta_campaign.name | The name of the campaign associated with the delivery or performance data. Enables reporting at the campaign level. |
Creative [Eskimi] | eskimi_meta_creative.title | The title of the creative asset used in the campaign. Useful for analyzing performance by specific creative executions. |
Click URL [Eskimi] | eskimi_meta_campaign.click_url | The destination URL for clicks from the campaign. Enables analysis by landing page or click destination. |
Ad Domain [Eskimi] | eskimi_meta_campaign.ad_domain | The domain associated with the advertising campaign. Useful for grouping and filtering by advertiser domain. |
Site Platform [Eskimi] | eskimi_meta_siteplatform.name | The name of the site platform where ads are displayed. Allows for performance analysis by platform. |
Available Metrics
Base Metrics
Metric Name | Calculation Formula | Round | Description |
Spend [Eskimi] | SUM({eskimi_data_creatives.spent}) + SUM({eskimi_data_siteplatforms.spent}) | 2 | The total media spend in GBP (£) for the selected period, as reported by Eskimi. |
Clicks [Eskimi] | SUM({eskimi_data_creatives.clicks}) + SUM({eskimi_data_siteplatforms.clicks}) | 0 | The total number of clicks generated during the reporting period. |
Impressions [Eskimi] | SUM({eskimi_data_creatives.impressions}) + SUM({eskimi_data_siteplatforms.impressions}) | 0 | The total number of times ads were served (impressions) during the reporting period. |
Bids [Eskimi] | SUM({eskimi_data_creatives.bids}) + SUM({eskimi_data_siteplatforms.bids}) | 0 | The total number of bid requests made during the reporting period. |
Views [Eskimi] | SUM({eskimi_data_creatives.views}) + SUM({eskimi_data_siteplatforms.views}) | 0 | The total number of ad views recorded during the reporting period. |
Sessions [Eskimi] | SUM({eskimi_data_creatives.sessions}) + SUM({eskimi_data_siteplatforms.sessions}) | 0 | The total number of user sessions attributed to the campaign. |
Conversions [Eskimi] | SUM({eskimi_data_creatives.conversions}) + SUM({eskimi_data_siteplatforms.conversions}) | 0 | The total number of conversions attributed to the campaign. |
Composite Metrics
Metric Name | Calculation Formula | Round | Prefix/ Suffix | Description |
CPC [Eskimi] | {Spend [Eskimi]} / {Clicks [Eskimi]} | 2 | £ | Cost per click; calculated as total spend divided by the number of clicks. |
CPM [Eskimi] | {Spend [Eskimi]} / {Impressions [Eskimi]} * 1000 | 2 | £ | Cost per thousand impressions; calculated as total spend divided by impressions, multiplied by 1,000. |
CTR [Eskimi] | {Clicks [Eskimi]} / {Impressions [Eskimi]} * 100 | 2 | % | Click-through rate; calculated as clicks divided by impressions, expressed as a percentage. |
VTR [Eskimi] | {Views [Eskimi]} / {Impressions [Eskimi]} * 100 | 2 | % | View-through rate; calculated as views divided by impressions, expressed as a percentage. |
Conversion Rate [Eskimi] | {Conversions [Eskimi]} / {Clicks [Eskimi]} * 100 | 2 | % | Conversion rate; calculated as conversions divided by clicks, expressed as a percentage. |
CPA [Eskimi] | {Spend [Eskimi]} / {Conversions [Eskimi]} | 2 | £ | Cost per acquisition; calculated as total spend divided by the number of conversions. |
Additional Information
The integration is designed for daily batch imports.
All tables are automatically created if they do not exist.
Data is imported with a 5-day lookback window to ensure completeness.
Metadata is refreshed daily to maintain the accuracy of campaign and creative information.
Additional Reporting Capabilities
Beyond the standard performance metrics and dimensions outlined above, the Eskimi platform supports additional specialized reports that can be configured based on specific analytical requirements
Report Name | Table Name | Description |
Ad Placement Positions | eskimi_data_adplacementpositions | Provides campaign performance data segmented by ad placement positions, enabling analysis of how different placement locations impact campaign effectiveness |
Ad Placement Types | eskimi_data_adplacementtypes | Delivers performance insights based on different ad placement types, allowing for optimization based on placement format and context |
Browser Performance | eskimi_data_browsers | Campaign performance breakdown by browser type, useful for technical optimization and understanding user behavior patterns |
Age Groups | eskimi_data_agegroups | Performance analysis segmented by age demographics, enabling targeted optimization for specific age cohorts |
Site Platforms | eskimi_data_siteplatforms | Performance data by site platform, providing insights into which platforms deliver the best results |
Site Types | eskimi_data_sitetypes | Campaign performance categorized by different types of websites or applications where ads are displayed |
Device IDs | eskimi_data_deviceids | Performance tracking at the device level for detailed attribution and frequency analysis |
Video Campaigns | eskimi_data_videocampaigns | Specialized reporting for video campaign performance with video-specific metrics and insights |
Exchanges | eskimi_data_exchanges | Performance breakdown by advertising exchange, useful for supply-side optimization |
Gender Demographics | eskimi_data_genders | Campaign performance segmented by gender demographics for audience targeting optimization |
Operating Systems | eskimi_data_oses | Performance analysis by operating system, enabling technical and user experience optimization |
Mobile Operators | eskimi_data_operators | Performance insights by mobile carrier/operator, particularly valuable for mobile-focused campaigns |
Individual Sites | eskimi_data_sites | Granular performance data for specific websites or applications in the advertising inventory |
Campaign Overview | eskimi_data_campaigns | Comprehensive campaign-level performance data with aggregated metrics across all targeting parameters |
These additional reports can be integrated into the data import setup upon request, enhancing the analytical capabilities beyond the core performance metrics. Each extra report adheres to the same import schedule and authentication requirements as the main data feeds, ensuring consistent data availability and reliability.
Additional Dimensional Tables
The following dimensional tables can be integrated to provide enhanced filtering and grouping capabilities for reporting and analysis:
Ad Placement Positions
Table Name: eskimi_meta_adplacementpositions
Field | Type | Description |
id | Integer | Unique identifier for the ad placement position |
name | Text | Descriptive name of the placement position (e.g., "Above the Fold", "Below the Fold", "Other") |
Ad Placement Types
Table Name: eskimi_meta_adplacementtypes
Field | Type | Description |
id | Integer | Unique identifier for the ad placement type |
name | Text | Descriptive name of the placement type (e.g., "Site", "App") |
Age Groups
Table Name: eskimi_meta_agegroups
Field | Type | Description |
id | Integer | Unique identifier for the age group |
name | Text | Descriptive name of the age group (e.g., "Unknown", "0-17", "18-24") |
Campaign Details
Table Name: eskimi_meta_campaign
Field | Type | Description |
id | Integer | Unique identifier for the campaign |
name | Text | Campaign name |
type | Integer | Campaign type identifier |
user_id | Integer | User ID associated with the campaign |
ad_domain | Text | Domain for the advertisement |
click_url | Text | URL where users are directed when clicking the ad |
bid | Decimal | Bid amount for the campaign |
budget_daily | Decimal | Daily budget allocation |
budget_total | Decimal | Total campaign budget |
dates_from | Date | Campaign start date |
dates_to | Date | Campaign end date |
creative_set_ids | Array | Associated creative set identifiers |
ad_placement_type_ids | Array | Associated ad placement type identifiers |
ad_placement_position_ids | Array | Associated ad placement position identifiers |
devices_wifi | Boolean | WiFi device targeting flag |
optimisation_type | Text | Optimization strategy type |
optimisation_target | Integer | Optimization target value |
optimisation_impressions | Integer | Target impressions for optimization |
optimisation_spent | Decimal | Spent amount for optimization |
auto_start | Boolean | Auto-start campaign flag |
created_at | Timestamp | Campaign creation timestamp |
Countries
Table Name: eskimi_meta_countries
Field | Type | Description |
code | Text | ISO country code (2-letter) |
name | Text | Full country name |
Creative Details
Table Name: eskimi_meta_creative
Field | Type | Description |
id | Integer | Unique identifier for the creative |
type_id | Integer | Creative type identifier |
title | Text | Creative title/name |
width | Integer | Creative width in pixels |
height | Integer | Creative height in pixels |
assets_asset_key | Text | Asset key identifier |
assets_content | Text | Full HTML/JavaScript content of the creative |
assets_minified_content | Text | Minified version of the creative content |
assets_minify | Boolean | Flag indicating if content is minified |
assets_width | Integer | Asset width in pixels |
assets_height | Integer | Asset height in pixels |
assets_preview_filename | Text | Preview image filename for the creative |
Mobile Operators
Table Name: eskimi_meta_operators
Field | Type | Description |
id | Integer | Unique identifier for the mobile operator |
name | Text | Mobile operator/carrier name |
Site Platforms
Table Name: eskimi_meta_siteplatforms
Field | Type | Description |
id | Integer | Unique identifier for the site platform |
name | Text | Platform name (e.g., "Web Site", "Android") |
Site Types
Table Name: eskimi_meta_sitetypes
Field | Type | Description |
id | Integer | Unique identifier for the site type |
name | Text | Site type name (e.g., "App", "Site") |
Sites
Table Name: eskimi_meta_sites
Field | Type | Description |
id | Integer | Unique identifier for the site |
name | Text | Site name |
domain | Text | Site domain URL |
Additional Information
Further information regarding the endpoints, fields, and API information can be found within the following links:
Authentication Documentation: https://dsp-api.eskimi.com/docs/api/auth/
API v1 Documentation: https://dsp-api.eskimi.com/docs/api/v1/
These resources provide comprehensive details about API authentication methods, endpoint specifications, request/response formats, and field definitions for all available data sources and dimensional tables within the Eskimi platform.