GET /designated_marketing_areas/:dma_id/history

DEPRECATED. This resource is deprecated. New use of this resource should be avoided. Existing use of this resource should be transitioned away from.

Description

Returns a collection of weather history data for a Nielsen Designated Marketing Area (“DMA”).

:dma_id is the DMA ID (i.e.: “500”).

Our patented OnPoint™ Weather data is not confined to weather station locations, but is computed by overlaying multiple past weather sources (including weather station, satellite, radar, and weather balloon data – among others). The resulting quality-checked, error-corrected, and gap-filled data is uniquely derived for every DMA in the U.S. and available from 2014 onward.

Requires a subscription plan with the “read_history” and “access_dmas” capabilities to access this resource. This resource also has geospatial capabilities (such as “geo_north_america”) that must be available to the subscription plan for corresponding queries.

Resource URL

https://api.weathersource.com/v1/:api_key/designated_marketing_areas/:dma_id/history.format

Resource URL Replacement Parts

{{api_key}}

Your API Key. If you do not have an API key, you may sign up for a free developer account 30-day trial.

:dma_id

A valid Designated Marketing Area ID.

{{format}}

The desired response format. Allowed formats are:

  • .json

Parameters

timestamp_eq optional

A response condition that returns a single element matching a timestamp. The returned timestamp may not equal the provided value, but will be representative of the value. For example, if the period parameter is set to hourly and the provided timestamp is for 8:15 a.m., the returned element will be for the 8 a.m. hour.

Either timestamp_eq or timestamp_between must be provided in ISO 8601 format.

TIP: Include the timezone offset portion of the timestamp for faster responses. (i.e. 2014-02-12T08:00+00:00 not 2014-02-12T08:00)

Allowed Values: ISO 8601 timestamp

Example Value: 2014-02-12T08:00+00:00 or 2014-02-12

timestamp_between optional

A response condition that returns the subset of elements with timestamps equal to or between those provided.

Either timestamp_eq or timestamp_between must be provided in ISO 8601 format.

TIP: Include the timezone offset portion of the timestamp for faster responses. (i.e. 2014-02-12T08:00+00:00 not 2014-02-12T08:00)

Allowed Values: Two comma separated ISO 8601 timestamps

Example Value: 2014-02-12T08:00,2014-02-12T23:00

period optional

Identifies the class of weather observations.

Allowed Values: hour, day

Default Value: day

limit optional

DEPRECIATED. Specifies the quantity of elements to retrieve.

Allowed Values: Integers between 1 and 25

Default Value: 5

offset optional

DEPRECIATED. Specifies the first element to retrieve (index starts at 0).

Allowed Values: Integers greater than or equal to 0

Default Value: 0

fields optional

Set response to a subset of fields within each element. Available field names:

The Hour class of weather data fields (period parameter is set to hour):

The Day class of weather data fields (period parameter is set to day):

Allowed Values: Comma separated list of field names

Default Value: latitude,longitude,timestamp

Example Request

GET https://api.weathersource.com/v1/{api_key}/designated_marketing_areas/500/history.json?period=hour&timestamp_eq=2014-02-12T08:00&fields=precip,temp

[{"precip":0,"temp":1.7}]