Skip to main content
Skip table of contents

Teads

Overview

Vendor/Partner

Teads

Version

Not specified

API Documentation

https://help.teads.com/en/articles/8154601-reporting-api

Sunset Date

None as of Jan. 2025

Channel(s)

Programmatic

Refresh Time (CST)

6am

Default backfill

7 Days

Alli Data Library

(tick)

Getting Started

Required Authorization

Generating an API key
  1. Log into the TAM UI

  2. Open "Settings" screen by clicking on the gear icon located in the header.

  3. Click the "Generate API Key" button in the "API Keys" section.

  4. Optional - Click edit icon to change the API Key name.

image-20250124-142410.png
Authenticating the datasource with your API key

Save & Authorize your datasource

image-20250124-142739.png

Input your API key

image-20250124-142833.png

Upon saving the API key, the authorization will be available globally within the Alli client. You can customize the authorization access level by clicking the settings wheel in the Required Authorization section and selecting Only Me (Private) or Any user in <client>.

Define your Data

Dimensions

Name

ID

Type

Description

Hour

hour

string

Hour for the data

Day

day

date

Day for the data

Seat id

ad_owner_id

string

Teads Ad Manager Seat id

Seat name

ad_owner_name

string

Teads Ad Manager Seat name

Advertiser ID

advertiser_id

string

Teads id of the advertiser

Advertiser name

advertiser_name

string

Name of the advertiser

Advertising Solution

advertising_solution

string

Advertising Solution of the campaign

Campaign ID

ad_id

string

Teads id of the campaign

Campaign name

ad_external_name

string

Name of the campaign

Campaign Objective

campaign_objective

string

Objective of the campaign. Allows to breakdown between Branding and Performance campaigns.

Conversion name

conversion_name

string

Name of a conversion event (as configured in Events Manager, which allows the setup and management of website event).

Conversion type

conversion_type

string

Type of a conversion event (as configured in Events Manager, which allows the setup and management of website event).

Cookieless Delivery

cookieless_delivery

string

True or False - indicates if the targeting applied to deliver the impression only used cookieless signals (true) or relied on a 3rd party cookie (false)

Budget spent currency

turnover_currency

string

Currency of the budget spent

Campaign currency

io_currency

string

Currency of the campaign

Campaign budget

io_budget

string

Total budget of the campaign

Campaign external integration code

ad_external_integration_code

string

User-defined code to integrate campaign data with another reporting system

Line item ID

insertion_id

string

Teads id of the line item

Line Item Name

insertion_name

string

Name of the line item

Line item budget

insertion_budget

string

Budget of the line item

Line End Date

insertion_end_date

string

End date of the line item

Line Group ID

io_line_id

string

Unique identifier of the Line Group

Line Group Name

io_line_external_name

string

Name of the Line Group

Line item billable event

price_advertiser_event

string

Billable event for the line item

Line Item Targeting Mode

insertion_targeting_mode

string

Cookieless if the line item is forced to use only cookieless signals in its targeting, otherwise standard.

Line Start Date

insertion_start_date

string

Start date of the line item

Campaign Updated At

ad_updated_at

string

Advertiser Updated At

advertiser_updated_at

string

Line Group Updated At

io_line_updated_at

string

Line Item Updated At

insertion_updated_at

string

Creative Updated At

creative_updated_at

string

Creative ID

creative_id

string

Teads id of the creative

Creative name

creative_external_name

string

Name of the creative

Creative external integration code

creative_external_integration_code

string

Code for integrating with another reporting system

Creative portfolio item

portfolio_item_name

string

Commercial name of the creative type

Creative family

format_creative_type_family_name

string

Creative family (Video, Viewable Display, etc)

Creative type

format_creative_type_name

string

Creative type (Carousel, Scroller, etc)

Creative size

format_size_name

string

Creative size: (landscape, square, vertical, social)

Position

placement_format_integration_type

string

Position of the slot displaying the creative (values: in Article, instream etc.)

Studio Action

studio_action

string

Custom creative actions tracked through Teads Studio (ex: Click on Endscreen)

Studio creative id

studio_creative_id

string

Unique identifier of the Studio creative

Studio Segment

studio_segment

string

Unique identifier of a Studio creative's personalization segment, for dynamic creatives

Video or Display

business_common_video_or_display

string

Type of the creative delivered: video or display

Deal Currency

deal_currency

string

Currency of the Deal ID (i.e., USD, EUR)

Deal ID Key

deal_id_key

string

An identifier shared by the Publisher or Exchange for a Deal ID in their system

Deal Rate CPM

deal_rate_cpm

