Skip to content
Book a demo

Connect documentation

All documentation
Documentation

ChatGPT Ads: Most-used fields

The table below gives information about most-used fields that you can import from ChatGPT Ads. Other fields might also be available in Adverity.

The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.

FieldAdverity UI nameType
DateDimension

The date when the ad performance data was recorded, based on the selected time granularity for reporting. This field represents a specific day in the reporting period.

ad.created_atDimension

The Unix timestamp indicating when the ad was created in the system.

ad.creative.bodyDimension

The main text content or body of the ad creative.

ad.creative.file_idDimension

The unique identifier for the creative asset file associated with the ad, such as an image or video.

ad.creative.image_crop.heightMetric

Height of the image crop for the ad creative.

ad.creative.image_crop.widthMetric

Width of the image crop for the ad creative.

ad.creative.image_crop.xMetric

X-coordinate of the top-left corner of the image crop for the ad creative.

ad.creative.image_crop.yMetric

Y-coordinate of the top-left corner of the image crop for the ad creative.

ad.creative.priceDimension

The price associated with the ad's creative asset.

ad.creative.target_urlDimension

The URL where users are directed when they click on the ad creative.

ad.creative.titleDimension

The title displayed as part of the ad creative.

ad.creative.typeDimension

The type of ad creative, such as image, video, or text.

ad.idDimension

The unique identifier for the ad within the ad account.

ad.landing_page_configurationDimension

Configuration details for the ad's landing page.

ad.landing_page_configuration.query_string_templateDimension

The template used to generate the query string for the ad's landing page URL.

ad.nameDimension

The user-defined name of the ad.

ad.review.reasonDimension

The reason for the ad's review status.

ad.review.statusDimension

The current review status of the ad, indicating whether it has been approved, rejected, or is pending review.

ad.review_statusDimension

The current review status of the ad, indicating whether it has been approved, rejected, or is pending review.

ad.statusDimension

The current operational status of the ad, such as enabled, paused, or archived.

ad.updated_atDimension

The Unix timestamp indicating when the ad was last updated.

ad_account.account_integrity_review.details.decisionDimension

The decision made during the ad account's integrity review.

ad_account.account_integrity_review.details.reasonDimension

The reason provided for the decision made during the ad account's integrity review.

ad_account.account_integrity_review.details.status_updated_atDimension

The timestamp when the status of the ad account's integrity review was last updated.

ad_account.account_integrity_review.review.statusDimension

The overall status of the ad account's integrity review.

ad_account.account_nameDimension

The name of the ad account.

ad_account.currency_codeDimension

The currency code used for the ad account (e.g., USD).

ad_account.idDimension

Unique identifier for the ad account.

ad_account.nameDimension

Name of the ad account.

ad_account.origin_country_codeDimension

This field indicates the country where the advertising account is registered, determining the local regulations, currency, and time zone settings applicable to the account.

ad_account.preview_urlDimension

A URL for previewing the ad account's settings or content.

ad_account.review.reasonDimension

The reason for the ad account's review status.

ad_account.review.statusDimension

The current review status of the ad account.

ad_account.statusDimension

The current operational status of the ad account.

ad_account.timezoneDimension

The timezone configured for the ad account.

ad_account.urlDimension

The main URL associated with the ad account.

ad_account_idDimension

A unique identifier for the ad account.

ad_account_nameDimension

The user-defined name of the ad account.

ad_group.bidding_config.billing_event_typeDimension

The type of event that triggers billing for the ad group.

ad_group.bidding_config.max_bidMetric

The maximum bid amount set for the ad group.

ad_group.bidding_config.strategyDimension

The bidding strategy employed for the ad group (e.g., highest value, lowest cost).

ad_group.bidding_config.targetMetric

The specific goal or objective that the bidding strategy for the ad group aims to achieve.

ad_group.bidding_config.target_strategyDimension

The specific method or strategy used for bidding within the ad group to reach its target.

ad_group.context_hintsDimension

Hints or additional context associated with the ad group.

ad_group.created_atDimension

Timestamp when the ad group was created.

ad_group.descriptionDimension

A descriptive text for the ad group.

ad_group.idDimension

The unique identifier for the ad group.

ad_group.landing_page_configurationDimension

Configuration details for the ad group's landing page.

ad_group.landing_page_configuration.query_string_templateDimension

The template used to generate the query string for the ad group's landing page URL.

ad_group.nameDimension

Name of the ad group.

ad_group.product_setDimension

The product set associated with the ad group, defining which products are eligible for ads within this group.

ad_group.product_set.filtersDimension

