> ## Documentation Index > Fetch the complete documentation index at: https://docs.hakumedia.ai/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve Reports > Retrieve an overview of information collected from your ad serving, which can be filtered using the parameters below. ## OpenAPI ````yaml /openapi/haku.json get /reports openapi: 3.0.0 info: title: Haku API version: '2.0' description: >- API de Haku Ad Server. Las URLs son predecibles y orientadas a recursos; todas las respuestas, incluidos los errores, son JSON. servers: - url: https://api.hakumedia.ai/v2 security: - API Key: [] tags: - name: Ad Items (All) description: >- An ad item is an object where you enter the details of an individual ad. There are different types of ad items, each corresponding to a different medium or source. The different types of Ad Items are: - __Image__ - Ads made of a static image. They are delivered using the `image` HTML tag and wrapped in an <a> tag to direct clicks. These are typically either affiliate links or email ads. - __Rich Media__ - Also known as HTML5 ads, these allow you to serve dynamic, animated, and interactive ads in lieu of the legacy Flash format. HTML5 ads are typically uploaded as ZIP archives, and include HTML, scripts, styles, and media as a self-contained package. __NOTE__: Haku accepts only HTML5 ZIP archives that contain 200 files or fewer. - __Custom HTML__ - Also known as third party tags, these are custom ads or scripts, typically used when you want to serve ads from an ad exchange or other external source. - __Native__ - For native ads, which rely on native ad templates. - __S2S Connection__ - Ads from other ad networks, delivered via a server-to-server connection. __NOTE__: Soon to be deprecated, since demand sources can now be managed under the Programmatic section of the Haku interface. x-group: Campañas - name: Ad Items / Image description: >-

Image ad items (commonly known as "display ads") are an effective medium for delivering advertising messages across multiple platforms. They are easy to setup and configure because they require only a creative (i.e. an image file) and, when applicable, a destination URL to which users will be redirected when the ad is clicked.

In general, ad items are assigned to an advertiser campaign, and in turn the campaign to a zone. Ad items can also be assigned directly to a zone, but we recommend doing so only if the ad items are directly related to that zone's publisher or are intended to be default/house ads.

x-group: Campañas - name: Ad Items / Custom HTML description: >-

Creating a custom HTML ad item is the best option if you need to serve a third-party advertisement from an ad network or another advertiser, or if you want to create an ad that cannot be achieved using traditional display advertising.

Custom HTML ad items allow you to implement virtually any type of ad using Haku’s ad serving macros and a text box.

In general, ad items are assigned to an advertiser campaign, and in turn the campaign to a zone. Ad items can also be assigned directly to a zone, but we recommend doing so only if the ad items are directly related to that zone's publisher or are intended to be default/house ads.

x-group: Campañas - name: Ad Items / Native description: >- Native ad items use native templates to create seamless editorial content.

You can read more about native ads and how they are used in our help documentation. x-group: Campañas - name: Ad Items / Companion Products description: >-

Ad item companion products link an ad item to a product in a product DB catalog. Each companion product belongs to a single ad item and references a specific product via a catalog ID and product identifier (SKU).

Companion products are nested under ad items and can be managed under both /ad-items/image/{ad_item_id}/companions/products and /ad-items/native/{ad_item_id}/companions/products.

Requires the Display Ad Item Companions and Product DB Replicated features.

x-group: Retail media - name: AdServe description: > For server-side ad requests via JSON API, use the adserve endpoint to request ad items in JSON format from the ad server.

The ad response will include details of your advertisement and relevant tracking information. The ad item can then be styled before being displayed to the user for a truly native ad - one that matches the look and feel of its display environment. JSON ads can be displayed on web sites, mobile apps, chatbots, billboards, smart mirrors, elevators, and many other platforms.

