# Postal Code

Standard performance metrics broken out by postal code. Only includes data for strategies that targeted or anti-targeted postal codes. Available in custom date ranges or intervals with the option to aggregate by day, week, or month.

### Fields

| Field | Time Windows 	| Rollups 	|
|-------|---------------|-----------|
|Dimensions|
|agg_timestamp|current_day, yesterday, last_X_days, month_to_date|by_day, by_month, by_week|
|advertiser_id|Any|Any|
|advertiser_name|Any|Any|
|agency_id|Any|Any|
|agency_name|Any|Any|
|attribution_group|Any|Any|
|campaign_ads_txt_verified|Any|Any|
|campaign_agency_fee_pct|Any|Any|
|campaign_archived|Any|Any|
|campaign_bid_min_devices|Any|Any|
|campaign_brain_intraday_pacing|Any|Any|
|campaign_connected_id_type|Any|Any|
|campaign_conversion_type|Any|Any|
|campaign_conversion_variable_minutes|Any|Any|
|campaign_cost_passthrough_cpm_enabled|Any|Any|
|campaign_cost_passthrough_cpm_value|Any|Any|
|campaign_cost_passthrough_percent_enabled|Any|Any|
|campaign_cost_passthrough_percent_value|Any|Any|
|campaign_created_onCampaign Creation Time|Any|Any|
|campaign_currency_codeCampaign Currency Code|Any|Any|
|campaign_custom_attribution_source|Any|Any|
|campaign_dcs_data_is_campaign_level|Any|Any|
|campaign_device_graph_only|Any|Any|
|campaign_dynamic_budget_allocation_applied|Any|Any|
|campaign_dynamic_budget_allocation_available|Any|Any|
|campaign_dynamic_budget_allocation_type|Any|Any|
|campaign_end_date(GMT) Campaign End Date|Any|Any|
|campaign_end_date_tz(CTZ) Campaign End Date|Any|Any|
|campaign_frequency_amountCampaign Frequency Amount|Any|Any|
|campaign_frequency_intervalCampaign Frequency Interval|Any|Any|
|campaign_frequency_optimizationCampaign Frequency Optimization|Any|Any|
|campaign_frequency_typeCampaign Frequency Type|Any|Any|
|campaign_goal_alert|Any|Any|
|campaign_goal_category|Any|Any|
|campaign_goal_type|Any|Any|
|campaign_goal_value|Any|Any|
|campaign_has_custom_attribution|Any|Any|
|campaign_id|Any|Any|
|campaign_impression_cap_amount|Any|Any|
|campaign_impression_cap_automatic|Any|Any|
|campaign_impression_cap_type|Any|Any|
|campaign_in_flightIn Flight|Any|Any|
|campaign_initial_start_date(GMT) Campaign Initial Start Date|Any|Any|
|campaign_initial_start_date_tz(CTZ) Campaign Initial Start Date|Any|Any|
|campaign_io_name|Any|Any|
|campaign_io_reference_num|Any|Any|
|campaign_is_programmatic_guaranteedCampaign Is Programmatic Guaranteed|Any|Any|
|campaign_merit_pixel_id|Any|Any|
|campaign_minimize_multi_adsMinimize Multi Ads|Any|Any|
|campaign_name|Any|Any|
|campaign_override_suspicious_traffic_filter|Any|Any|
|campaign_pacing_alert|Any|Any|
|campaign_pc_window_minutes|Any|Any|
|campaign_political|Any|Any|
|campaign_pv_pct|Any|Any|
|campaign_pv_window_minutes|Any|Any|
|campaign_restrict_targeting_to_deterministic_id|Any|Any|
|campaign_restrict_targeting_to_same_device_id|Any|Any|
|campaign_service_typeCampaign Service Type, a.k.a. Managed Service Flag / managed_service_flag|Any|Any|
|campaign_source_campaign_id|Any|Any|
|campaign_spend_cap_amount|Any|Any|
|campaign_spend_cap_automatic|Any|Any|
|campaign_spend_cap_daily_cap|Any|Any|
|campaign_spend_cap_type|Any|Any|
|campaign_start_date(GMT) Campaign Start Date|Any|Any|
|campaign_start_date_tz(CTZ) Campaign Start Date|Any|Any|
|campaign_statusActive Status|Any|Any|
|campaign_suspicious_traffic_filter_level|Any|Any|
|campaign_total_budget|Any|Any|
|campaign_total_impression_budgetCampaign Impressions Budget|Any|Any|
|campaign_updated_onCampaign Update Time|Any|Any|
|campaign_version|Any|Any|
|campaign_zone_nameCampaign Time Zone, a.k.a time_zone|Any|Any|
|exchange_id|Any|Any|
|exchange_name|Any|Any|
|organization_id|Any|Any|
|organization_name|Any|Any|
|postal_code|Any|Any|
|strategy_ads_txt_verified|Any|Any|
|strategy_archived|Any|Any|
|strategy_audience_segment_exclude_op|Any|Any|
|strategy_audience_segment_include_op|Any|Any|
|strategy_bid_aggressiveness|Any|Any|
|strategy_bid_min_devices|Any|Any|
|strategy_bid_price_is_media_only|Any|Any|
|strategy_budget|Any|Any|
|strategy_cost_passthrough_cpm_enabled|Any|Any|
|strategy_cost_passthrough_cpm_value|Any|Any|
|strategy_cost_passthrough_percent_enabled|Any|Any|
|strategy_cost_passthrough_percent_value|Any|Any|
|strategy_created_on|Any|Any|
|strategy_currency_code|Any|Any|
|strategy_description|Any|Any|
|strategy_device_graph_only|Any|Any|
|strategy_end_date_raw|Any|Any|
|strategy_exchange_type_for_run_on_all|Any|Any|
|strategy_feature_compatibility|Any|Any|
|strategy_frequency_amount|Any|Any|
|strategy_frequency_intervalCampaign Frequency Interval|Any|Any|
|strategy_frequency_optimization|Any|Any|
|strategy_frequency_typeCampaign Frequency Type|Any|Any|
|strategy_goal_type|Any|Any|
|strategy_goal_value|Any|Any|
|strategy_groups|Any|Any|
|strategy_id|Any|Any|
|strategy_impression_pacing_amount|Any|Any|
|strategy_impression_pacing_interval|Any|Any|
|strategy_impression_pacing_type|Any|Any|
|strategy_max_bid|Any|Any|
|strategy_max_bid_wm|Any|Any|
|strategy_media_type|Any|Any|
|strategy_min_bid|Any|Any|
|strategy_name|Any|Any|
|strategy_pacing_amount|Any|Any|
|strategy_pacing_interval|Any|Any|
|strategy_pacing_optimization_amount|Any|Any|
|strategy_pacing_optimization_type|Any|Any|
|strategy_pacing_type|Any|Any|
|strategy_roi_target|Any|Any|
|strategy_run_on_all_exchanges|Any|Any|
|strategy_run_on_all_pmp|Any|Any|
|strategy_run_on_display|Any|Any|
|strategy_run_on_mobile|Any|Any|
|strategy_run_on_only_fraud_filtered_exchanges|Any|Any|
|strategy_run_on_streaming|Any|Any|
|strategy_site_restriction_transparent_urls|Any|Any|
|strategy_site_selectiveness|Any|Any|
|strategy_source_only|Any|Any|
|strategy_start_date_raw|Any|Any|
|strategy_statusActive Status|Any|Any|
|strategy_supply_type|Any|Any|
|strategy_targeting_segment_exclude_op|Any|Any|
|strategy_targeting_segment_include_op|Any|Any|
|strategy_type|Any|Any|
|strategy_updated_on|Any|Any|
|strategy_use_bid_shading|Any|Any|
|strategy_use_campaign_end|Any|Any|
|strategy_use_campaign_start|Any|Any|
|strategy_use_dba_strategy_pacing|Any|Any|
|strategy_use_dba_strategy_pacing_after_date|Any|Any|
|strategy_use_mm_freq|Any|Any|
|strategy_use_optimization|Any|Any|
|strategy_version|Any|Any|
|strategy_zone_name|Any|Any|
|Metrics|
|clicks|Any|Any|
|ctcCTC|Any|Any|
|ctrCTR|Any|Any|
|general_invalid_clicks|Any|Any|
|impressions|Any|Any|
|post_click_conversionsPost-Click Conversions|Any|Any|
|post_view_conversionsPost-View Conversions|Any|Any|
|rr_per_1k_impsResponse Rate/1K Imps|Any|Any|
|total_clicks|Any|Any|
|total_conversions|Any|Any|
|total_spend|Any|Any|
|total_spend_cpaTotal Spend eCPA|Any|Any|
|total_spend_cpcTotal Spend eCPC|Any|Any|
|total_spend_cpmTotal Spend eCPM|Any|Any|
|total_spend_pc_cpaTotal Spend PC CPA|Any|Any|
|total_spend_pv_cpaTotal Spend PV CPA|Any|Any|