Filters applied to the product set to narrow down the selection of products for the ad group.

ad_group.product_set.product_feed_idDimension

The identifier of the product feed from which the product set draws its products.

ad_group.statusDimension

The current operational status of the ad group.

ad_group.updated_atDimension

Timestamp when the ad group was last updated.

ad_group_idDimension

A unique identifier for the ad group.

ad_group_nameDimension

The user-defined name of the ad group.

ad_idDimension

A unique identifier for the ad.

ad_nameDimension

The user-defined name of the ad.

campaign.bidding_typeDimension

The bidding type for the campaign (e.g., CPC, CPM).

campaign.billing_event_typeDimension

The billing event type defines the action for which an advertiser is charged within a campaign, such as a click or an impression.

campaign.budget.daily_spend_limitMetric

The daily spending limit set for the campaign budget.

campaign.budget.lifetime_spend_limitMetric

The maximum total amount of money, in micro-units, that can be spent on the campaign over its entire lifetime.

campaign.conversion_event_setting_idsDimension

Identifiers for conversion event settings applied to the campaign.

campaign.created_atDimension

Timestamp when the campaign was created.

campaign.descriptionDimension

A descriptive text for the campaign.

campaign.end_timeDimension

The scheduled end time for the campaign.

campaign.idDimension

The unique identifier for the campaign.

campaign.landing_page_configurationDimension

Configuration details for the campaign's landing page.

campaign.landing_page_configuration.query_string_templateDimension

The template used to generate the query string for the campaign's landing page URL.

campaign.modeDimension

The operational mode of the campaign, indicating its objective or strategy.

campaign.nameDimension

Name of the campaign.

campaign.objectiveDimension

Specifies the primary goal of the campaign, such as driving impressions or conversions.

campaign.product_feed_idDimension

Identifier for the product feed linked to the campaign for dynamic product ads.

campaign.start_timeDimension

The scheduled start time for the campaign.

campaign.statusDimension

The current operational status of the campaign.

campaign.targeting.excluded_locations.countriesDimension

A list of two-letter country codes (e.g., 'US', 'CA') where ads for the campaign will not be delivered. Exclusion targeting takes precedence over any included locations.

campaign.targeting.locations.countriesDimension

The list of countries where the campaign's ads will be shown, based on the campaign's targeting settings.

campaign.targeting.locations.includeDimension

Indicates whether the specified locations are included or excluded in targeting.

campaign.targeting.platforms.includedDimension

The list of advertising platforms where the campaign's ads are intended to be displayed.

campaign.updated_atDimension

Timestamp when the campaign was last updated.

campaign_idDimension

A unique identifier for the campaign.

campaign_nameDimension

The user-defined name of the campaign.

click_through_conversionsMetric

The number of conversions attributed to a user clicking on an ad.

clicksMetric

The total number of clicks on the ad during the reporting period.

conversionsMetric

The total number of desired actions taken by users, such as purchases or sign-ups, attributed to advertising efforts.

countryDimension

The geographical country associated with the performance or conversion data, used for breaking down reports.

country_nameDimension

The name of the country.

cpcMetric

Cost-per-click, representing the average cost for each click.

cpmMetric

Cost-per-mille (or cost-per-thousand impressions), representing the average cost for every thousand impressions.

ctrMetric

Click-through rate, the ratio of clicks to impressions.

device_typeDimension

The type of device (e.g., mobile, desktop) where the ad was shown.

end_timeDimension

The end date and time for which insights data is retrieved.

idDimension

A unique identifier for the specific record being processed (e.g., ad account, campaign, ad group, or ad ID depending on the context).

impressionsMetric

The total number of times the ad was displayed during the reporting period.

item_idDimension

A unique identifier for an individual product item, particularly when reporting with product breakdown.

product_availabilityDimension

The current availability status of a product (e.g., in stock, out of stock).

product_bodyDimension

The main textual content or description of a product.

product_brandDimension

The brand associated with the product.

product_descriptionDimension

A detailed description of the product.

product_feed_idDimension

The identifier of the product feed where the product data originates.

product_image_urlDimension

The URL of the main image for the product.

product_priceDimension

The current selling price of the product.

product_seller_nameDimension

The name of the seller or merchant offering the product.

product_target_urlDimension

The URL that users are directed to when clicking on an ad for this product.

product_titleDimension

The title or name of the product.

readable_timeDimension

A human-readable representation of the time or date for reporting purposes.

spendMetric

The total amount of money spent.

start_timeDimension

The start date and time for which insights data is retrieved.

view_through_conversionsMetric

The number of conversions attributed to a user viewing an ad, without clicking on it.