# Hyperlocal


Standard performance metrics broken out by Hyperlocal Targeting objects created via third party.


### Fields

| Field | Time Windows 	| Rollups 	|
|-------|---------------|-----------|
||
||, , , |, , |
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
|Campaign Creation Time|Any|Any|
|Campaign Currency Code|Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
|(GMT) Campaign End Date|Any|Any|
|(CTZ) Campaign End Date|Any|Any|
|Campaign Frequency Amount|Any|Any|
|Campaign Frequency Interval|Any|Any|
|Campaign Frequency Optimization|Any|Any|
|Campaign Frequency Type|Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
|In Flight|Any|Any|
|(GMT) Campaign Initial Start Date|Any|Any|
|(CTZ) Campaign Initial Start Date|Any|Any|
||Any|Any|
||Any|Any|
|Campaign Is Programmatic Guaranteed|Any|Any|
||Any|Any|
|Minimize Multi Ads|Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
|Campaign Service Type, a.k.a. Managed Service Flag / managed_service_flag|Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
|(GMT) Campaign Start Date|Any|Any|
|(CTZ) Campaign Start Date|Any|Any|
|Active Status|Any|Any|
||Any|Any|
||Any|Any|
|Campaign Impressions Budget|Any|Any|
|Campaign Update Time|Any|Any|
||Any|Any|
|Campaign Time Zone, a.k.a time_zone|Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
|Campaign Frequency Interval|Any|Any|
||Any|Any|
|Campaign Frequency Type|Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
|Active Status|Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||
||Any|Any|
|CTC|Any|Any|
|CTR|Any|Any|
||Any|Any|
||Any|Any|
|Media Cost ROI|Any|Any|
|Post-Click AOV|Any|Any|
|Post-Click Conversions|Any|Any|
|Post-Click Revenue|Any|Any|
|Post-Click Total Spend ROI|Any|Any|
|Post-View AOV|Any|Any|
|Post-View Conversions|Any|Any|
|Post-View Conversions (Raw)|Any|Any|
|Post-View Revenue|Any|Any|
|Post-View Revenue (Raw)|Any|Any|
|Post-View Total Spend ROI|Any|Any|
|Revenue (Raw)|Any|Any|
|Response Rate/1K Imps|Any|Any|
|Total AOV|Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
||Any|Any|
|Total Spend eCPA|Any|Any|
|Total Spend eCPC|Any|Any|
|Total Spend eCPM|Any|Any|
|Total Spend PC CPA|Any|Any|
|Total Spend PV CPA|Any|Any|
|Total Spend ROI|Any|Any|

### Pageable
No

### Time Windows
, , , 

### Rollups
, , , 


### Data Retention / Lookback Window
90 days


Endpoint: POST /hyperlocal
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  is an array
* : Not equals
* : Greater than
* : Greater than or equals
* : Less than
* : Less than or equals
* : Text contains (case-insensitive)
* : All filters must match
* : At least one filter must match

  - `filters.value` (any)

  - `full_entities` (array,null)

  - `order` (array, required)

  - `order.desc` (boolean)

  - `order.nulls_last` (boolean)

  - `rollup` (string, required)

  - `start_time` (string)

  - `time_window` (string)

  - `time_zone` (string)
    ,  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)