string

The minimum or fixed cost per thousand impressions (CPM) for the inventory associated with a Deal ID

Deal Rate Type

deal_rate_type

string

The rate type of the inventory. For example: Fixed or Dynamic

Auction has billable

auction_has_advertiser_billable

string

Auction has billable - TRUE if the impression was billed, FALSE otherwise. Computing if an event (impression, click, etc) was tracked as part of a billable session is based on a 30 minute window and could contain false negatives, when an event is part of a billable session but was tracked in a different time window. There are no false positives.

Country code

country_code

string

Country code of the user - ISO 3166-1 alpha-2 format, ex: US, FR

Country name

country_name

string

Country name of the user

City Name

city_name

string

Name of the country where the user saw the ad

Market Area Code

dma_code

string

Code of the market area where the user saw the ad

Market Area Name

dma_name

string

Name of the market area name where the user saw the ad

Postal Code

postal_code

string

Postal code where the user saw the ad

Region Code

region_code

string

Code of the region where the user saw the ad

Region Name

region_name

string

Name of the region where the user saw the ad

App Bundle ID

app_bundle_id

string

Unique identifier of the application on the application store

App Name

app_name

string

Name of the application

App Platform

app_platform

string

Platform or Operating System where the application is used

Channel

channel

string

Delivery channel of the line item (values: Web & Mobile App or CTV)

Website domain

website_domain

string

The domain of the website

Website or App

website_or_app

string

Website domain (if the impression happened on a website) or App Name / App Platform / App Bundle ID (if the impression happened on a CTV app)

Browser

browser

string

Name of browser

Browser version

browser_version

string

Version of browser

Device

device

string

Device: (Desktop, SmartTV, Smartphone, Tablet)

Operating System

operating_system

string

Operating system of the device where the ad was delivered

Metrics

Name

ID

Type

Description

Budget spent

turnover_value

number

Budget spent (i.e. invoiced by Teads). Includes Ad Manager fee. Does not include Added Value budget nor Agency fee.

Total ad cost

turnover_advertising_value

number

Budget spent on advertising cost. Does not include Added Value Budget, nor Ad Manager fee, nor Agency fee.

Fee

turnover_fee_value

number

Budget spent on Ad Manager fee cost

Budget delivered

budget_delivered_value

number

Advertiser budget consumed. Includes Added Value budget, Ad Manager fee and Agency fee.

Budget delivered Teads

budget_delivered_teads_value

number

Total value delivered by Teads. Includes Added Value budget and Ad Manager fee. Does not include Agency fee.

Budget delivered Agency Fee

budget_delivered_agency_fee_value

number

Agency fee. Not invoiced by Teads.

Budget Delivered Fee

budget_delivered_fee_value

string

TAM fee. It is invoiced by Teads.

Budget delivered Total Ad Cost

budget_delivered_advertising_value

number

Advertising value (media & data) delivered by Teads. Includes Added Value budget. Does not include Ad Manager fee nor Agency fee.

Budget spent - Cost per result

turnover_average_cost_per_result_value

number

Average price of each result, considering the budget spent (invoiced by Teads) and the total volume delivered.

Budget delivered - Cost per result

budget_delivered_average_cost_per_result_value

number

Average price of each result, based on the budget_delivered. This is the cost per result paid by the advertiser, including advertising cost, Ad Manager fee and Agency fee.

Budget delivered Teads - Cost per result

budget_delivered_teads_average_cost_per_result_value

number

Average price of each result, based on the budget_delivered_teads. This is the cost per result delivered by Teads, including advertising cost and Ad Manager fee.

Budget delivered Total Ad Cost - Cost per result

budget_delivered_advertising_average_cost_per_result_value

number

Average price of each result, based on the budget_delivered_advertising. This is the cost per result considering only the advertising cost.

Budget spent - CPM

turnover_average_cpm_value

number

Average price of a thousand impressions, considering the budget spent (invoiced by Teads) and the total volume delivered.

Budget delivered - CPM

budget_delivered_average_cpm_value

number

Average price of a thousand impressions (display) or starts (video), based on the budget_delivered. This is the CPM value paid by the advertiser, including advertising cost, Ad Manager fee and Agency fee.

Budget delivered Teads - CPM

budget_delivered_teads_average_cpm_value

number

Average price of a thousand impressions (display) or starts (video), based on the budget_delivered_teads. This is the CPM value delivered by Teads, including advertising cost and Ad Manager fee.

Budget delivered Total Ad Cost - CPM

budget_delivered_advertising_average_cpm_value

number

