Skip to main content

Adform API Connector

Updated today
Download Adform Logo in SVG Vector or PNG File Format - Logo ...

Overview

The Adform connector ingests daily delivery‑level performance data from the Adform DSP along with campaign and line‑item metadata for richer reporting.

  • Granularity: one row per campaign × line‑item × day.

  • Purpose: monitor spend, delivery, viewability, and efficiency KPIs across programmatic activity.

  • Refresh cadence: daily append of delivery rows plus daily lookup refreshes.

Please read more about the use cases of our Adform integration here.


Connection Setup / Requirements

Key

Description

Required

Type

adform_client_id

Pre‑configured client ID (brightanalytics@apps.adform.com)

No

Hidden

adform_client_secret

Pre‑configured API secret

No

Hidden

¹ These credentials are bundled with the connector; no additional user input is needed unless you override them with your own Adform app registration.


Import Configuration

1. Data Import

Setting

Value

Feed

adform

Job Label

Adform – Data Import

Status

Enabled (1)

Target Table

adform_data_delivery

Target Type

Data

Update Mode

Append

Create Target

true

Date Column

date

Look‑back

10 days

First Run (UTC)

05 : 00

Poll Frequency

Every 24 hours

2. Meta Refresh

Setting

Value

Target Tables

adform_meta_campaign, adform_meta_lineitem

Target Type

Lookup

Update Mode

Refresh

Create Target

false

Priority

Campaign = 1, LineItem = 2


Import Schedule

Job Type

Frequency

Look‑back Window

First Run (UTC)

Data Import

24 h

10 days

05 : 00

Meta Refresh

24 h

0 days (full refresh)

05 : 00 (runs immediately after delivery import)


Required User Input

No user input is required by default because the connector ships with its own Adform OAuth credentials. Supply alternate adform_client_id / adform_client_secret only if you need to use a different Adform application.


Tables Created

Table Name

Description

Type

Update Mode

adform_data_delivery

Daily delivery / performance facts

Data

Append

adform_meta_campaign

Campaign lookup

Lookup

Refresh

adform_meta_lineitem

Line‑item lookup

Lookup

Refresh


Table Relationships

Source Column (in adform_data_delivery)

Target Table

Target Column

campaignID

adform_meta_campaign

id

lineItemID

adform_meta_lineitem

id


Available Dimensions

Dimension Name

Source Field(s)

Description

Client [Adform]

adform_data_delivery.client

End advertiser or agency client

Campaign [Adform]

adform_meta_campaign.name

Campaign name (lookup)

Line Item [Adform]

adform_meta_lineitem.name

Line‑item / insertion order name (lookup)

Banner [Adform]

adform_data_delivery.banner

Creative/banner label


Available Metrics

Base Metrics

Metric Name

Calculation Formula

Round

Prefix

/Suffix

Description

Spend [Adform]

SUM(adform_data_delivery

.cost)

2

£

Media spend

Impressions [Adform]

SUM(adform_data_delivery

.impressions)

0

Served impressions

Clicks [Adform]

SUM(adform_data_delivery

.clicks)

0

Clicks

Conversions [Adform]

SUM(adform_data_delivery

.conversions)

0

Post‑click or post‑view conversions

Measurable Impressions [Adform]

SUM(adform_data_delivery

.measurableImpressions)

0

Impressions eligible for viewability measurement

Viewable Impressions [Adform]

SUM(adform_data_delivery

.viewImpressions)

0

Viewable impressions

Composite Metrics

Metric Name

Calculation Formula

Round

Prefix/Suffix

Description

CPC [Adform]

{Spend [Adform]} / {Clicks [Adform]}

2

£

Cost per click

CPM [Adform]

{Spend [Adform]} / {Impressions [Adform]} * 1000

2

£

Cost per thousand impressions

CTR [Adform]

{Clicks [Adform]} / {Impressions [Adform]} * 1000

2

%

Click‑through rate (‑per‑thousand basis)


Additional Information

  • Daily batch import: runs once per day, loading the last 10 days to backfill late data.

  • Automatic table creation: enabled for adform_data_delivery; metadata tables must already exist to preserve schema governance.

  • Granularity: one record per campaign × line‑item × banner × day.

  • Viewability support: both measurable and viewable impression counts are provided to calculate viewability rate in your BI layer.


Adform – Data Tables

Field

Type

Description

date

date

Reporting date

client

string

Advertiser or agency client

campaignID

int

Foreign key to adform_meta_campaign.id

lineItemID

int

Foreign key to adform_meta_lineitem.id

banner

string

Banner / creative label

impressions

int

Served impressions

measurableImpressions

int

Impressions eligible for viewability measurement

viewImpressions

int

Viewable impressions

clicks

int

Total clicks

conversions

int

Total conversions (post-click and post-view)

cost

decimal

Spend in delivery currency

device

string

Device type (e.g. Desktop, Mobile)

site

string

Publisher site or app name

placement

string

Placement ID or name on publisher side

country

string

Country (ISO 2-letter code)

region

string

Region or state within country

creativeSize

string

Creative dimensions (e.g. 300×250)

currency

string

Currency code (e.g. GBP, EUR)

costModel

string

Cost model (CPM, CPC, CPA, etc.)


Campaign Metadata (adform_meta_campaign)

Lookup table for campaign-level attributes, joined via campaignID.

Field

Type

Description

id

int

Campaign ID (primary key)

name

string

Campaign name

status

string

Campaign status (e.g. Active, Paused)

startDate

date

Campaign start date

endDate

date

Campaign end date

objective

string

Campaign objective (e.g. Awareness, Performance)

advertiser

string

Advertiser name

buyingType

string

Buying method (e.g. Guaranteed, RTB)

budget

decimal

Total campaign budget

currency

string

Budget currency

timeZone

string

Reporting time zone


Line Item Metadata (adform_meta_lineitem)

Lookup table for line item attributes, joined via lineItemID.

Field

Type

Description

id

int

Line item ID (primary key)

name

string

Line item name

campaignID

int

Foreign key to campaign

status

string

Line item status

goalType

string

Goal type (e.g. CPC, CPM)

goalValue

decimal

Goal threshold value

budget

decimal

Allocated budget

pacing

string

Delivery pacing (Even, ASAP)

startDate

date

Line item start date

endDate

date

Line item end date

targeting

json

Targeting parameters (audience, geo, device)


Summary

With built‑in credentials, the Adform connector:

  1. Appends daily delivery rows, backfilling the last 10 days.

  2. Refreshes campaign & line‑item lookups for accurate names and statuses.

  3. Supplies a concise set of dimensions and metrics—plus cost, viewability, and efficiency KPIs—to power programmatic advertising dashboards.

Blend Adform data with your wider media ecosystem to measure true omni‑channel performance.

Did this answer your question?