Documentation

Response: report fields

The report is generated in TSV format.

The first row in the report contains the report name that is set in the ReportName
[no-highlight[

Name of the report. Shown in the first row in the report.

In offline mode, the report name must be unique for the advertiser. If a report with the same name but different parameters has already been generated or is in the queue, an error is returned.

Required

Yes

]no-highlight]
parameter, along with the start and end dates of the reporting period. This row is not included in the report if the request specifies the HTTP header skipReportHeader: true.
The second row contains the names of the fields (columns) that are set in the FieldNames
[no-highlight[

Names of fields (columns) that will be in the report.

To see which fields you can specify, see the sections Allowed fields and Incompatible fields and dependencies.

Required

Yes

]no-highlight]
parameter. This row is not included in the report if the request specifies the HTTP header skipColumnHeader: true.

The following rows contain the statistics (the values for the fields).

The last row in the report contains the number of rows with statistics. This row is not included in the report if the request specifies the HTTP header skipReportSummary: true.

The fields are described in the table below.

Field Description
AdFormat

Format of the ad impression:

  • IMAGE — With an image.

  • TEXT — A text ad.

  • VIDEO — With video.

  • SMART_MULTIPLE — Smart banner.

  • SMART_SINGLE — Smart ad.

AdGroupId ID of the ad group.
AdGroupName Name of the ad group.
AdId The ad ID.
AdNetworkType

The type of advertising place where the ad is shown:

  • SEARCH — In search results.

  • AD_NETWORK — On ad networks.

Age The user's age group: one of the values AGE_0_17, AGE_18_24, AGE_25_34, AGE_35_44, AGE_45 or UNKNOWN.
AvgClickPosition Average position where the ad was clicked. Calculated using only clicks on the first page of Yandex search results. The top position is assigned the number 1.
AvgCpc Average cost per click.
AvgImpressionPosition Average display position of the ad. Calculated using only displays on the first page of Yandex search results. The top position is assigned the number 1.
AvgPageviews The average session depth on the site, meaning the number of pages viewed (according to Yandex.Metrica data).
BounceRate The percentage of bounces in the total number of sessions (according to Yandex.Metrica data).
Bounces The number of bounces (according to Yandex.Metrica data).
CampaignId The campaign ID.
CampaignName The campaign name.
CampaignType

The type of campaign:

  • TEXT_CAMPAIGN

  • MOBILE_APP_CAMPAIGN

  • DYNAMIC_TEXT_CAMPAIGN

  • SMART_BANNER_CAMPAIGN

See the section Campaign type.

CarrierType

The type of connection:

  • CELLULAR — Mobile connection.
  • STATIONARY — Wi-Fi or wired internet access.
  • UNKNOWN — The type couldn't be detected.
Clicks The number of clicks.
ClickType Which part of the ad was clicked by the user:
  • TITLE — The ad title.

  • SITELINK1, SITELINK2, SITELINK3, SITELINK4 — Sitelinks.

  • VCARD — The virtual business card.

  • DISPLAY_URL_PATH — A displayed link.

  • MOBILE_APP_ICON — The app icon (for mobile app ads).

  • BUTTON — The download or install button (for mobile app ads).

  • UNKNOWN.

ConversionRate

Conversions as a percent of the total number of sessions (according to Yandex.Metrica data).

Conversions

The number of conversions (according to Yandex.Metrica data).

Cost The cost of clicks.
CostPerConversion

The average cost of reaching a goal (according to Yandex.Metrica data): the ratio of the cost of clicks to the number of conversions.

Criteria

Name or text of the targeting criteria:

  • For targeting a keyword or synonym – the keyword text.

  • For autotargeting – the “---autotargeting” value.

  • For targeting a related keyword:

    • an empty value, if the report type is CUSTOM_REPORT.
    • the text of the related keyword, if the report type is SEARCH_QUERY_PERFORMANCE_REPORT.
  • For targeting an audience target – the name of the retargeting list, or the name of a mobile app category.

  • For showing a dynamic ad – the name of the dynamic text ad target, or the name of the filter.

  • For showing smart banners – the name of the filter.

CriteriaId

ID of the targeting criteria:

  • For targeting a keyword or synonym – the keyword ID.

  • For autotargeting – the autotargeting ID.

  • For targeting a related keyword – a dash.

  • For targeting an audience target – the ID of the audience target.

  • For showing a dynamic ad – the ID of the dynamic text ad target, or the ID of the filter.

  • For showing smart banners – the ID of the filter.