Average price of a thousand impressions (display) or starts (video), based on the budget_delivered_advertising. This is the CPM value considering only the advertising cost.

Budget spent - CPC

turnover_average_cpc_value

number

Average price of each click, considering the budget spent (invoiced by Teads) and the total volume delivered.

Budget delivered - CPC

budget_delivered_average_cpc_value

number

Average price of a click, based on the budget_delivered. This is the CPC value paid by the Advertiser, including advertising cost, Ad Manager fee and Agency fee.

Budget delivered Teads - CPC

budget_delivered_teads_average_cpc_value

number

Average price of a click, based on the budget_delivered_teads. This is the CPC value delivered by Teads, including advertising cost and Ad Manager fee.

Budget delivered Total Ad Cost - CPC

budget_delivered_advertising_average_cpc_value

number

Average price of a click, based on the budget_delivered_advertising. This is the CPC value considering only the advertising cost.

Billable impressions

advertiser_billable_volume

number

Number of results delivered

Cookieless Impressions

cookieless_impression

string

Number of impressions delivered using cookieless signals

Cookieless Impressions Rate

cookieless_impression_rate

string

Cookieless Impressions / Impression

Impressions

impression

number

Impressions

Video starts

video_start

number

Video starts

Video first quartile

video_firstQuartile

number

Video first quartile

Video midpoint

video_midpoint

number

Video midpoint

Video third quartile

video_thirdQuartile

number

Video third quartile

Video completes

video_complete

number

Video completes

Video completion rate

video_complete_rate

number

Video completion rate

Clicks

click

number

Clicks

Clickthrough rate

click_rate

number

Clickthrough rate

Post view conversions

post_view_conversion

number

Post view conversions

Post click conversions

post_click_conversion

number

Post click conversions

MOAT - Impressions Analyzed (unfiltered for IVT)

moat_analyzed_impression

number

MOAT - Impressions Analyzed (unfiltered for IVT)

MOAT - Impressions Analyzed (filtered for IVT)

moat_analyzed_impression_filtered

number

MOAT - Impressions Analyzed (filtered for IVT)

MOAT - In-View Measurable Impressions

moat_inview_measurable_impression

number

MOAT - In-View Measurable Impressions

MOAT - Valid and Viewable Impressions

moat_inview_viewable_impression

number

MOAT - Valid and Viewable Impressions

MOAT - Valid and Viewable %

moat_viewable_rate

number

MOAT - Valid and Viewable %

MOAT - Total In-View Time (ms)

moat_total_inview_time

number

MOAT - Total In-View Time (ms)

MOAT - Average In-View Time (ms)

moat_average_inview_time

number

MOAT - Average In-View Time (ms)

MOAT - Total Ad Length (ms)

moat_total_ad_length

number

MOAT - Total Ad Length (ms)

MOAT - Complete In-View Impressions

moat_video_complete_inview_impression

number

MOAT - Complete In-View Impressions

MOAT - Average Ad Length (ms)

moat_video_average_ad_length

number

MOAT - Average Ad Length (ms)

MOAT - 1 Sec In-View Impressions

moat_1s_inview_impression

number

MOAT - 1 Sec In-View Impressions

MOAT - 2 Sec In-View Impressions

moat_2s_inview_impression

number

MOAT - 2 Sec In-View Impressions

MOAT - 3 Sec In-View Impressions

moat_3s_inview_impression

number

MOAT - 3 Sec In-View Impressions

MOAT - 4 Sec In-View Impressions

moat_4s_inview_impression

number

MOAT - 4 Sec In-View Impressions

MOAT - 5 Sec In-View Impressions

moat_5s_inview_impression

number

MOAT - 5 Sec In-View Impressions

MOAT - 6 Sec In-View Impressions

moat_6s_inview_impression

number

MOAT - 6 Sec In-View Impressions

MOAT - 7 Sec In-View Impressions

moat_7s_inview_impression

number

MOAT - 7 Sec In-View Impressions

MOAT - 8 Sec In-View Impressions

moat_8s_inview_impression

number

MOAT - 8 Sec In-View Impressions

MOAT - 9 Sec In-View Impressions

moat_9s_inview_impression

number

MOAT - 9 Sec In-View Impressions

MOAT - 10 Sec In-View Impressions

moat_10s_inview_impression

number

MOAT - 10 Sec In-View Impressions

MOAT - 11 Sec In-View Impressions

moat_11s_inview_impression

number

MOAT - 11 Sec In-View Impressions

MOAT - 12 Sec In-View Impressions

moat_12s_inview_impression

number

MOAT - 12 Sec In-View Impressions

