Skip to main content

Affiliate Window API Connector

Updated this week
Affiliate Window App for IRP Commerce Cloud

Overview

The AWIN connector imports affiliate marketing data including transactions and publisher information. Metadata about publishers is refreshed separately.

  • Granularity: Transactions and publisher-level daily data plus publisher metadata.

  • Purpose: Track sales, commissions, clicks, impressions, and enrich with publisher attributes.

  • Refresh cadence: Daily append for transactional and publisher data, daily refresh for publisher metadata.

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


Connection Setup / Requirements

Key

Description

Required

Type

Size

awin_api_key

API Key from Awin

Yes

Text

50

awin_advertiser_id

Advertiser ID from Awin UI

Yes

Text

50


Import Configuration

1. Data Import Job

Setting

Value

Feed

awin

Job Label

Awin Data Import

Status

Enabled (1)

Target Tables

awin_data_transactions, awin_data_publishers

Target Types

Data

Update Mode

Append

Create Targets

True

Date Columns

bright_custom_date

Look-back

3 days

First Run (UTC)

06:00

Poll Frequency

24 hours


2. Metadata Refresh Job

Setting

Value

Feed

awin

Job Label

Awin Meta Import

Status

Enabled (1)

Target Tables

awin_meta_publishers

Target Types

Lookup

Update Mode

Refresh

Create Targets

True

Look-back

1 day

First Run (UTC)

06:00

Poll Frequency

24 hours


Import Schedule

Job Type

Frequency

Look-back Window

First Run (UTC)

Data Import

24 h

3 days

06:00

Meta Refresh

24 h

1 day

06:00


Tables Created and Their Fields

Data Tables

awin_data_transactions

Field Name

Description

id

Unique transaction identifier

publisherId

Publisher identifier

bright_custom_date

Date of transaction

saleAmount_amount

Sale amount (£)

commissionAmount_amount

Commission earned (£)

commissionGroupCode

Commission group code

siteName

Site where transaction occurred

type

Transaction type

clickDevice

Device used in click


awin_data_publishers

Field Name

Description

id

Unique record identifier

publisherId

Publisher identifier

bright_custom_date

Date of record

clicks

Number of clicks

impressions

Number of impressions


Metadata Tables

awin_meta_publishers

Field Name

Description

id

Unique publisher ID

name

Publisher name

primaryRegion

Primary region of publisher

primaryType

Publisher type/category


Table Relationships

Source Table

Source Column

Target Table

Target Column

awin_data_publishers

publisherId

awin_meta_publishers

id

awin_data_transactions

publisherId

awin_meta_publishers

id


Available Dimensions

Dimension Name

Source Field

Description

Commission Group Code [Awin]

awin_data_transactions.

commissionGroupCode

Commission group category

Site Name [Awin]

awin_data_transactions.

siteName

Site name where sale occurred

Transaction Type [Awin]

awin_data_transactions.

type

Type of transaction

Device [Awin]

awin_data_transactions.

clickDevice

Device used for click

Publisher Name [Awin]

awin_meta_publishers.

name

Publisher's name

Publisher Primary Region [Awin]

awin_meta_publishers.

primaryRegion

Publisher's main region

Publisher Primary Type [Awin]

awin_meta_publishers.

primaryType

Publisher category/type


Available Metrics

Metric Name

Formula

Round

Prefix

Description

Sale Amount [Awin]

SUM(awin_data_transactions.

saleAmount_amount)

2

£

Total sale amount

Commission [Awin]

SUM(awin_data_transactions

.commissionAmount_amount)

2

£

Total commission earned

Transactions [Awin]

COUNT(awin_data_transactions.

id)

0

Number of transactions

Clicks [Awin]

SUM(awin_data_publishers.

clicks)

0

Total clicks

Impressions [Awin]

SUM(awin_data_publishers.

clicks)

0

Total impressions


Composite Metrics

  • No composite metrics currently defined.


Summary

The AWIN connector facilitates daily imports of affiliate marketing transactional and publisher data, enriched with publisher metadata refreshed daily. This setup allows detailed tracking of sales, commissions, clicks, impressions, and publisher attributes essential for affiliate performance analysis.


Did this answer your question?