API - Reporting Filters, Dimensions and Metrics

This section will cover all filters, dimensions and metrics that are available in the Reporting API

Updated over a week ago

Reporting Filters

Technical name

Type

Required

Definition

date

Object

Yes

Flight dates for the report

date.start

String

Yes

Lower-bound timestamp (ISO8601 format)

date.end

String

Yes

Upper-bound timestamp (ISO8601 format)

date.timezone

String

Yes

The timezone you would like the report to be rendered in: used to resolve DST shifts (should be provided if filters.date.start is specified in UTC/GMT). For UTC use Etc/GMT+0

Examples

  • Etc/GMT+0

  • America/New_York

  • Europe/Rome

ad_owner

Number[]

No

Filter on the seat ids.

When filter is not used, the report will only contain data for the seat where the API key is created.

When the ad_owner parameter is set as an empty array, the report will be associated with all available seats for the user.

advertisers

Number[]

No

Filter on the advertiser ids.

ads

Number[]

No

Filter on campaign ids

country

String[]

No

Filter on country code id - ISO 3166-1 alpha-2 format, ex: US, FR

device

String[]

No

Filter on device

  • Desktop

  • SmartTV

  • Smartphone

  • Tablet

Reporting Dimensions

Technical Name in API

Human Name in CSV and explanation

hour

Hour

Hour for the data

day

Day

Day for the data

month

Month

Month for the data (ISO8601 format containing first day in month)

year

Year

Year for the data (ISO8601 format containing first day in year)

ad_owner_id

Seat id

Teads Ad Manager Seat id

ad_owner_name

Seat name

Teads Ad Manager Seat name

advertiser_id

Advertiser ID

Teads id of the advertiser

advertiser_name

Advertiser name

Name of the advertiser

ad_id

Campaign ID

Teads id of the campaign

ad_external_name

Campaign name

Name of the campaign

io_currency

Campaign currency

Currency of the campaign

io_budget

Campaign budget

Total budget of the campaign

io_line_id

Line item ID

Teads id of the line item

io_line_external_name

Line item name

Name of the line item

io_line_budget

Line item budget

Budget of the line item

price_advertiser_event

Line item billable event

Billable event for the line item

creative_id

Creative ID

Teads id of the creative

creative_external_name

Creative name

Name of the creative

creative_external_integration_code

Creative external integration code

Code for integrating with another reporting system

portfolio_item_name

Creative portfolio item

Commercial name of the creative type

format_creative_type_family_name

Creative family

Creative family (Video, Viewable Display, etc)

format_creative_type_name

Creative type

Creative type (Carousel, Scroller, etc)

format_size_name

Creative size

Creative size:

  • landscape

  • square

  • vertical

  • social

auction_has_advertiser_billable

Auction has billable

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.

browser

Browser

Name of browser

browser_version

Browser version

Version of browser

device

Device

Device:

  • Desktop

  • SmartTV

  • Smartphone

  • Tablet

country_code

Country code

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

country_name

Country name

Country name of the user

website_domain

Website domain

The domain of the website

website_or_app

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)

Reporting Metrics

Metric Name in Reporting

Definition of Metric

turnover_value

Budget spent

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

turnover_advertising_value

Total ad cost

Budget spent on advertising cost

Does not include Added Value Budget, nor Ad Manager fee, nor Agency fee.

turnover_fee_value

Fee

Budget spent on Ad Manager fee cost

budget_delivered_value

Budget delivered

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

budget_delivered_teads_value

Budget delivered Teads

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

budget_delivered_agency_fee_value

Budget delivered Agency Fee

Agency fee. Not invoiced by Teads.

budget_delivered_advertising_value

Budget delivered Total Ad Cost

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

budget_delivered_platform_fee_value

Budget delivered Fee

Ad Manager fee

turnover_average_cost_per_result_value

Budget spent - Cost per result

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

budget_delivered_average_cost_per_result_value

Budget delivered - Cost per result

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_average_cost_per_result_value

Budget delivered Teads - Cost per result

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_advertising_average_cost_per_result_value

Budget delivered Total Ad Cost - Cost per result

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

turnover_average_cpm_value

Budget spent - CPM

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

budget_delivered_average_cpm_value

Budget delivered - CPM

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_average_cpm_value

Budget delivered Teads - CPM

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_advertising_average_cpm_value

Budget delivered Total Ad Cost - CPM

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.

turnover_average_cpc_value

Budget spent - CPC

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

budget_delivered_average_cpc_value

Budget delivered - CPC

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_average_cpc_value

Budget delivered Teads - CPC

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_advertising_average_cpc_value

Budget delivered Total Ad Cost - CPC

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

advertiser_billable_volume

Billable impressions

Number of results delivered

impression

Impressions

video_start

Video starts

progress-1

1 second view

progress-2

2 second view

progress-3

3 second view

progress-4

4 second view

progress-5

5 second view

progress-6

6 second view

progress-7

7 second view

progress-8

8 second view

progress-9

9 second view

progress-10

10 second view

progress-11

11 second view

progress-12

12 second view

progress-13

13 second view

progress-14

14 second view

progress-15

15 second view

progress-16

16 second view

progress-17

17 second view

progress-18

18 second view

progress-19

19 second view

progress-20

20 second view

progress-21

21 second view

progress-22

22 second view

progress-23

23 second view

progress-24

24 second view

progress-25

25 second view

progress-26

26 second view

progress-27

27 second view

progress-28

28 second view

progress-29

29 second view

progress-30

30 second view

video_firstQuartile

Video first quartile

video_midpoint

Video midpoint

video_thirdQuartile

Video third quartile

video_complete

Video completes

video_complete-rate

Video completion rate

click

Clicks

click-rate

Clickthrough rate

post_view_conversion

