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.
API name |
Adverity UI name |
Description |
Use in Adverity |
|---|---|---|---|
Date |
Date |
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. |
dimension |
ad.created_at |
ad.created_at |
The Unix timestamp indicating when the ad was created in the system. |
dimension |
ad.creative.body |
ad.creative.body |
The main text content or body of the ad creative. |
dimension |
ad.creative.file_id |
ad.creative.file_id |
The unique identifier for the creative asset file associated with the ad, such as an image or video. |
dimension |
ad.creative.image_crop.height |
ad.creative.image_crop.height |
Height of the image crop for the ad creative. |
metric |
ad.creative.image_crop.width |
ad.creative.image_crop.width |
Width of the image crop for the ad creative. |
metric |
ad.creative.image_crop.x |
ad.creative.image_crop.x |
X-coordinate of the top-left corner of the image crop for the ad creative. |
metric |
ad.creative.image_crop.y |
ad.creative.image_crop.y |
Y-coordinate of the top-left corner of the image crop for the ad creative. |
metric |
ad.creative.price |
ad.creative.price |
The price associated with the ad’s creative asset. |
dimension |
ad.creative.target_url |
ad.creative.target_url |
The URL where users are directed when they click on the ad creative. |
dimension |
ad.creative.title |
ad.creative.title |
The title displayed as part of the ad creative. |
dimension |
ad.creative.type |
ad.creative.type |
The type of ad creative, such as image, video, or text. |
dimension |
ad.id |
ad.id |
The unique identifier for the ad within the ad account. |
dimension |
ad.landing_page_configuration |
ad.landing_page_configuration |
Configuration details for the ad’s landing page. |
dimension |
ad.landing_page_configuration.query_string_template |
ad.landing_page_configuration.query_string_template |
The template used to generate the query string for the ad’s landing page URL. |
dimension |
ad.name |
ad.name |
The user-defined name of the ad. |
dimension |
ad.review.reason |
ad.review.reason |
The reason for the ad’s review status. |
dimension |
ad.review.status |
ad.review.status |
The current review status of the ad, indicating whether it has been approved, rejected, or is pending review. |
dimension |
ad.review_status |
ad.review_status |
The current review status of the ad, indicating whether it has been approved, rejected, or is pending review. |
dimension |
ad.status |
ad.status |
The current operational status of the ad, such as enabled, paused, or archived. |
dimension |
ad.updated_at |
ad.updated_at |
The Unix timestamp indicating when the ad was last updated. |
dimension |
ad_account.account_integrity_review.details.decision |
ad_account.account_integrity_review.details.decision |
The decision made during the ad account’s integrity review. |
dimension |
ad_account.account_integrity_review.details.reason |
ad_account.account_integrity_review.details.reason |
The reason provided for the decision made during the ad account’s integrity review. |
dimension |
ad_account.account_integrity_review.details.status_updated_at |
ad_account.account_integrity_review.details.status_updated_at |
The timestamp when the status of the ad account’s integrity review was last updated. |
dimension |
ad_account.account_integrity_review.review.status |
ad_account.account_integrity_review.review.status |
The overall status of the ad account’s integrity review. |
dimension |
ad_account.currency_code |
ad_account.currency_code |
The currency code used for the ad account (e.g., USD). |
dimension |
ad_account.id |
ad_account.id |
Unique identifier for the ad account. |
dimension |
ad_account.name |
ad_account.name |
Name of the ad account. |
dimension |
ad_account.preview_url |
ad_account.preview_url |
A URL for previewing the ad account’s settings or content. |
dimension |
ad_account.review.reason |
ad_account.review.reason |
The reason for the ad account’s review status. |
dimension |
ad_account.review.status |
ad_account.review.status |
The current review status of the ad account. |
dimension |
ad_account.status |
ad_account.status |
The current operational status of the ad account. |
dimension |
ad_account.timezone |
ad_account.timezone |
The timezone configured for the ad account. |
dimension |
ad_account.url |
ad_account.url |
The main URL associated with the ad account. |
dimension |
ad_account_id |
ad_account_id |
A unique identifier for the ad account. |
dimension |
ad_account_name |
ad_account_name |
The user-defined name of the ad account. |
dimension |
ad_group.bidding_config.billing_event_type |
ad_group.bidding_config.billing_event_type |
The type of event that triggers billing for the ad group. |
dimension |
ad_group.bidding_config.max_bid |
ad_group.bidding_config.max_bid |
The maximum bid amount set for the ad group. |
metric |
ad_group.bidding_config.strategy |
ad_group.bidding_config.strategy |
The bidding strategy employed for the ad group (e.g., highest value, lowest cost). |
dimension |
ad_group.context_hints |
ad_group.context_hints |
Hints or additional context associated with the ad group. |
dimension |
ad_group.created_at |
ad_group.created_at |
Timestamp when the ad group was created. |
dimension |
ad_group.description |
ad_group.description |
A descriptive text for the ad group. |
dimension |
ad_group.id |
ad_group.id |
The unique identifier for the ad group. |
dimension |
ad_group.landing_page_configuration |
ad_group.landing_page_configuration |
Configuration details for the ad group’s landing page. |
dimension |
ad_group.landing_page_configuration.query_string_template |
ad_group.landing_page_configuration.query_string_template |
The template used to generate the query string for the ad group’s landing page URL. |
dimension |
ad_group.name |
ad_group.name |
Name of the ad group. |
dimension |
ad_group.product_set |
ad_group.product_set |
The product set associated with the ad group, defining which products are eligible for ads within this group. |
dimension |
ad_group.product_set.filters |
ad_group.product_set.filters |
Filters applied to the product set to narrow down the selection of products for the ad group. |
dimension |
ad_group.product_set.product_feed_id |
ad_group.product_set.product_feed_id |
The identifier of the product feed from which the product set draws its products. |
dimension |
ad_group.status |
ad_group.status |
The current operational status of the ad group. |
dimension |
ad_group.updated_at |
ad_group.updated_at |
Timestamp when the ad group was last updated. |
dimension |
ad_group_id |
ad_group_id |
A unique identifier for the ad group. |
dimension |
ad_group_name |
ad_group_name |
The user-defined name of the ad group. |
dimension |
ad_id |
ad_id |
A unique identifier for the ad. |
dimension |
ad_name |
ad_name |
The user-defined name of the ad. |
dimension |
campaign.bidding_type |
campaign.bidding_type |
The bidding type for the campaign (e.g., CPC, CPM). |
dimension |
campaign.budget.daily_spend_limit |
campaign.budget.daily_spend_limit |
The daily spending limit set for the campaign budget. |
metric |
campaign.conversion_event_setting_ids |
campaign.conversion_event_setting_ids |
Identifiers for conversion event settings applied to the campaign. |
dimension |
campaign.created_at |
campaign.created_at |
Timestamp when the campaign was created. |
dimension |
campaign.description |
campaign.description |
A descriptive text for the campaign. |
dimension |
campaign.end_time |
campaign.end_time |
The scheduled end time for the campaign. |
dimension |
campaign.id |
campaign.id |
The unique identifier for the campaign. |
dimension |
campaign.landing_page_configuration |
campaign.landing_page_configuration |
Configuration details for the campaign’s landing page. |
dimension |
campaign.landing_page_configuration.query_string_template |
campaign.landing_page_configuration.query_string_template |
The template used to generate the query string for the campaign’s landing page URL. |
dimension |
campaign.mode |
campaign.mode |
The operational mode of the campaign, indicating its objective or strategy. |
dimension |
campaign.name |
campaign.name |
Name of the campaign. |
dimension |
campaign.product_feed_id |
campaign.product_feed_id |
Identifier for the product feed linked to the campaign for dynamic product ads. |
dimension |
campaign.start_time |
campaign.start_time |
The scheduled start time for the campaign. |
dimension |
campaign.status |
campaign.status |
The current operational status of the campaign. |
dimension |
campaign.targeting.locations.include |
campaign.targeting.locations.include |
Indicates whether the specified locations are included or excluded in targeting. |
dimension |
campaign.updated_at |
campaign.updated_at |
Timestamp when the campaign was last updated. |
dimension |
campaign_id |
campaign_id |
A unique identifier for the campaign. |
dimension |
campaign_name |
campaign_name |
The user-defined name of the campaign. |
dimension |
clicks |
clicks |
The total number of clicks on the ad during the reporting period. |
metric |
country_name |
country_name |
The name of the country. |
dimension |
cpc |
cpc |
Cost-per-click, representing the average cost for each click. |
metric |
cpm |
cpm |
Cost-per-mille (or cost-per-thousand impressions), representing the average cost for every thousand impressions. |
metric |
ctr |
ctr |
Click-through rate, the ratio of clicks to impressions. |
metric |
device_type |
device_type |
The type of device (e.g., mobile, desktop) where the ad was shown. |
dimension |
end_time |
end_time |
The end date and time for which insights data is retrieved. |
dimension |
id |
id |
A unique identifier for the specific record being processed (e.g., ad account, campaign, ad group, or ad ID depending on the context). |
metric |
impressions |
impressions |
The total number of times the ad was displayed during the reporting period. |
metric |
item_id |
item_id |
A unique identifier for an individual product item, particularly when reporting with product breakdown. |
dimension |
product_availability |
product_availability |
The current availability status of a product (e.g., in stock, out of stock). |
dimension |
product_body |
product_body |
The main textual content or description of a product. |
dimension |
product_brand |
product_brand |
The brand associated with the product. |
dimension |
product_description |
product_description |
A detailed description of the product. |
dimension |
product_feed_id |
product_feed_id |
The identifier of the product feed where the product data originates. |
dimension |
product_image_url |
product_image_url |
The URL of the main image for the product. |
dimension |
product_price |
product_price |
The current selling price of the product. |
dimension |
product_seller_name |
product_seller_name |
The name of the seller or merchant offering the product. |
dimension |
product_target_url |
product_target_url |
The URL that users are directed to when clicking on an ad for this product. |
dimension |
product_title |
product_title |
The title or name of the product. |
dimension |
readable_time |
readable_time |
A human-readable representation of the time or date for reporting purposes. |
dimension |
spend |
spend |
The total amount of money spent. |
metric |
start_time |
start_time |
The start date and time for which insights data is retrieved. |
dimension |