Ad serve requests are made to a separate server: `https://ads.hakumedia.ai`. x-group: Ad serving - name: Advertisers description: >- An advertiser is an individual or a company looking to purchase ad space for their advertisements. Administrators and managers (if permitted) can create advertiser accounts, create new advertisements, and copy conversion tags. Advertiser user accounts can also be permitted to schedule new campaigns. x-group: Campañas - name: Campaigns (All) description: >+ Campaigns are groups of ad items. Instead of creating an ad item within a zone, you can assign one or more ad items to a campaign. You can then serve those ad items by assigning that campaign to one or more zones. We highly recommend assigning ad items to campaigns instead of directly into zones. Ad items created directly within a zone cannot be assigned to other zones, whereas ad items in campaigns can be served to multiple zones. Campaigns also make it much easier to track the performance and statistics of related ad items. We recommend creating an ad item directly within a zone only if the ad item is meant to be a default or fallback ad. When you assign a campaign to a zone, you assign all the ad items under that campaign to that zone. The ad items will have the same assignment details, but each ad item can be assigned a specific weight to allow you to prioritize one over another. If a campaign contains ad items of varying sizes, only ad items compatible with the requesting zone will be considered for serving. There are two types of campaigns. A Standard Campaign is for most ad items types, including images, HTML/Rich media, and email ads. A VAST Campaign is for VAST ad items. x-group: Campañas - name: Campaigns / Standard description: >- A standard campaign is a group of image ads, HTML5/Rich Media ads, custom HTML ads, or email ads. Standard campaigns can be scheduled to serve in the zones of your choice (except for VAST zones, which are compatible only with VAST campaigns), enabling you to easily collect grouped statistics and determine payouts for advertisers. Campaigns do not have size restrictions, which means you can assign ad items of varying sizes to the same campaign. However, only the ad items compatible with the requesting zone will be considered for serving. x-group: Campañas - name: Campaign Assignments description: >- A campaign assignment represents the relationship between an ad item and a campaign. x-group: Campañas - name: Ad Items / Catalog Item description: >-

Ad items represent the particular catalog item (product) being promoted. One or more catalog ad items may be assigned to a campaign.

x-group: Retail media - name: Ad Items / Catalog Item / Bulk description: >-

Bulk operations for catalog ad items. These endpoints allow you to create or delete multiple catalog ad items at once and assign them to campaigns.

x-group: Retail media - name: Zones / Catalog description: >-

A catalog zone is the representation of a source of promoted product ads. Advertiser campaigns would be assigned to catalog zones (called a placement), making them eligible to be matched against when making an ad request.

