Available Products & Environments

Geopath offers multiple API products and versions across a production and a staging environment. Each product contains multiple endpoints that can be used based on application needs.

 Production Environment

This environment is the live Geopath API environment that holds the most up to date API features and current audited Geopath audience measurements.

Here are API Specifications that detail the specific API endpoints

API Versions

Geopath currently offers 2 API versions. These are version 2.1 and version 2.2

• Version 2.1 is a prior API version that remains the production environment. It will be supported through EOY 2023 and offers data for the following Geopath Forecasts (it will not support future forecasts):

  • 2021 Mid Year (Please note that 2021 and 2020 data sets were deprecated as of 2/27/23)

• Version 2.2 is currently in production (deployed 2/27/23) that offers data from the following Geopath Forecasts (and will also support future forecasts):

  • 2023

• Each API product below is available for both versions unless, however Version 2.1 is being depreciated end of year 2022.

• There are breaking changes between these two versions. Please review the full release notes to understand the differences fully.

Breakdown of API Products

• Audience Measurement – Inventory API

  • This product provides audience measures for Geopath audited Inventory. It allows for:

    • Searching for inventory based on a set of criteria

    • Creation of OOH campaign plans

    • Getting detailed records based on an ID

    • Getting market and audience opportunities for inventory

    • Getting summary statistics for inventory based on a set of criteria 

• Reference – Inventory API

  • This product provides reference data to better understand the attributes required for the Audience Measurement – Inventory API requests and the attributes returned by those requests

• Reference – Market API

  • This product provides reference data to better understand the market geography attributes required for the Audience Measurement – Inventory API requests and the market geography attributes returned by those requests.

  • More information about the market API endpoints can be found with this use case.

• Reference – Segment API

  • This product provides reference data to better understand the audience segment (such as age / race / income / consumer behavior demographics) attributes and values required for the Audience Measurement – Inventory API requests and the audience segment attributes returned by those requests

Caching

The Geopath API uses caching to help improve performance.

• With caching, the response of a new request will be saved so that if the same request is made, the response will be returned from the cache rather than making a new request to the backend server. A hash of the endpoint URL and request payload is used to identify identical requests to a specific endpoint. 

• Currently, only responses 512kb and smaller are saved. If the response is larger than 512kb, it will not be cached. 

• Caches are currently maintained for 14 days. During the bi-weekly data release cycle the cache is reset to prevent older cached data from conflicting with newly released data. 

• If bypassing the cache is needed, the header of the request can be modified to include a key of "Cache-Control" and value of "no-cache" to skip any existing caches. 

Caching is currently enabled on the following endpoints:

/inventory/measures/summary

/inventory/measures/summary/segments

/inventory/search

/inventory/search/batch

/inventory/search/summary

/inventory/search/summary/batch

inventory/spot/{spot_id}

/inventory/{frame_id}