### Pageable
No

### Time Windows
current_day, yesterday, last_X_days, month_to_date

### Rollups
all, by_day, by_month, by_week


### Data Retention / Lookback Window
30 days

Endpoint: POST /postal-code
Version: 1.0.0
Security: Auth0

## Request fields (application/json):

  - `end_time` (string,null)

  - `fields` (array, required)

  - `filters` (array, required)

  - `filters.field` (string)

  - `filters.op` (string)
    * =: Equals or contains if value is an array
* !=: Not equals
* >: Greater than
* >=: Greater than or equals
* <: Less than
* <=: Less than or equals
* =~: Text contains (case-insensitive)
* and: All filters must match
* or: At least one filter must match

  - `filters.value` (any)

  - `full_entities` (array,null)

  - `max_results` (integer,null)
    Maximum number of results to return. Only applicable for streaming responses. No limit if absent or null.

  - `order` (array)

  - `order.desc` (boolean)

  - `order.nulls_last` (boolean)

  - `rollup` (string, required)

  - `start_time` (string)

  - `time_window` (string)

  - `time_zone` (string)
    Only in supported datasets: campaign, UTC or a time zone name defined in https://www.iana.org/time-zones

## Response 400 fields (application/json):

  - `error_code` (string)

  - `message` (string)

  - `request_id` (string)

## Response 401 fields (application/json):

  - `error_code` (string)

  - `message` (string)

  - `request_id` (string)

## Response 5XX fields (application/json):

  - `error_code` (string)

  - `message` (string)

  - `request_id` (string)