x-group: Retail media - name: Creatives (All) description: >- Creatives are the displayed part of an ad item. It can be an image, HTML5/rich media, custom HTML, or video. x-group: Campañas - name: Creatives / Image description: >- The image file that makes up an advertisement is known as the image creative. You can create a new image creative, retrieve one or more image creatives, update an existing image creative, or delete the image creative. x-group: Campañas - name: Data Keys description: >- Aside from keywords, location, and platform-based targeting, Haku also lets you target specific audiences using key value-based attributes. These are called data keys. For example, you can use data keys to target a specific age, gender, or date. Like the other forms of targeting, you must create and define data keys before you can use them. Data keys simply hold the value of attributes. After creating and defining data keys, you must create [Data Key Targets](#tag/Data-Key-Targets) to set up the actual targeting filters. For more information, read How to create data keys and data key targets via API. x-group: Targeting - name: Data Key Targets description: >- Data Key targets are used hand-in-hand with [Data Keys](#tag/Data-Keys) to create custom targeting filters. For more information, read How to create data keys and data key targets via API. x-group: Targeting - name: Geo Targets description: >-

Geographic targets ("geo targets") enable you to deliver advertisements to users based on their geographic location. This is an effective way of reducing wasted impressions and increasing your return on investment.

Geographic targeting can be as generic as continents or as specific as cities. A geo target may contain as many areas as desired which can vary in specificity. (For example, an area of "South America" and an area of a specific city could exist in the same geo target.) Geo targets can either be inclusive or exclusive.

x-group: Targeting - name: Media Groups description: >- Media groups allow you to group creatives together for easier organization and management in your account. x-group: Campañas - name: Native Templates description: >- Native templates define the styles and formatting of native ads. Once a template is created it can then be applied, reused, and edited as needed to make native ad items.

Native ads are ads that look like editorial content. For example, a native ad on a blog looks like the other articles on the site, a native ad on Instagram looks like an Instagram post, and a native ad on a search engine looks like other search results. Native ads are also known as sponsored content or promoted posts. x-group: Inventario - name: Placements description: >- Assign an advertisement or campaign to a zone based on a set of scheduling criteria using the placements endpoint. Each placement represents a combination of criteria required to serve an advertisement. Prior to creating a placement, you will need to have created several other resources: * An [ad item](#tag/Ad-Items-(All)), * a [campaign](#tag/Campaigns-(All)), * a [zone](#tag/Zones-(All)), * and a [schedule](#tag/Schedules) You also have the option to create targeting filters, keywords, and activity limits to further control the deliverability of your placements. x-group: Campañas - name: Platform Targets description: >-

Target your advertisements to specific mobile/tablet/notebook/desktop devices, or to specific browsers and operating systems to help ensure users get the best ads for their platform. You can also target specific mobile phones or tablets, such as iPhones or Samsung devices using device targeting filters.

x-group: Targeting - name: Product DB / Catalog description:

Product catalogs that can be used for product-based advertising.

x-group: Retail media - name: Product DB / Catalog Items description: >-

Product catalog items that can be used for product-based advertising.

x-group: Retail media - name: Product DB / Catalog Items / Bulk Upload description: >-

Bulk upload a catalog CSV with column names that match the fields submitted to a catalog.

x-group: Retail media - name: Product DB / Publisher Sources description: >-

Publisher Sources that can be used for product-based advertising targeting.

x-group: Retail media - name: Product DB / Publisher Source Targets description: >-

Publisher Source Targets that can be used for product-based advertising targeting.

x-group: Retail media - name: Publishers description: >- A publisher is typically a person or a company who owns a website, app, newsletter, or even another ad server. Each publisher will have one or more zones, which represent the locations on their websites, apps or newsletters where advertisements can be displayed. x-group: Inventario - name: Reports description: >-

Reporting is the new interface to Statistics. It serves to quantify the serving of your advertisements across price and performance related metrics. They are updated in real time. We go to great lengths to give you detailed and accurate data about the performance of your advertisements to help you make informed decisions. The following endpoints enable you to build your own reporting dashboard.

x-group: Reportes - name: Schedules description: >- Schedules describe the conditions necessary for serving advertisements. Common conditions include start and end dates, and quotas. You can also use delivery methods to determine the expiration and pacing set up for advertisements. Default delivery delivers the impressions as quickly as possible, while smooth delivery will evenly serve impressions over the lifetime dates and quotas. For example, with smooth delivery, if your campaign has a quota of 30,000 impression set over a period of 60 days, the system would serve the assignment 500 times per day. Smooth delivery assignments have the highest potential priority for serving within Haku. If a quota has not been filled then that assignment will generally always serve as long as a targeting system does not interfere. __NOTE__: Schedules have no effect on their own and must be referenced through their ID. For campaigns with campaign-level scheduling, the schedule must be referenced in the [placement](#tag/Placements). For campaigns with ad item-level scheduling, the schedule must be referenced in the [campaign assignment](#tag/Campaign-Assignments) for each ad item in the campaign. Multiple placements and assignments can reference the same schedule, so they can share the same quota, start/end dates, and other common settings. x-group: Campañas - name: Zones (All) description: > Zones represent the space on a Publisher's website where ads are displayed ("served"). A zone's size can either be fixed or dynamic. The types of zones are: * __Standard__ - The most common, used to serve various ads including image, HTML5/Rich Media, Native Ads or third party scripts. * __VAST__ - Used to serve VAST video ads. * __Email__ - Used to serve image ads in emails and newsletters. x-group: Inventario - name: Zones / Standard description: >- The most common zone type. Used to serve image ads (JPG,PNG, or GIF), HTML5/Rich Media, or third party scripts. x-group: Inventario paths: /reports: get: tags: - Reports summary: Retrieve Reports description: >- Retrieve an overview of information collected from your ad serving, which can be filtered using the parameters below. parameters: - name: type in: query description: >- Specifies the focus of the statistics you are interested in viewing. The value must be one of __overview__, __publisher__, __advertiser__, __zone__, __campaign__, __ad-item__, __textad__, __popup__, __geo-target__, or __channel__. required: true schema: type: string example: '' - name: period in: query description: >- The range of time you are interested in viewing. The value must be one of __day__, __week__, __month__, or __year__. required: true schema: type: string example: '' - name: preset in: query description: >- Frequently used time frames for reporting statistics are bundled as "presets". You can pick a value from the presets instead of creating your own custom date range using the `from` and `to` fields. A preset range value must be one of the following: __today__, __last-24-hours__, __yesterday__, __this-week__, __last-week__, __this-month__, __last-month__, __year-to-date__, __last-year__, __last-7-days__, __last-14-days__, __last-30-days__, __last-3-months__, __last-6-months__, or __last-12-months__.

Either a `preset` or a valid `to` and `from` must be specified. schema: type: string example: '' - name: timezone in: query description: >- Timezone for the `preset` field (e.g. __America/Los_Angeles__). A complete list of acceptable timezones by country is given here.

If no timezone is given, the account's default timezone is used.

schema: type: string example: '' - $ref: '#/components/parameters/report_date_from' - $ref: '#/components/parameters/report_date_to' - name: summary in: query description: >- Whether to show a summary (__true__) or not (__false__). Defaults to __true__. schema: type: boolean example: false - name: details in: query description: >- Whether to show details (__true__) or not (__false__). Defaults to __false__. schema: type: boolean example: false - name: breakdown in: query description: >- Whether to show breakdown of placements in summary and details (__true__) or not (__false__). Defaults to __false__. schema: type: boolean example: false - name: advanced_conversion_data in: query description: >- Whether to show the advanced conversion columns `conversion_value` and `conversion_quantity`. These values will be 0 unless the Advanced Conversion Reporting feature is enabled. Defaults to __false__. schema: type: boolean example: false - name: financials in: query description: >- Whether to show financial data (__true__) or not (__false__). When true, the field `financials` will be included in the response. Defaults to __true__. schema: type: boolean example: false - name: publishers in: query description: >- Submit this parameter to filter your report by a list of publisher IDs. The IDs must be submitted as a comma-separated list. schema: type: string example: '' - name: zones in: query description: >- Submit this parameter to filter your report by a list of zone IDs. The IDs must be submitted as a comma-separated list. schema: type: string example: '' - name: advertisers in: query description: >- Submit this parameter to filter your report by a list of advertiser IDs. The IDs must be submitted as a comma-separated list. schema: type: string example: '' - name: campaigns in: query description: >- Submit this parameter to filter your report by a list of campaign IDs. The IDs must be submitted as a comma-separated list. schema: type: string example: '' - name: ad-items in: query description: >- Submit this parameter to filter your report by a list of ad item IDs. The IDs must be submitted as a comma-separated list. schema: type: string example: '' - name: textads in: query description: >- Submit this parameter to filter your report by a list of text ad IDs. The IDs must be submitted as a comma-separated list. deprecated: true schema: type: string example: '' - name: popups in: query description: >- Submit this parameter to filter your report by a list of popup IDs. The IDs must be submitted as a comma-separated list. deprecated: true schema: type: string example: '' - name: exclude_publisher_ad_items in: query description: >- When set to __true__, ad items that exist directly within zones are excluded from the report. Ad items connected to campaigns will still be included. Defaults to __false__. schema: type: boolean example: false - name: exclude_campaign_ad_items in: query description: >- When set to __true__, ad items that exist within campaigns are excluded from the report. Ad items connected to zones will still be included. Defaults to __false__. schema: type: boolean example: false - name: exclude_channel_stats in: query description: >- When set to __true__, any ads that were served using a channel will have their stats excluded. Defaults to __false__. schema: type: boolean example: false - name: require_channel_stats in: query description: >- When set to __true__, any ads that were served outside of a channel will have their stats excluded. Defaults to __false__. schema: type: boolean example: false responses: default: description: successful operation content: application/json: schema: $ref: '#/components/schemas/report_example_get' components: parameters: report_date_from: name: from in: query description: >- A valid ISO 8601 formatted date denoting the inclusive start of the period. For example: __2020-01-01T00:00:00+00:00__ (greater than or equal to). This field along with the `to` field lets you specify a custom date and time interval if no `preset` options suit your needs. The timezone offsets must match in the specified `from` and `to` fields.

You may not run a report for an interval larger than a year.

Either a `preset` or a valid `to` and `from` must be specified.

schema: type: string format: date-time report_date_to: name: to in: query description: >- A valid ISO 8601 formatted date denoting the exclusive end of the `period`. For example: __2020-02-01T00:00:00+00:00__. This field along with the `from` field lets you specify a custom date and time interval if no `preset` options suit your needs. The timezone offsets must match the specified `to` and `from` fields.

You cannot run a report for an interval larger than a year.

Either a `preset` or a valid `to` and `from` must be specified.

schema: type: string format: date-time schemas: report_example_get: properties: object: description: A string denoting the current resource being requested or affected. type: string example: report url: description: The URL of the current resource. type: string example: /v2/reports type: object allOf: - $ref: '#/components/schemas/report_example' report_example: properties: data: description: >- An array of objects broken down by report `type`. For example, if **zone** is the report type, each zone that contributed stats within the given timeframe will appear in the data array under its own object. type: array items: $ref: '#/components/schemas/report_data' meta: description: Some additional information about the report. type: object allOf: - $ref: '#/components/schemas/report_meta' type: object report_data: properties: type: description: >- Specifies the focus of the statistics you are interested in viewing. The value must be one of **overview**, **publisher**, **advertiser**, **zone**, **campaign**, **ad-item**, **geo-target**, or **channel**. type: string example: ad-item id: description: >- The ID of the resource you're viewing based on the chosen `type` . When `type` is set to **overview**, `id` will be set to the account ID. type: integer example: 5332157455 summary: description: >- The total stats for the resource within the given timeframe. `summary` ignores the period given and simply totals all stats based on the timeframe given (i.e. preset or from/to dates). type: object allOf: - $ref: '#/components/schemas/report_summary' details: description: >- The stats for the resource within the given timeframe, broken down by the specified `period`. type: array items: $ref: '#/components/schemas/report_details' type: object report_meta: properties: type: description: Type of report. type: string example: ad-item period: description: 'Period type. For example: ''day'', ''month'' etc.' type: string example: day from: description: Report from date. type: string format: date-time to: description: Report to date. type: string format: date-time timezone: description: Timezone being reported on. type: string example: America/Los_Angeles type: object report_summary: properties: responses: description: >- The total responses to the resource within the given timeframe. A response is recorded when the ad server receives an ad request and the server responds with an ad. Note that a response is not necessarily equivalent to an impression, which is when the served ad is actually shown on the page. For more information, read Requests vs. impressions. type: integer impressions: description: >- The total impressions for the resource within the given timeframe. An impression is usually recorded when the ad is displayed on the page. For more information, read Requests vs. impressions. type: integer clicks: description: Total clicks for the resource within the given timeframe. type: integer conversions: description: >- Total conversions for the resource within the given timeframe. A conversion is the action that you want the viewer to take after clicking on your ad, such as making a purchase from your store, signing up for your newsletter, or downloading your application on the page to which they were taken. Naturally, not all ads have an applicable conversion goal. For more information, read about the metrics and other information in a custom report. type: integer conversion_quantity: description: >- The quantity of conversions for the given time period and placements. This field is only included if the 'advanced_conversion_data' parameter is set to __true__ and the Advanced Conversion Reporting feature is enabled. type: integer cost: description: >- Total advertiser cost for the resource within the given timeframe. For more information, read about the metrics and other information in a custom report. **DEPRECATED:** This field has been moved to the `financials` array and will likely be removed in later versions of the API. type: number format: float deprecated: true payout: description: >- How much the publisher earned from the resource within the given timeframe. For more information, read Financial settings. **DEPRECATED:** This field has been moved to the `financials` array and will likely be removed in later versions of the API. type: number format: float deprecated: true revenue: description: >- How much the Administrator earned from the resource within the given timeframe. For more information, read about the metrics and other information in a custom report. **DEPRECATED:** This field has been moved to the `financials` array and will likely be removed in later versions of the API. type: number format: float deprecated: true e_cpm: description: >- The Effective Cost Per Mille (eCPM) is the ad revenue divided by the impressions obtained within the given timeframe, multiplied by 1000. This is based on the industry standard, where advertisers often bid on ad space by setting a price per 1,000 impressions. For more information, read about the metrics and other information in a custom report. **DEPRECATED** This field has been moved to the `financials` array and will likely be removed in later versions of the API. type: number format: float deprecated: true e_cpc: description: >- The Effective Cost Per Click (eCPC) is the ad revenue divided by the number of clicks obtained within the given timeframe. For more information, read about the metrics and other information in a custom report. **DEPRECATED:** This field has been moved to the `financials` array and will likely be removed in later versions of the API. type: number format: float deprecated: true e_cpa: description: >- The Effective cost-per-action (eCPA) is the ad revenue divided by the number of actions obtained within the given timeframe. An action is usually any user interaction that takes place after the viewer clicks on your ad other than the conversion. For example, an ad for a product may log a conversion when the viewer purchases the product after clicking on the ad. The action could be when the user clicks on other items in the store page after clicking on the ad. Similar to conversions, not all ads have an action goal. For more information, read about the metrics and other information in a custom report. **DEPRECATED:** This field has been moved to the `financials` array and will likely be removed in later versions of the API. type: number format: float deprecated: true financials: description: >- A breakdown of the financial stats for the resource within the given timeframe. type: object allOf: - $ref: '#/components/schemas/report_financials' breakdown: description: >- The `summary` statistics organized according to their ad item-placement pairing. Let's say you have Campaign C, which has Ad Item 1 and Ad Item 2. You then assigned Campaign C to Zone Z. When generating the report, you set a `period` within which both ad items in Campaign C contributed to the stats of Zone Z . You then set the report `type` to **zone**. In the `breakdown` section of the generated report, both ads will be shown as their own objects. type: array items: $ref: '#/components/schemas/report_breakdown' type: object report_details: properties: start_date: description: Start date of the report. type: string format: date-time type: object allOf: - $ref: '#/components/schemas/report_breakdown' report_financials: properties: cost: description: >- The total advertiser cost for this ad item-placement pair. For more information, read about the metrics and other information in a custom report. type: array items: $ref: '#/components/schemas/report_financials_currency' payout: description: >- How much the publisher has earned from this ad item-placement pair. For more information, read Financial settings. type: array items: $ref: '#/components/schemas/report_financials_currency' revenue: description: >- How much the Administrator has earned from this ad item-placement pair. For more information, read about the metrics and other information in a custom report. type: array items: $ref: '#/components/schemas/report_financials_currency' e_cpm: description: >- The Effective Cost Per Mille (eCPM) of this ad item-placement pair. Its formula is ad revenue divided by the impressions obtained within the chosen period, multiplied by 1000. This is based on the industry standard, where advertisers often bid on ad space by setting a price per 1,000 impressions. For more information, read about the metrics and other information in a custom report. type: array items: $ref: '#/components/schemas/report_financials_currency' e_cpc: description: >- The Effective Cost Per Click (eCPC) of this ad item-placement pair. Its formula is ad revenue divided by the number of clicks obtained within the chosen period. For more information, read about the metrics and other information in a custom report. type: array items: $ref: '#/components/schemas/report_financials_currency' e_cpa: description: >- The Effective Cost Per Action (eCPA) of this ad item-placement pair. Its formula is ad revenue divided by the number of actions obtained within the chosen period. An action is usually any user interaction that takes place after the viewer clicks on your ad other than the conversion. For example, an ad for a product may log a conversion when the viewer purchases the product after clicking on the ad. The action could be when the user clicks on other items in the store page after clicking on the ad. Similar to conversions, not all ads have an action goal. For more information, read about the metrics and other information in a custom report. type: array items: $ref: '#/components/schemas/report_financials_currency' conversion_value: description: >- The value of conversions for the given time period and placements. This field is only included if the 'advanced_conversion_data' parameter is set to __true__ and the Advanced Conversion Reporting feature is enabled. type: array items: $ref: '#/components/schemas/report_financials_currency' type: object report_breakdown: properties: placement: description: Identifier of the placement (ID). type: integer example: 77512 ad_item: description: The ad item for the related `breakdown`. type: object allOf: - properties: type: type: string example: ad_item id: type: integer example: 5523 type: object text_ad: description: '**DEPRECATED**' example: null nullable: true popup: description: '**DEPRECATED**' example: null nullable: true campaign: description: >- The campaign in which the ad item is assigned. This is optional, because ad items can also be assigned directly to a zone. type: object allOf: - properties: type: type: string example: campaign id: type: integer example: 772136 type: object zone: description: The zone connected to the `placement` of this `breakdown` object. type: object allOf: - properties: type: type: string example: standard_zone id: type: integer example: 2265166 type: object reponses: description: >- The number of responses to this ad item-placement pair. A response is recorded when the ad server receives an ad request and the server responds with an ad. Note that a response is not necessarily equivalent to an impression, which is when the served ad is actually shown on the page. For more information, read Requests vs. impressions. type: integer impressions: description: >- The number of impressions from this ad item-placement pair. An impression is usually recorded when the ad is displayed on the page. For more information, read Requests vs. impressions. type: integer clicks: description: The clicks for this ad item-placement pair. type: integer conversions: description: >- The conversions for this ad item-placement pair. A conversion is the action that you want the viewer to take after clicking on your ad, such as making a purchase from your store, signing up for your newsletter, or downloading your application on the page to which they were taken. Naturally, not all ads have an applicable conversion goal. For more information, read about the metrics and other information in a custom report. type: integer conversion_quantity: description: >- The quantity of conversions for the given time period and placements. This field is only included if the 'advanced_conversion_data' parameter is set to __true__ and the Advanced Conversion Reporting feature is enabled. type: integer cost: description: >- The advertiser cost for this ad item-placement pair. For more information, read about the metrics and other information in a custom report. **DEPRECATED:** This field has been moved to the `financials` array and will likely be removed in later versions of the API. type: number format: float deprecated: true payout: description: >- How much the publisher has earned from this ad item-placement pair. For more information, read Financial settings. **DEPRECATED:** This field has been moved to the `financials` array and will likely be removed in later versions of the API. type: number format: float deprecated: true revenue: description: >- How much the Administrator has earned from this ad item-placement pair. For more information, read about the metrics and other information in a custom report. **DEPRECATED:** This field has been moved to the `financials` array and will likely be removed in later versions of the API. type: number format: float deprecated: true e_cpm: description: >- The Effective Cost Per Mille (eCPM) of this ad item-placement pair. Its formula is ad revenue divided by the impressions obtained within the chosen period, multiplied by 1000. This is based on the industry standard, where advertisers often bid on ad space by setting a price per 1,000 impressions. For more information, read about the metrics and other information in a custom report. **DEPRECATED** This field has been moved to the `financials` array and will likely be removed in later versions of the API. type: number format: float deprecated: true e_cpc: description: >- The Effective Cost Per Click (eCPC) of this ad item-placement pair. Its formula is ad revenue divided by the number of clicks obtained within the chosen period. For more information, read about the metrics and other information in a custom report. **DEPRECATED:** This field has been moved to the `financials` array and will likely be removed in later versions of the API. type: number format: float deprecated: true e_cpa: description: >- The Effective Cost Per Action (eCPA) of this ad item-placement pair. Its formula is ad revenue divided by the number of actions obtained within the chosen period. An action is usually any user interaction that takes place after the viewer clicks on your ad other than the conversion. For example, an ad for a product may log a conversion when the viewer purchases the product after clicking on the ad. The action could be when the user clicks on other items in the store page after clicking on the ad. Similar to conversions, not all ads have an action goal. For more information, read about the metrics and other information in a custom report. **DEPRECATED:** This field has been moved to the `financials` array and will likely be removed in later versions of the API. type: number format: float deprecated: true financials: description: A breakdown of all the financial stats by currency. type: object allOf: - $ref: '#/components/schemas/report_financials' type: object report_financials_currency: properties: cur: description: The three digit currency code. type: string example: USD amount: description: The amount of the specified currency. type: number format: float example: 42.81 type: object securitySchemes: API Key: type: apiKey in: header name: Authorization description: >- API key en el header `Authorization: Basic TU_API_KEY`. La key va tal cual, sin codificar en base64. Las credenciales se entregan al comenzar la integración. ````