MOAT - 13 Sec In-View Impressions

moat_13s_inview_impression

number

MOAT - 13 Sec In-View Impressions

MOAT - 14 Sec In-View Impressions

moat_14s_inview_impression

number

MOAT - 14 Sec In-View Impressions

MOAT - 15 Sec In-View Impressions

moat_15s_inview_impression

number

MOAT - 15 Sec In-View Impressions

MOAT - 16 Sec In-View Impressions

moat_16s_inview_impression

number

MOAT - 16 Sec In-View Impressions

MOAT - 17 Sec In-View Impressions

moat_17s_inview_impression

number

MOAT - 17 Sec In-View Impressions

MOAT - 18 Sec In-View Impressions

moat_18s_inview_impression

number

MOAT - 18 Sec In-View Impressions

MOAT - 19 Sec In-View Impressions

moat_19s_inview_impression

number

MOAT - 19 Sec In-View Impressions

MOAT - 20 Sec In-View Impressions

moat_20s_inview_impression

number

MOAT - 20 Sec In-View Impressions

MOAT - 21 Sec In-View Impressions

moat_21s_inview_impression

number

MOAT - 21 Sec In-View Impressions

MOAT - 22 Sec In-View Impressions

moat_22s_inview_impression

number

MOAT - 22 Sec In-View Impressions

MOAT - 23 Sec In-View Impressions

moat_23s_inview_impression

number

MOAT - 23 Sec In-View Impressions

MOAT - 24 Sec In-View Impressions

moat_24s_inview_impression

number

MOAT - 24 Sec In-View Impressions

MOAT - 25 Sec In-View Impressions

moat_25s_inview_impression

number

MOAT - 25 Sec In-View Impressions

MOAT - 26 Sec In-View Impressions

moat_26s_inview_impression

number

MOAT - 26 Sec In-View Impressions

MOAT - 27 Sec In-View Impressions

moat_27s_inview_impression

number

MOAT - 27 Sec In-View Impressions

MOAT - 28 Sec In-View Impressions

moat_28s_inview_impression

number

MOAT - 28 Sec In-View Impressions

MOAT - 29 Sec In-View Impressions

moat_29s_inview_impression

number

MOAT - 29 Sec In-View Impressions

MOAT - 30 Sec In-View Impressions

moat_30s_inview_impression

number

MOAT - 30 Sec In-View Impressions

MOAT - Complete In-View Impressions

moat_complete_inview_impression

number

MOAT - Complete In-View Impressions

Video progress 1 second

video_progress_1

number

Video progress 1 second

Video progress 2 second

video_progress_2

number

Video progress 2 second

Video progress 3 second

video_progress_3

number

Video progress 3 second

Video progress 4 second

video_progress_4

number

Video progress 4 second

Video progress 5 second

video_progress_5

number

Video progress 5 second

Video progress 6 second

video_progress_6

number

Video progress 6 second

Video progress 7 second

video_progress_7

number

Video progress 7 second

Video progress 8 second

video_progress_8

number

Video progress 8 second

Video progress 9 second

video_progress_9

number

Video progress 9 second

Video progress 10 second

video_progress_10

number

Video progress 10 second

Video progress 11 second

video_progress_11

number

Video progress 11 second

Video progress 12 second

video_progress_12

number

Video progress 12 second

Video progress 13 second

video_progress_13

number

Video progress 13 second

Video progress 14 second

video_progress_14

number

Video progress 14 second

Video progress 15 second

video_progress_15

number

Video progress 15 second

Video progress 16 second

video_progress_16

number

Video progress 16 second

Video progress 17 second

video_progress_17

number

Video progress 17 second

Video progress 18 second

video_progress_18

number

Video progress 18 second

Video progress 19 second

video_progress_19

number

Video progress 19 second

Video progress 20 second

video_progress_20

number

Video progress 20 second

Video progress 21 second

video_progress_21

number

Video progress 21 second

Video progress 22 second

video_progress_22

number

Video progress 22 second

Video progress 23 second

video_progress_23

number

Video progress 23 second

Video progress 24 second

video_progress_24

number

Video progress 24 second

Video progress 25 second

video_progress_25

number

Video progress 25 second

Video progress 26 second

video_progress_26

number

Video progress 26 second

Video progress 27 second

video_progress_27

number

Video progress 27 second

Video progress 28 second

video_progress_28

number

Video progress 28 second

Video progress 29 second

video_progress_29

number

Video progress 29 second

Video progress 30 second

video_progress_30

number

Video progress 30 second

Display 1 second view

display_progress_1

number

Display 1 second view

