Skip to main content

Adalyser API Connector

Updated today

Adalyser | IAB UK

Overview

The Adalyser connector automates daily imports of TV‑spot performance data (“spots”) along with supporting metadata for campaigns and creatives.

  • Granularity: one row per individual air‑time “spot”.

  • Purpose: unify spend and response‑based KPIs (sessions, sign‑ups, sales, leads) with rich dimensional context (channel, programme, creative, etc.) for cross‑channel attribution and ROI analysis.

  • Refresh cadence: daily append of new spot rows plus optional metadata refresh.

Please read more about the use cases of our Adalyser Integration here.


Connection Setup / Requirements

Key

Description

Required

Type

adalyser_username

Username used to log in to the Adalyser UI

Yes

Text

adalyser_username_password

Corresponding password

Yes

Password

Note API host / token parameters are not required; the connector authenticates via the Adalyser web credentials you supply.


Import Configuration

1. Data Import

Setting

Value

Feed

adalyser

Job Label

Adalyser – Data Import

Status

Enabled (1)

Target Table

adalyser_data_spots

Target Type

Data

Update Mode

Append

Create Target

true

Date Column

bright_custom_date

Look‑back

5 days

First Run (UTC)

05 : 00

Poll Frequency

Every 24 hours

Required Option

adalyser_campaign_id – comma‑delimited list of campaign IDs (text, 255 chars, required)

2. Meta Refresh – Campaign

Setting

Value

Target Table

adalyser_meta_campaign

Target Type

Lookup

Update Mode

Refresh

Create Target

false

Priority

1 (runs first among lookups)

3. Meta Refresh – Creative

Setting

Value

Target Table

adalyser_meta_creative

Target Type

Lookup

Update Mode

Refresh

Create Target

false

Priority

2


Import Schedule

Job Type

Frequency

Look‑back Window

First Run (UTC)

Data Import

24 h

5 days

05 : 00

Meta Refresh

24 h

0 days (full refresh)

05 : 00

Poll Frequency controls how often the connector executes. Look‑back dictates the rolling window pulled on each run.


Required User Input

  1. Adalyser credentials – username & password (connection settings).

  2. Campaign IDs – comma‑separated list (adalyser_campaign_id) to limit the import to specific campaigns.

Both inputs must be configured before the first run.


Tables Created

Table Name

Description

Type

Update Mode

adalyser_data_spots

Individual TV‑spot performance rows

Data

Append

adalyser_meta_campaign

Campaign‑level metadata

Lookup

Refresh

adalyser_meta_creative

Creative‑level metadata

Lookup

Refresh


Table Relationships

Source Column (in adalyser_data_spots)

Target Table

Target Column

creative

adalyser_meta_creative

id

bright_custom_campaign_id

adalyser_meta_campaign

id

These joins enrich raw spot data with campaign and creative attributes for reporting.


Available Dimensions

Dimension Name

Source Field(s)

Description

Sales House [Adalyser]

adalyser_data_spots.salesHouse

TV sales‑house responsible for airtime

Channel [Adalyser]

adalyser_data_spots.channel

Broadcast channel where the spot aired

Programme [Adalyser]

adalyser_data_spots.programme

TV programme during which spot aired

Creative [Adalyser]

adalyser_data_spots.creative

Creative identifier / name

Type [Adalyser]

adalyser_data_spots.type

Spot type (e.g., National, Regional)


Available Metrics

Base Metrics

Metric Name

Calculation Formula

Round

Description

Spend [Adalyser]

SUM(adalyser_data_spots.clientCost)

2

Media spend (billing currency)

Sessions [Adalyser]

SUM(adalyser_data_spots.leadCount)

0

Web sessions attributed to the spot

Sign Ups [Adalyser]

SUM(adalyser_data_spots.apptCount)

0

Successful sign‑ups / appointments

Sales [Adalyser]

SUM(adalyser_data_spots.saleCount)

0

Closed sales attributed

Lead Count [Adalyser]

SUM(adalyser_data_spots.leadCount)

0

Leads generated (same field as Sessions if treated equivalently)

Composite Metrics

Metric Name

Calculation Formula

Rounding

Prefix/Suffix