Post view conversions

post_click_conversion

Post click conversions

moat_analyzed_impression

MOAT - Impressions Analyzed (unfiltered for IVT)

moat_analyzed_impression_filtered

MOAT - Impressions Analyzed (filtered for IVT)

moat_inview_measurable_impression

MOAT - In-View Measurable Impressions

moat_inview_viewable_impression

MOAT - Valid and Viewable Impressions

moat_viewable_rate

MOAT - Valid and Viewable %

moat_total_inview_time

MOAT - Total In-View Time (ms)

moat_average_inview_time

MOAT - Average In-View Time (ms)

moat_total_ad_length

MOAT - Total Ad Length (ms)

moat_video_complete_inview_impression

MOAT - Complete In-View Impressions

moat_video_average_ad_length

MOAT - Average Ad Length (ms)

moat_1s_inview_impression

MOAT - 1 Sec In-View Impressions

moat_2s_inview_impression

MOAT - 2 Sec In-View Impressions

moat_3s_inview_impression

MOAT - 3 Sec In-View Impressions

moat_4s_inview_impression

MOAT - 4 Sec In-View Impressions

moat_5s_inview_impression

MOAT - 5 Sec In-View Impressions

moat_6s_inview_impression

MOAT - 6 Sec In-View Impressions

moat_7s_inview_impression

MOAT - 7 Sec In-View Impressions

moat_8s_inview_impression

MOAT - 8 Sec In-View Impressions

moat_9s_inview_impression

MOAT - 9 Sec In-View Impressions

moat_10s_inview_impression

MOAT - 10 Sec In-View Impressions

moat_11s_inview_impression

MOAT - 11 Sec In-View Impressions

moat_12s_inview_impression

MOAT - 12 Sec In-View Impressions

moat_13s_inview_impression

MOAT - 13 Sec In-View Impressions

moat_14s_inview_impression

MOAT - 14 Sec In-View Impressions

moat_15s_inview_impression

MOAT - 15 Sec In-View Impressions

moat_16s_inview_impression

MOAT - 16 Sec In-View Impressions

moat_17s_inview_impression

MOAT - 17 Sec In-View Impressions

moat_18s_inview_impression

MOAT - 18 Sec In-View Impressions

moat_19s_inview_impression

MOAT - 19 Sec In-View Impressions

moat_20s_inview_impression

MOAT - 20 Sec In-View Impressions

moat_21s_inview_impression

MOAT - 21 Sec In-View Impressions

moat_22s_inview_impression

MOAT - 22 Sec In-View Impressions

moat_23s_inview_impression

MOAT - 23 Sec In-View Impressions

moat_24s_inview_impression

MOAT - 24 Sec In-View Impressions

moat_25s_inview_impression

MOAT - 25 Sec In-View Impressions

moat_26s_inview_impression

MOAT - 26 Sec In-View Impressions

moat_27s_inview_impression

MOAT - 27 Sec In-View Impressions

moat_28s_inview_impression

MOAT - 28 Sec In-View Impressions

moat_29s_inview_impression

MOAT - 29 Sec In-View Impressions

moat_30s_inview_impression

MOAT - 30 Sec In-View Impressions

moat_complete_inview_impression

MOAT - Complete In-View Impressions

video_progress-1

Video progress 1 second

video_progress-2

Video progress 2 second

video_progress-3

Video progress 3 second

video_progress-4

Video progress 4 second

video_progress-5

Video progress 5 second

video_progress-6

Video progress 6 second

video_progress-7

Video progress 7 second

video_progress-8

Video progress 8 second

video_progress-9

Video progress 9 second

video_progress-10

Video progress 10 second

video_progress-11

Video progress 11 second

video_progress-12

Video progress 12 second

video_progress-13

Video progress 13 second

video_progress-14

Video progress 14 second

video_progress-15

Video progress 15 second

video_progress-16

Video progress 16 second

video_progress-17

Video progress 17 second

video_progress-18

Video progress 18 second

video_progress-19

Video progress 19 second

video_progress-20

Video progress 20 second

video_progress-21

Video progress 21 second

video_progress-22

Video progress 22 second

video_progress-23

Video progress 23 second

video_progress-24

Video progress 24 second

video_progress-25

Video progress 25 second

video_progress-26

Video progress 26 second

video_progress-27

Video progress 27 second

video_progress-28

Video progress 28 second

video_progress-29

Video progress 29 second

video_progress-30

Video progress 30 second

display_progress-1

Display 1 second view

display_progress-2

Display 2 second view

display_progress-3

Display 3 second view

display_progress-4

Display 4 second view

display_progress-5

Display 5 second view

display_progress-6

Display 6 second view

display_progress-7

Display 7 second view

display_progress-8

Display 8 second view

display_progress-9

Display 9 second view

display_progress-10

Display 10 second view

display_progress-11

Display 11 second view

display_progress-12

Display 12 second view

display_progress-13

Display 13 second view

display_progress-14

Display 14 second view

display_progress-15

Display 15 second view

display_progress-16

Display 16 second view

display_progress-17

Display 17 second view

display_progress-18

Display 18 second view

display_progress-19

Display 19 second view

display_progress-20

Display 20 second view

display_progress-21

Display 21 second view

display_progress-22

Display 22 second view

display_progress-23

Display 23 second view

display_progress-24

Display 24 second view

display_progress-25

Display 25 second view

display_progress-26

Display 26 second view

display_progress-27

Display 27 second view

display_progress-28

Display 28 second view

display_progress-29

Display 29 second view

display_progress-30

Display 30 second view

uv_impression

Estimated number of unique Teads IDs exposed to the ad.

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

lumen_attention_per_1000_impressions

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

lumen_average_dwell_time

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

lumen_average_view_rate

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

Did this answer your question?