Display 2 second view

display_progress_2

number

Display 2 second view

Display 3 second view

display_progress_3

number

Display 3 second view

Display 4 second view

display_progress_4

number

Display 4 second view

Display 5 second view

display_progress_5

number

Display 5 second view

Display 6 second view

display_progress_6

number

Display 6 second view

Display 7 second view

display_progress_7

number

Display 7 second view

Display 8 second view

display_progress_8

number

Display 8 second view

Display 9 second view

display_progress_9

number

Display 9 second view

Display 10 second view

display_progress_10

number

Display 10 second view

Display 11 second view

display_progress_11

number

Display 11 second view

Display 12 second view

display_progress_12

number

Display 12 second view

Display 13 second view

display_progress_13

number

Display 13 second view

Display 14 second view

display_progress_14

number

Display 14 second view

Display 15 second view

display_progress_15

number

Display 15 second view

Display 16 second view

display_progress_16

number

Display 16 second view

Display 17 second view

display_progress_17

number

Display 17 second view

Display 18 second view

display_progress_18

number

Display 18 second view

Display 19 second view

display_progress_19

number

Display 19 second view

Display 20 second view

display_progress_20

number

Display 20 second view

Display 21 second view

display_progress_21

number

Display 21 second view

Display 22 second view

display_progress_22

number

Display 22 second view

Display 23 second view

display_progress_23

number

Display 23 second view

Display 24 second view

display_progress_24

number

Display 24 second view

Display 25 second view

display_progress_25

number

Display 25 second view

Display 26 second view

display_progress_26

number

Display 26 second view

Display 27 second view

display_progress_27

number

Display 27 second view

Display 28 second view

display_progress_28

number

Display 28 second view

Display 29 second view

display_progress_29

number

Display 29 second view

Display 30 second view

display_progress_30

number

Display 30 second view

Estimated number of unique Teads IDs exposed to the ad

uv_impression

number

This metric is only compatible with specific dimensions & metrics (learn more)

Aggregate amount of eyes on visual attention received by 1,000 impressions

lumen_attention_per_1000_impressions

number

Aggregate amount of eyes on visual attention received by 1,000 impressions, as estimated by Lumen attention models.

Average amount of time - in seconds - that viewed ads were looked at

lumen_average_dwell_time

number

Average amount of time - in seconds - that viewed ads were looked at, as estimated by Lumen attention models.

% of impressions receiving at least 1 eye fixation (minimum duration 100ms)

lumen_average_view_rate

number

% of impressions receiving at least 1 eye fixation (minimum duration 100ms), as estimated by Lumen attention models.

Scope3 - Ad Selection Emissions

scope3_ad_selection_emissions

number

Ad tech supply emissions including servers and cloud computing; analytics; network traffic; storage; data providers; and vendor overhead. Unit: grams of CO₂ equivalent (gCO₂e)

Scope3 - Creative Distribution Emissions

scope3_creative_distribution_emissions

number

Emissions associated with the data transfer of the creative asset. Unit: grams of CO₂ equivalent (gCO₂e)

Scope3 - Media Distribution Emissions

scope3_media_distribution_emissions

number

Media delivery including CMS; CDNs and hosting services; publishing overhead including employee and office expenses; data transfer. Unit: grams of CO₂ equivalent (gCO₂e)

Scope3 - Media Consumer Device Emissions

scope3_media_consumer_device_emissions

number

Emissions associated with the consumer device during media consumption. Includes both emissions based on the use of the device and embodied emissions of the device. Unit: grams of CO₂ equivalent (gCO₂e)

Scope3 - Creative Consumer Device Emissions

scope3_creative_consumer_device_emissions

number

Emissions associated with the consumer device during ad exposure. Includes both emissions based on the use of the device and embodied emissions of the device. Unit: grams of CO₂ equivalent (gCO₂e)

Scope3 - Total Emissions

scope3_total_emissions

number

Sum of all the five emissions metrics above. Unit: grams of CO₂ equivalent (gCO₂e)

Scope3 - Total Emissions Without Device

scope3_total_emissions_without_device

number

Sum of the Ad Selection, Creative Distribution and Media Distribution emissions metrics. Unit: grams of CO₂ equivalent (gCO₂e)

Scope3 - Measured Impressions

scope3_measured_impressions

number

Number of impressions for which the Scope3 API returned emissions. Unit: Impression

Scope3 - Total Emissions per Mille

scope3_total_emissions_per_mille

number

Carbon score per Mille including all the emissions metrics. Unit: grams of CO₂ equivalent per 1000 impressions (gCO2PM)

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.