Description

Cost per Session [Adalyser]

{Spend [Adalyser]} / {Sessions [Adalyser]}

2

£

Average cost per attributed session

Cost per Sign‑up [Adalyser]

{Spend [Adalyser]} / {Sign Ups [Adalyser]}

2

£

Average cost per sign‑up


Additional Information

  • Daily batch import: the connector runs once every 24 hours at 05 : 00 UTC.

  • Automatic table creation: set to true for the fact table; lookup tables must exist beforehand (allows governance over metadata structures).

  • Granularity: each row in adalyser_data_spots represents a single aired TV spot.

  • Multi‑campaign support: restrict data to specific campaigns via the adalyser_campaign_id option; omit or leave blank to ingest all accessible campaigns.


📊 Performance Data Tables

Spot-Level Data (adalyser_data_spots)

This table contains detailed information about each TV ad spot and its associated performance metrics.

Field Name

Data Type

Description

bright_custom_date

date

The date the spot was aired (used for time series).

bright_custom_campaign_id

varchar(50)

Campaign identifier.

creative

varchar(50)

Identifier for the creative aired.

salesHouse

varchar(100)

Sales house responsible for the spot.

channel

varchar(100)

Channel where the spot was broadcast.

programme

varchar(255)

Name of the programme into which the spot aired.

type

varchar(50)

Classification of the spot (e.g., Spot, Sponsorship).

clientCost

decimal(12,2)

The client’s net cost for the spot.

leadCount

int

Number of leads generated from the spot.

apptCount

int

Number of appointments/sign-ups.

saleCount

int

Number of actual sales.


🔁 Lookup Metadata Tables

Campaign Metadata (adalyser_meta_campaign)

Field Name

Data Type

Description

id

varchar(50)

Unique identifier for the campaign.

name

varchar(255)

Human-readable name of the campaign.


Creative Metadata (adalyser_meta_creative)

Field Name

Data Type

Description

id

varchar(50)

Unique identifier for the creative.

name

varchar(255)

Human-readable name of the creative.


🔗 Datasource Joins

Left Field (LHS)

Right Field (RHS)

Join Purpose

creative

adalyser_meta_creative.id

Joins spot-level data to creative metadata.

bright_custom_campaign_id

adalyser_meta_campaign.id

Joins spot-level data to campaign metadata.


📐 Dimensions

Dimension Name

Mapped Field

Sales House [Adalyser]

adalyser_data_spots.salesHouse

Channel [Adalyser]

adalyser_data_spots.channel

Programme [Adalyser]

adalyser_data_spots.programme

Creative [Adalyser]

adalyser_data_spots.creative

Type [Adalyser]

adalyser_data_spots.type


🔢 Base Metrics

Metric Name

Formula

Rounding

Prefix/Suffix

Spend [Adalyser]

SUM(adalyser_data_spots.clientCost)

2

£

Sessions [Adalyser]

SUM(adalyser_data_spots.leadCount)

0

Sign Ups [Adalyser]

SUM(adalyser_data_spots.apptCount)

0

Sales [Adalyser]

SUM(adalyser_data_spots.saleCount)

0

Lead Count [Adalyser]

SUM(adalyser_data_spots.leadCount)

0


🧮 Composite Metrics

Metric Name

Formula

Rounding

Prefix/Suffix

Cost per Session [Adalyser]

Spend [Adalyser] / Sessions [Adalyser]

2

£ (Suffix)

Cost per Sign-up [Adalyser]

Spend [Adalyser] / Sign Ups [Adalyser]

2


(Optional) Keyword‑Level Metadata

Adalyser does not expose keyword entities; instead, the creative and campaign tables provide the core lookup context. No keyword table is included by default.


Summary

By supplying credentials and (optionally) a list of campaign IDs, the Adalyser connector will:

  1. Append new spot rows each day to adalyser_data_spots.

  2. Refresh campaign & creative lookups to keep names and statuses current.

  3. Expose a concise but powerful set of dimensions and metrics for cost‑efficiency analysis of TV advertising.

Use the documented joins and field lists to build dashboards that blend Adalyser television data with your digital channels for a unified marketing performance view.

Did this answer your question?