Get Time Series Data for Analytics

Returns data for a time series graph. At present the two statistics are
exceedance and total count. If there are
no results for the criteria for a given region it will not included in the results. The result will look like this:


  [
    {
      "count": 36,
      "region": "uk",
      "exceedance": 1.27,
      "date": "2022-01-15T00:00:00.000Z"
    },
    {
      "count": 38,
      "region": "uk",
      "exceedance": 1.3,
      "date": "2022-01-16T00:00:00.000Z"
    },
    {
      "count": 22,
      "region": "uk",
      "exceedance": 1.14,
      "date": "2022-01-17T00:00:00.000Z"
    },
    {
      "count": 36,
      "region": "uk",
      "exceedance": 1.27,
      "date": "2022-01-18T00:00:00.000Z"
    },

  ...

  }

To get a list of all maps and their ids use Get Metadata for All Maps. The list of available hazards can be obtained using Get Metadata for Map by Id. The list of available regions can be obtained using Get All Region and Region Type Combinations for a Map.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The map id to use for the request, the set of ids can be obtained using Get Metadata for All Maps

Body Params
hazards
array of strings
required

Hazards represent the weather condition that you are interested in. The list of supported hazards can be found using Get Metadata for Map by Id.

hazards*
sources
array of strings
required

The source is name of the service that the data was gathered from. At present only the 'twitter' source is supported.

sources*
string
required

The warnings option is used to decide whether to include warnings (automated Tweets publishing weather warnings) should be included in the results.

  • 'include' includes warnings.
  • 'exclude' does not include warnings.
  • 'only' only returns warnings.
integer
required

The minimum JavaScript time in milliseconds to return a result for.

integer

The maximum JavaScript time in milliseconds to return a result for.

string

Additional BOOLEAN (MySQL) query string matched against the text of each message.

string

Aggregate over either day or hour.

regions
array of strings
required

A set of region ids to retrieve texts for. These can be of any region type except numeric ones, such as 'coarse' and 'fine'.

regions*
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json