Atlas API Version

Reach and Frequency Report Column Definition Fields

When creating a report, specify the following values in the report_column_definition field for getting corresponding data back in the result report. All the fields need to be specified correclty, if the values are wrong, then the report creation will fail.

Please note that all report definitions that include the rf_reach_people and/or the rf_freq_people fields require you to also include the rf_comment_people field in the definition or the report creation will fail. campaign_name is also required field for all Reach and Frequency reports.

keynameareaaggregation_usagedescription

advertiser_id

Advertiser ID

serving

dimension

The id of the advertiser.

advertiser_name

Advertiser Name

serving

dimension

The name of the advertiser.

age

Age

serving

dimension

The age of the user

branch_id

Branch ID

serving

dimension

The ID of the branch.

branch_name

Branch Name

serving

dimension

The name of the branch.

campaign_alias

External Campaign ID

serving

dimension

The external ID of the campaign.

campaign_begin_date

Campaign Start Date

serving

dimension

The start date of the campaign.

campaign_custom_params

Campaign Custom Parameters

serving

dimension

The custom parameters associated with the campaign.

campaign_end_date

Campaign End Date

serving

dimension

The end date of the campaign.

campaign_id

Campaign ID

serving

dimension

The id of the campaign.

campaign_name

Campaign Name

serving

dimension

The name of the campaign.

campaign_type

Campaign Type

serving

dimension

The type of campaign (e.g. display or search).

client_id

Client ID

serving

dimension

The ID of the client.

client_name

Client Name

serving

dimension

The name of the client.

company_id

Company ID

serving

dimension

The ID of the company.

company_name

Company Name

serving

dimension

The name of the company.

counters_impressions

Impressions

serving

metric

The number of delivered impressions.

gender

Gender

serving

dimension

The gender of the user

placement_alias

Alternate Placement ID

serving

dimension

The alternate id of the placement.

placement_height

Placement Height

serving

dimension

The height in pixels of the placement.

placement_id

Placement ID

serving

dimension

The id of the placement.

placement_name

Placement Name

serving

dimension

The name of the placement.

placement_type

Placement Type

serving

dimension

The type of placement (display, tracking, etc.)

placement_width

Placement Width

serving

dimension

The width in pixels of the placement.

publisher_id

Publisher ID

serving

dimension

The id of the publisher

publisher_name

Publisher Name

serving

dimension

The publisher from which the placements were purchased.

rf_comment_people

Reach (People) and Frequency (People) Details

serving

metric

Information regarding the identity-based reach and frequency calculation.

rf_device_type

Impression Device Type

serving

dimension

The device type of the user who received the ad

rf_freq_people

Frequency (People)

serving

metric

The average number of times that a user (identity-based) was shown an ad.

rf_freq_raw_cookie

Frequency (Cookie)

serving

metric

The average number of times that a user (cookie-based) was shown an ad.

rf_reach_people

Reach (People)

serving

metric

The number of unique users (identity-based) that received an impression.

rf_reach_raw_cookie

Reach (Cookie)

serving

metric

The number of unique users (cookie-based) that received an impression.

site_id

Site ID

serving

dimension

The id of the site

site_name

Site Name

serving

dimension

The site on which the placements ran.

statistics_date

Statistics Date

serving

dimension

The day for which the statistics apply. You must select this column to see results by day.