CriteriaType

The type of targeting criteria set by the advertiser:

  • KEYWORD — Keyword.

  • AUTOTARGETING — Autotargeting.

  • AUDIENCE_TARGET — Audience target.

  • DYNAMIC_TEXT_AD_TARGET — Dynamic text ad target or filter for dynamic ads.

  • SMART_BANNER_FILTER — Filter for smart banners.

Criterion

The name or text of the targeting criteria set by the advertiser:

  • For targeting a keyword or synonym – the keyword text.

  • For displays for a related keyword – the keyword text, or the value “automatically added phrase” if the keyword couldn't be determined.

  • For autotargeting – the “---autotargeting” value.

  • For targeting an audience target – the name of the retargeting list, or the name of a mobile app category.

  • For showing a dynamic ad – the name of the dynamic text ad target, or the name of the filter.

  • For showing smart banners – the name of the filter.

We recommend using this field instead of Criteria.

CriterionId

The ID of the targeting criteria set by the advertiser:

  • For targeting a keyword or synonym – the keyword ID.

  • For targeting a related keyword – the ID of the keyword, or a dash if the keyword couldn't be determined.

  • For autotargeting – the autotargeting ID.

  • For targeting an audience (using a retargeting list or interest in a mobile app category) – the ID of the audience target.

  • For a dynamic text ad target generated from site pages – the ID of the dynamic text ad target.

  • For a filter for dynamic ads generated from a feed, or a filter for smart banners – the filter ID.

We recommend using this field instead of CriteriaId.

CriterionType

The type of targeting criteria set by the advertiser:

  • KEYWORD — Keyword.

  • AUTOTARGETING — Autotargeting.

  • RETARGETING — Audience target based on a retargeting list.

  • MOBILE_APP_CATEGORY — Audience target based on interest in a mobile app category.

  • WEBPAGE_FILTER — Dynamic text ad target for dynamic ads generated based on site pages.

  • FEED_FILTER — Filter for dynamic ads generated from a feed, or a filter for smart banners.

We recommend using this field instead of CriteriaType.

Ctr CTR as a percent.
Date The data statistics are provided for, in the format YYYY-MM-DD.
Device The type of device the ad was shown on: DESKTOP, MOBILE or TABLET.
ExternalNetworkName The name of the ad exchange (SSP).
Gender The user's gender: GENDER_MALE, GENDER_FEMALE or UNKNOWN.
GoalsRoi

The return on investment in advertising, up to two decimal places (according to Yandex.Metrica data):

Impressions Number of impressions.
ImpressionShare

The percentage of auctions won out of the total number of auctions that the ad materials participated in. Data is only available for smart banners.

LocationOfPresenceId ID of the region where the user is located.
LocationOfPresenceName Name of the region where the user is located.
MatchedKeyword

The matched keyword:

  • For targeting a keyword synonym – the synonym text.

  • For targeting a related keyword – the text of the related keyword.

  • For showing a dynamic ad – the text of the keyword that was generated automatically on the main page of the advertised site or product offer from a feed.

  • In other cases – an empty value.

MatchType

Keyword match type:

  • RELATED_KEYWORD — Impression for a related keyword.

  • SYNONYM — Impression for a keyword synonym.

  • NONE — All other cases.

MobilePlatform OS type: ANDROID, IOS, OTHER or UNKNOWN.
Month Date of the start of the month, in the format YYYY-MM-DD.
Placement Name of the site where the ad is being displayed.
Quarter Date of the start of the quarter, in the format YYYY-MM-DD.
Query The search query that triggered the ad.
Revenue

Revenue (according to Yandex.Metrica data).

RlAdjustmentId ID of a retargeting list used for applying bid adjustments for website users.
Sessions

Number of sessions (according to Yandex.Metrica data).

For mobile app ads, the number of clicks is shown as the number of visits.

Slot

The ad display place:

  • PREMIUMBLOCK — Premium Placement.

  • OTHER — Other ad blocks.

TargetingLocationId ID of the targeting region. If extended geotargeting is used, it may differ from the region of the user's location. See Geotargeting in the Help for Yandex.Direct.
TargetingLocationName Name of the targeting region.
Week Date of the start of the week (Monday), in the format YYYY-MM-DD.
Year Date of the start of the year, in the format YYYY-MM-DD.