New features & breaking changes in Geopath API version 2.2
- Sathishkumar SB (Unlicensed)
- Brian Schopper
- Chris Luken
Please note that the Geopath 2.2 API has been released to production on 2/27/2023 and will be the only source of 2023 and 2024 data. API version 2.1 is scheduled to be sunset on 12/31/23. All Geopath members must migrate any automations currently using Geopath API version 2.1 to version 2.2 as soon as possible.
New features & breaking changes in Geopath API version 2.2 | |||||
Service | # | Feature | New or Breaking | API Endpoint(s) Impacted | Comments |
Inventory Service | 1 | Reach goals support (reach_pct, reach_net) | New | inventory/plans |
|
| 2 | Added support for frame measures | New | inventory/<frame_id> |
|
| 3 | Added max_frames support | New | inventory/<frame_id> |
|
| 4 | Added 'frame_measures', 'frame_measures_filtered', 'reach_freq' attributes | New | inventory/search |
|
| 5 | Added 'frame_measures_filtered' attribute | New | inventory/measures/summary |
|
| 6 | Added 'frame_measures', 'reach_freq' parameters | New | inventory/<frame_id> |
|
| 7 | Added 'reach_freq' parameter | New | inventory/<frame_id> | Can be set for True or False, allowing a user to limit measures to non Reach / Frequency related measures (which should return results faster) |
| 8 | Added the ability to run an inventory search 'offline' as a background process (returning a download URL) | New | inventory/search/{search_id} |
|
| 9 | Removed support for 2020 and 2021 measures | Breaking | inventory/<frame_id> |
|
| 10 | Removed measures_release parameter/attribute | Breaking | inventory/measures/homes/spots | Use product_name parameter/attribute instead |
| 11 | Removed support for global market in plans | Breaking | inventory/plans |
|
| 12 | Removed inventory/homes/search | Breaking | inventory/homes/search | This capability has been deprecated |
| 13 | Removed inventory/summary/search API | Breaking | inventory/summary/search | Use inventory/search/summary instead |
| 14 | measures parameter is renamed to spot_measures | Breaking | inventory/<frame_id> |
|
| 15 | measures_required attribute is renamed to spot_measures | Breaking | inventory/search |
|
| 16 | inventory/search response is aligned with inventory/<frame_id> response | Breaking | inventory/search |
|
| 17 | full_motion, partial_motion, rotating, interactive and audio attributes in the response are renamed as frame_full_motion, frame_partial_motion, frame_rotating, frame_interactive and frame_audio | Breaking | inventory/<frame_id> |
|
| 18 | Under layouts.faces.spots object, the attributes full_motion, partial_motion, rotating, interactive, audio and share_of_voice are renamed to spot_full_motion, spot_partial_motion, spot_rotating, spot_interactive, spot_audio and spot_share_of_voice | Breaking | inventory/<frame_id> |
|
| 19 | location.place_type object is updated to be array and the name is updated as location.place_types in the response | Breaking | inventory/<frame_id> |
|
| 20 | measures and total_msg_impressions objects in the response are changed into measures_list and total_msg_impressions_list arrays | Breaking | inventory/<frame_id> inventory/search
|
|
| 21 | media_status attribute name is changed as status_type | Breaking | inventory/search |
|
| 22 | id attributes (of inventory and spot) are changed as frame_id and spot_id | Breaking | inventory/<frame_id> |
|
| 23 | operator_name_list and plant_name_list attributes name have been removed and superseded by parent_account_name_list and account_name list | Breaking | inventory/search | The two new alternative attributes represent two separate levels of inventory ownership: parent_account_name_list represents the owner of the inventory, account_name_list represents the manager of the inventory |
| 24 | “plant_frame_id”,”publisher_unique_face_id”,”plant_spot_id” and “publisher_unique_id” fields are deprecated in API responses, in favor of new fields on the representation object of each inventory level | Breaking | inventory/search inventory/search/summary inventory/search/summary/batch inventory/spot/{spot id} inventory/spot/id/search inventory/{frame id} inventory/frame/id/search inventory/measures/summary/segments /inventory/measures/search |
|
| 25 | The "eff_freq_min", "eff_freq_avg", "eff_reach_net", and "eff_reach_pct" fields representing ‘effective frequency and effective reach’ have been set to return ‘null’ values by design for this initial v2.2 release. | Breaking | inventory/search inventory/search/summary inventory/search/summary/batch inventory/spot/{spot id} inventory/spot/id/search inventory/{frame id} inventory/frame/id/search inventory/measures/summary/segments /inventory/measures/search |
|
Segment Service | 1 | Added pagination support and the response is a json object rather than an array | Breaking | segments/search | Default page_size is 5000, no upper limit |
| 2 | Removed segments/segment_search API | Breaking |
| Use segments/search instead |
User Service | 1 | Added user registration API | New | user/register |
|
| 2 | Added usage API | New | user/usage |
|
Reference Service | 1 | /inventory/operators endpoint has been deprecated and is superseded by the inventory/accounts endpoint | Breaking | inventory/operators | Use inventory/accounts endpoint instead of inventory/operators endpoint Use account_name instead of operator_name as a parameter/attribute |
Market Service |
| No Changes |
|
|
|